一、注解处理器 AbstractProcessor

上一篇博客【Android APT】编译时技术 ( 开发编译时注解 ) 中开发了 annotation 编译时注解依赖库 , 很简单 , 只有一个 BindView 注解 ;

本博客开始进行开发注解处理器依赖库 ;

在【Android APT】编译时技术 ( 编译时注解和注解处理器依赖库 ) 博客中创建了 annotation-compiler 注解处理器依赖库 , 基于该基础开发注解处理器 ;

创建 Compiler 注解处理器 , 该类主要作用是生成代码 , 注解处理器类必须继承 javax.annotation.processing.AbstractProcessor 类 , 这是 Java 的 API , 再 Android 中无法获取该 API , 因此编译时注解和注解处理器都必须是 Java 依赖库 ;

package kim.hsl.annotation_compiler;import java.util.Set;import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;/*** 生成代码的注解处理器*/
public class Compiler extends AbstractProcessor {@Overridepublic boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {return false;}
}

二、使用注解 @AutoService(Processor.class) 标注注解处理器

上述实现的 AbstractProcessor 中的 process 方法 , 专门用于搜索 Android 源码中使用的编译时注解的方法 ;

程序构建时 , 发现了 annotationProcessor project(path: ':annotation-compiler') 依赖 , 使用 annotationProcessor 进行依赖 , 说明这是一个注解处理器 , 此时会到 annotation-compiler 模块中查找注解处理器 , 注解处理器的查找方式也是通过注解标记进行查找 , 该注解是 Google 服务库提供的 ;

如果要使用注解标记注解处理器 , 首先要依赖 Google 服务库 ,

dependencies {implementation fileTree(dir: 'libs', include: ['*.jar'])annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'compileOnly 'com.google.auto.service:auto-service:1.0-rc3'
}

然后到 public class Compiler extends AbstractProcessor 注解处理器类上使用 @AutoService(Processor.class) 标注 , Android 编译器通过查找该注解 , 确定哪个类是注解处理器 ;

import com.google.auto.service.AutoService;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;/*** 生成代码的注解处理器*/
@AutoService(Processor.class)
public class Compiler extends AbstractProcessor {@Overridepublic boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {return false;}
}

三、注解处理器 init 初始化方法

AbstractProcessor 注解处理器中 , 专门提供了一个 init 方法 , 该方法专门用于注解处理器相关初始化操作 ;

@Override
public synchronized void init(ProcessingEnvironment processingEnv) {super.init(processingEnv);
}

init 方法的 ProcessingEnvironment processingEnv 参数很重要 , 通过该参数可以获取注解处理器中的各种重要工具 ;

ProcessingEnvironment 中定义了获取相关工具的接口 ;

public interface ProcessingEnvironment {Map<String,String> getOptions();Messager getMessager();Filer getFiler();Elements getElementUtils();Types getTypeUtils();SourceVersion getSourceVersion();Locale getLocale();
}

四、注解处理器 Filer 代码生成工具

通过注解生成 Java 代码需要使用 Filer 对象 , 将该对象定义到注解处理器成员变量中 , 在 init 方法中进行初始化操作 ;

通过 ProcessingEnvironment 可以通过调用 getFiler 方法 , 获取 Filer 对象 ;

    /*** 生成 Java 代码对象*/private Filer mFiler;/*** 初始化注解处理器相关工作* @param processingEnv*/@Overridepublic synchronized void init(ProcessingEnvironment processingEnv) {super.init(processingEnv);this.mFiler = processingEnv.getFiler();}

五、注解处理器 Messager 日志打印工具

注解处理器中不能打断点进行调试 , 也不能使用 Log , System.out 打印日志 , 在注解处理器中只能通过 Messager 打印日志 ;

通过调用 ProcessingEnvironment 的 getMessager 方法 , 可以获取到 Messager 对象 ;

    /*** 日志打印*/private Messager mMessager;/*** 初始化注解处理器相关工作* @param processingEnv*/@Overridepublic synchronized void init(ProcessingEnvironment processingEnv) {super.init(processingEnv);this.mMessager = processingEnv.getMessager();}

