文章目录
- 标注注解
- 元注解
- @Target
- RetentionPolicy
- 创建自定义注解
- 实现注解处理器
- AbstractProcessor 里面的Element
- 1.TypeElement :
- 2.VariableElement:
- 3.ExecuteableElement:
- 需要实现的AbstractProcessor 方法
- 1.init()
- 2.getSupportedSourceVersion()
- 3.getSupportedAnnotationTypes()
- 4.process()
- 参考
标注注解
@Overrride:对覆盖超类中的方法进行标记,如果被标记的方法并没有实际覆盖超类中的方法,则编译器会发出警告。
@Deprecate:提示开发者该方法已经废弃,不推荐使用。
@SupperWarnings:选择性地取消特定代码中的警告。
元注解
用来标注其它注解而创建的新注解,元注解的类型有以下几种:
@Target:注解所修饰的对象范围
@Inherited:表示注解可以被继承
@Documented:表示这个注解应该被JavaDoc工具记录
@Rentation:用来声明注解的保留策略
@Repeable:JDK8新增,允许一个注解在同一声明类型(类,属性或方法)上多次使用。
@Target
其中@Target注解的取值是一个ElementType类型的枚举,其中有一下几种取值,对应不同的对象范围。
ElementType.TYPE:能修饰类,接口或者枚举类型。
ElementType.FIELD:能修饰成员变量
ElementType. METHOD:能修饰方法
ElementType. PARAMETER:能修饰参数
ElementType. CONSTRUCTOR:能修饰构造方法
ElementType.LOCAL_VARIABLE:能修饰局部变量
ElementType. ANNOTATION_TYPE:能修饰注解
ElementType. PACKAGE:能修饰包
ElementType.TYPE_PARAMETER:能修饰参数声明
ElementType.TYPE_USE:使用类型
其中@Retention注解有3种类型,分别表示不同级别的保留策略。
RetentionPolicy
RetentionPolicy.SOURCE:源码级注解,注解信息只会保留在Java源码中,源码在编译后,注解信息将会被丢弃,不会保留在.class文件中。
RetentionPolicy.CLASS:编译时注解。注解信息会保留在.java源码以及.class中。当运行java程序时,JVM会丢弃该注解信息,不会保留在JVM中,许多注解类框架,如EventBus,ButterKnife他们都是使用编译时注解信息开发的,针对编译时注解我们采用AbstractProcessor来处理注解信息。
RetentionPolicy.RUNTIME:运行注解。当运行Java程序时,JVM也会保留该注解信息,可以通过反射获取该注解信息。
创建自定义注解
首先自定义一个注解:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface MyAnnotation {String name();
}
实现注解处理器
注解处理器模块要依赖前面的注解。被注解到的方法、类或者成员变量
自定义的处理器需要继承AbstractProcessor,需要自己实现的方法如下:
public class AnnotationProcessor extends AbstractProcessor {@Overridepublic synchronized void init(ProcessingEnvironment processingEnvironment) {}@Overridepublic SourceVersion getSupportedSourceVersion() {}@Overridepublic Set<String> getSupportedAnnotationTypes() {}@Overridepublic boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {}
}
AbstractProcessor 里面的Element
Element可以拿到特定的元素类型。
1.TypeElement :
类或者接口类型
2.VariableElement:
成员变量
3.ExecuteableElement:
成员方法
需要实现的AbstractProcessor 方法
1.init()
方法可以初始化拿到一些使用的工具,比如文件相关的辅助类 Filer;
元素相关的辅助类Elements;日志相关的辅助类Messager;
2.getSupportedSourceVersion()
返回 Java 版本;
3.getSupportedAnnotationTypes()
方法返回要处理的所有注解。
4.process()
注解处理器的处理方法。想要使用注解处理器做什么,就在这里执行。
一般来说很多开源框架通过这个来生成代码,例如Java文件。然后通过生成的java文件去做各种事情,非常灵活。
通过Java生成代码的库: javapoet
那么怎么在编译的时候JVM怎么找到我们自定义的注解处理器?可以阅读下:
Java SPI (Service Provider Interface)
参考
https://www.jianshu.com/p/ac6a69adecff
https://www.jianshu.com/p/9616f4a462bd