注解是一种元数据(meta data),提供程序相关的数据,但并不是程序本身,不会直接影响所注解的代码的操作
相关类位于java.lang.annotation
包,每个注解都隐式的扩展了Annotation
接口
用途
- Compiler instructions,编译器的信息(Java三个内置的注解@Deprecated, @Override,@SuppressWarnings),注解被编译器用来探测错误或者抑制警告
- Build-time instructions,编译期使用注解处理器进行处理,产生代码或者XML文件等
- Runtime instructions,在运行时使用 Java 反射机制读取并进行处理
注解基础
//使用注解
@Entity
@符号向编译器表明这是一个注解,接下来是一个注解名称(Entity)
注解元素
注解内可以包含元素信息
@Entity(tableName = "vehicles", primaryKey = "id")
如果注释中只有一个元素,并且名字叫value,那么元素名称可以被省略
@InsertNew(value = "yes")
@InsertNew("yes")
注解位置
可以把注解用在类,接口,方法,方法参数,字段,变量上
同时也可以在同一个声明上使用多个注释
Java内置注解
Java提供了三个内置注释用于给Java编译器指令
- @Deprecated
- @Override
- @SuppressWarnings
@Deprecated
标识类、方法或者字段是废弃的,不应该再被使用,否则编译器会发出警告
@Override
用在重载超类的方法上,如果该方法没有对应超类的方法,编译器会报错
@SuppressWarnings
在给定的方法上抑制编译器警告
@SuppressWarnings({"unchecked", "deprecation",...."path","all"})
void myMethod() { ... }
创建自定义注解
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCustomAnnotation{
int studentAge() default 18;
String studentName();
String stuAddress();
String stuStream() default "CSE";
}
- 通过
@interface
创建注解 - 注解元素的定义类似接口中的方法,不需要提供实现,数据类型可以使基本数据类型(primitive data types)或者是对应的数组,String,enum等。
- 通过
default
定义默认值
有四个元注解(meta-annotation),用来对其他annotation类型做说明
@Documented
使得JavaDoc生成说明文件时加入注解信息
@Target
指定注解修饰的对象
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.METHOD})
public @interface MyAnnotation {
String value();
}
十种类型,后两种是Java8后新增的:
ElementType.METHOD
ElementType.PACKAGE
ElementType.PARAMETER
ElementType.TYPE // 类、接口(包括注释类型)或枚举声明
ElementType.ANNOTATION_TYPE //注释类型声明
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE //局部变量声明
ElementType.FIELD //字段声明(包括枚举常量)
ElementType.TYPE_PARAMETER//类型参数
ElementType.TYPE_USE//类型使用
@Inherited
注释类型会被自动继承。如果一个使用了@Inherited修饰的annotation类型被用于一个class,该class的子类会继承这个注解
只有在注解class的时候才会有用
@Retention
定义了该Annotation被保留的时间长短
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
@interface MyCustomAnnotation { }
某些Annotation仅出现在源代码中,而被编译器丢弃;
而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
RetentionPolicy.RUNTIME
被记录到 .class文件中,在运行时被VM保存,通过反射访问
RetentionPolicy.CLASS
被保存到 .class 文件中,在运行时不存在,这是默认类型
RetentionPolicy.SOURCE
在源代码中存在,在 .class文件中和运行时都不存在
注解处理器
用来处理编译时注解,可以看做是一个Javac
编译器插件,可以读取,修改,添加抽象语法树的任意元素。
注解处理器,以Java代码(或者编译过的字节码)作为输入,生成文件(通常是.java文件)作为输出,不会修改已经存在的Java类,例如向已有的类中添加方法。这些生成的Java文件,会同其他手动编写的Java源代码一样被javac编译。
自定义注解处理器需要继承抽象类javax.annotation.processing.AbstractProcessor
,重写process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
等方法
参照:
Java注解处理器
ANNOTATION PROCESSING 101
最后是打包注册,使得Java编译器可以找到这个注解处理器
- 将注解处理器打包进一个Jar包
- 在这个Jar包中要包含一个文件夹META-INF/services
- 在这个文件夹中要包含一个名为javax.annotation.processing.Processor的文件
- 在这个文件里面将Jar包中所有注解处理器的完整类名写进去,每个类名一行
在运行时处理注解是通过反射的方式