六、博客资源

博客源码 :

GitHub : https://github.com/han1202012/APT
CSDN :

【Android APT】注解处理器 ( 注解标注与初始化方法 )相关推荐

【Android APT】注解处理器 ( 根据注解生成 Java 代码 )
文章目录一.生成 Java 代码二.实现 IButterKnife 接口三.视图绑定主要操作四.完整注解处理器代码五.博客资源 Android APT 学习进阶路径 : 推荐按照顺序阅读 , ...
【Android APT】注解处理器 ( Element 注解节点相关操作 )
文章目录一.获取被注解标注的节点二.Element 注解节点类型三.VariableElement 注解节点相关操作四.注解处理器完整代码示例五.博客资源 Android APT 学习 ...
【Android APT】注解处理器 ( 配置注解依赖、支持的注解类型、Java 版本支持 )
文章目录一.注解处理器依赖编译时注解二.设置注解处理器支持的注解类型三.设置注解处理器支持的 Java 版本四.博客资源 Android APT 学习进阶路径 : 推荐按照顺序阅读 ...
Android 注解与注解处理器简述
Android 注解与注解处理器简述前言正文一.注解 ① 注解类型 ② 注解生命周期 ③ 注解参数二.注解处理器 ① 注册 ② 配置三.使用 ① 接口 ② 反射 ③ 使用 ④ 强化四.源码 ...
【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 )
文章目录一.注解节点类型二.JavaPoet 简介三.注解处理器中使用 JavaPoet 生成代码四.路由框架说明五.博客资源组件化系列博客 : [Android 组件化]从模块化到组件化 ...
【Android APT】编译时技术 ( 开发编译时注解 )
文章目录一.编译时注解二.编译时注解使用三.注解的保留时间四.博客资源一.编译时注解上一篇博客 [Android APT]编译时技术 ( 编译时注解和注解处理器依赖库 ) 中创建并 ...
Android 自定义注解处理器详解
文章目录 AbstractProcessor 方法详细信息 ProcessingEnvironment 方法详细信息 1 新建 Java Library 1.1 新建 1.2 确定依赖关系 2 创建自 ...
【错误记录】Android 编译时技术报错 ( 注解处理器 process 方法多次调用问题 )
文章目录一.报错信息二.问题分析三.解决方案注解处理器 AbstractProcessor 中的 process 方法可能会调用多次 , 在生成代码时 , 一定要注意 , 检测到注解节点后 ...
Java注解编译_Java注解(3)-注解处理器（编译期|RetentionPolicy.SOURCE）
注解的处理除了可以在运行时通过反射机制处理外,还可以在编译期进行处理.在编译期处理注解时,会处理到不再产生新的源文件为止,之后再对所有源文件进行编译. Java5中提供了apt工具来进行编译期的注解处 ...

【Android APT】注解处理器 ( 注解标注与初始化方法 )

文章目录

一、注解处理器 AbstractProcessor

二、使用注解 @AutoService(Processor.class) 标注注解处理器

三、注解处理器 init 初始化方法

四、注解处理器 Filer 代码生成工具

五、注解处理器 Messager 日志打印工具

六、博客资源

【Android APT】注解处理器 ( 注解标注与初始化方法 )相关推荐

最新文章

热门文章

【Android APT】注解处理器 ( 注解标注 与 初始化方法 )

文章目录

一、注解处理器 AbstractProcessor

二、使用注解 @AutoService(Processor.class) 标注 注解处理器

三、注解处理器 init 初始化方法

四、注解处理器 Filer 代码生成工具

五、注解处理器 Messager 日志打印工具

六、博客资源

【Android APT】注解处理器 ( 注解标注 与 初始化方法 )相关推荐

最新文章

热门文章

【Android APT】注解处理器 ( 注解标注与初始化方法 )

二、使用注解 @AutoService(Processor.class) 标注注解处理器

【Android APT】注解处理器 ( 注解标注与初始化方法 )相关推荐