文章目录
一、注解处理器 接收参数设置
二、注解处理器 生成路由表 Java 代码
三、博客资源
组件化系列博客 :
【Android 组件化】从模块化到组件化
【Android 组件化】使用 Gradle 实现组件化 ( Gradle 变量定义与使用 )
【Android 组件化】使用 Gradle 实现组件化 ( 组件模式与集成模式切换 )
【Android 组件化】使用 Gradle 实现组件化 ( 组件 / 集成模式下的 Library Module 开发 )
【Android 组件化】路由组件 ( 路由组件结构 )
【Android 组件化】路由组件 ( 注解处理器获取被注解的节点 )
【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 )
在 【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 ) 博客中在注解处理器中 , 简单的使用了 JavaPoet 生成了 Java 代码 ;
本篇博客中讲解 " 注解处理器 " 后续开发 , 在 build.gradle 构建脚本中设置参数 , 并在注解处理器中获取该参数 ;
一、注解处理器 接收参数设置
注解处理器只能是 Java 依赖库 Module , 因为 注解处理器 需要继承 javax.annotation.processing.AbstractProcessor 抽象类 , 该类在 javax 包中 , Android 中是没有该包的 ;
注解处理器参数选项 :
注解处理器 可以接受外部参数 , 这些参数可以在 build.gradle 构建脚本中设置 ;
在注解处理器类上使用 @SupportedOptions 注解 , 设置注解处理器接收的参数 ;
// 注解处理器接收的参数 @SupportedOptions("moduleName") public class RouterProcessor extends AbstractProcessor { }
SupportedOptions 注解传入一个字符串数组 , 也可以选择传入一个字符串参数 ;
@Documented @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface SupportedOptions { String[] value(); }
该参数在 app 主应用 Module 的 build.gradle 中设置 , 在 " android / defaultConfig " 层级下 , 设置 javaCompileOptions 选项 , 这是 Java 编译选项 , 设置其 注解处理器选项 annotationProcessorOptions 的 arguments 参数 ;
这里设置的参数作用是用于拼接生成 Java 源码的类名 ;
这里设置的 moduleName 参数就是工程名 project.getName() ;
android { defaultConfig { javaCompileOptions { annotationProcessorOptions { arguments = [moduleName: project.getName()] } } } }
打印获取的参数 : 在 init 方法中 , 调用 ProcessingEnvironment processingEnvironment 参数的 getOptions 方法获取参数设置 Map 集合 , 然后获取其 “moduleName” 键对应的值 , 使用 Messager 将其在编译时打印出来 ;
// 获取 moduleName 参数 // 先获取 注解处理器 选项 Map<String, String> options = processingEnvironment.getOptions(); if (options != null){ mModuleName = options.get("moduleName"); mMessager.printMessage(Diagnostic.Kind.NOTE, "打印 moduleName 参数 : " + mModuleName); }
二、注解处理器 生成路由表 Java 代码
注解处理器完整代码 :
package kim.hsl.router_compiler; import com.google.auto.service.AutoService; import com.squareup.javapoet.JavaFile; import com.squareup.javapoet.MethodSpec; import com.squareup.javapoet.TypeSpec; import java.io.IOException; import java.util.Map; import java.util.Set; import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.Filer; import javax.annotation.processing.Messager; import javax.annotation.processing.ProcessingEnvironment; import javax.annotation.processing.Processor; import javax.annotation.processing.RoundEnvironment; import javax.annotation.processing.SupportedAnnotationTypes; import javax.annotation.processing.SupportedOptions; import javax.annotation.processing.SupportedSourceVersion; import javax.lang.model.SourceVersion; import javax.lang.model.element.Element; import javax.lang.model.element.Modifier; import javax.lang.model.element.TypeElement; import javax.lang.model.util.Elements; import javax.lang.model.util.Types; import javax.tools.Diagnostic; import kim.hsl.router_annotation.Route; // 注解处理器接收的参数 @SupportedOptions("moduleName") // 自动注册注解处理器 @AutoService(Processor.class) // 支持的注解类型 @SupportedAnnotationTypes({"kim.hsl.router_annotation.Route"}) // 支持的 Java 版本 @SupportedSourceVersion(SourceVersion.RELEASE_8) public class RouterProcessor extends AbstractProcessor { /** * 注解处理器中使用 Messager 对象打印日志 */ private Messager mMessager; /** * 用于写出生成的 Java 代码 */ private Filer mFiler; /** * 注解节点工具 */ private Elements mElementUtils; /** * 类工具 */ private Types mTypeUtils; /** * 获取的 moduleName 参数 */ private String mModuleName; /** * 该函数在初始化时调用 , 相当于构造函数 * @param processingEnvironment */ @Override public synchronized void init(ProcessingEnvironment processingEnvironment) { super.init(processingEnvironment); // 获取打印日志接口 this.mMessager = processingEnvironment.getMessager(); // 测试日志打印 mMessager.printMessage(Diagnostic.Kind.NOTE, "Messager Print Log"); this.mFiler = processingEnvironment.getFiler(); this.mElementUtils = processingEnvironment.getElementUtils(); this.mTypeUtils = processingEnvironment.getTypeUtils(); // 获取 moduleName 参数 // 先获取 注解处理器 选项 Map<String, String> options = processingEnvironment.getOptions(); if (options != null){ mModuleName = options.get("moduleName"); mMessager.printMessage(Diagnostic.Kind.NOTE, "打印 moduleName 参数 : " + mModuleName); } } /** * 该函数在注解处理器注册时自动执行, 是处理注解的核心函数 * * Set<? extends TypeElement> set 参数 : 该集合表示使用了相关注解的节点的集合 * * @param set * @param roundEnvironment * @return */ @Override public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) { return false; } }
编译执行结果 : 打印出的 moduleName 参数为 app ;
注: Messager Print Log 注: 打印 moduleName 参数 : app 注: SupportedAnnotationTypes : kim.hsl.router_annotation.Route
三、博客资源
博客源码 :
GitHub : https://github.com/han1202012/Component
CSDN 下载 :
