Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。 注解是元数据的一种形式，提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。
一、注解的声明@interface
Java中所有的注解，默认实现Annotation 接口：
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
与class的声明相似，注解使用@interface声明
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface Test{
String value();
}
元注解
元注解是可以注解到注解上的注解，也可以说是一种基本注解，但是他可以应用到其它注解上。
元注解标签有@Retention、@Target、@Documented、@Inherited、@Repeatable五种。
@Retention
注解指定标记注解的存储方式：
RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中，并被编译器忽略。
RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留，但 Java 虚拟机(JVM)会忽略。
RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留，因此运行时环境可以使用它。
@Retention 三个值中 SOURCE < CLASS < RUNTIME，即CLASS包含了SOURCE，RUNTIME包含SOURCE、CLASS。
@Target
注解标记另一个注解，以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值：
ElementType.ANNOTATION_TYPE 可以应用于注解类型。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.FIELD 可以应用于字段或属性。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.METHOD 可以应用于方法级注解。
ElementType.PACKAGE 可以应用于包声明。
ElementType.PARAMETER 可以应用于方法的参数。
ElementType.TYPE 可以应用于类的任何元素。
@Documented
它的作用能够将注解中的元素包含到Javadoc中去。
@ inherited
它的作用是如果一个超类被@Inherited注解进行注解，那么他的子类没有被任何注解应用的话，它的子类就继承超类的注解
@Repeatable
@Repeatable是Java1.8加入新特性，是指注解的值可以同时取多个。
//@Target(ElementType.TYPE) 只能在类上标记该注解
@Target({ElementType.TYPE,ElementType.FIELD}) // 允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface Test{
}
二、注解的属性
注解的属性也叫成员变量。注解只有成员变量，没有方法。注解中定义类型必须是8中基本类型、类、接口、枚举、注解以及它们的数组。
//@Target(ElementType.TYPE) 只能在类上标记该注解
@Target({ElementType.TYPE,ElementType.FIELD}) // 允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface Test{
int value();
String name() default "";
}
三、注解的提取
反射提取注解（运行期的注解提取）
首先通过Class对象的isAnnotationPresent()方法判断是否应用到注解。
然后通过getAnnotation(Class<?> clazz)getAnnotations()或者方法获取Annotation对象。
如果获取到Annotation对象不为空，annotation.value()获取注解的值
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Autowire {
String value() default "";
}
public class Test {
public static void main(String[] args) {
Class<Person> clazz = Person.class;
if (clazz.isAnnotationPresent(Autowire.class)){
Autowire annotation = clazz.getAnnotation(Autowire.class);
String value = annotation.value();
}
}
}
APT注解处理器（编译期注解提取）
APT全称为："Anotation Processor Tools"，意为注解处理器。其用于处理注解。编写好的Java源文件，需要经过javac 的编译，翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由javac调起，并将注解信息传递给注解处理器进行处理。
1.首先引入谷歌的自动注册服务，AutoService
implementation 'com.google.auto.service:auto-service:1.0-rc4'
implementation 'com.google.auto:auto-common:0.10'
2.继承AbstractProcessor抽象类
class WondertwoProcessor extends AbstractProcessor {
//返回注解处理器可处理的注解操作
@Override
public Set<String> getSupportedOptions() {
return super.getSupportedOptions();
}
//得到注解处理器可以支持的注解类型
@Override
public Set<String> getSupportedAnnotationTypes() {
return super.getSupportedAnnotationTypes();
}
//执行一些初始化逻辑
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
}
//核心方法，扫描，解析并处理自定义注解，生成***.java文件
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
return false;
}
}
- 重写核心方法process()
/**
* 自定义注解处理器，将类中public方法提取为接口方法（不含static方法）
* {
* Exec: apt -factory annotation3.WondertwoFactory
* ProvinceDefiner.java -s ../annotaion3
* }
* Created by wondertwo on 2016/10/18.
*/
class WondertwoProcessor extends AbstractProcessor {
private ProcessingEnvironment envir;
public WondertwoProcessor(ProcessingEnvironment env) {
this.envir = env;
}
@Override
public Set<String> getSupportedOptions() {
return super.getSupportedOptions();
}
@Override
public Set<String> getSupportedAnnotationTypes() {
return super.getSupportedAnnotationTypes();
}
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement typeEle : annotations) {
WondertwoInterface wondertwoInterface = typeEle.getAnnotation(WondertwoInterface.class);
if (wondertwoInterface == null) break;
Class clazz = typeEle.getClass();
if (clazz.getDeclaredMethods().length > 0) {
try {
if (typeEle.getModifiers().contains(Modifier.PUBLIC)
&& !typeEle.getModifiers().contains(Modifier.STATIC)) {
PrintWriter writer = (PrintWriter) envir.getFiler()
.createSourceFile(wondertwoInterface.value());
writer.println("package " + clazz.getPackage().getName() + ";");
writer.println("public interface " + wondertwoInterface.value() + " {");
for (Method method : clazz.getDeclaredMethods()) {
writer.print(" public ");
writer.print(method.getReturnType() + " ");
writer.print(method.getName() + " (");
int i = 0;
for (TypeParameterElement parameter : typeEle.getTypeParameters()) {
writer.print(parameter.asType() + " " + parameter.getSimpleName());
if (++i < typeEle.getTypeParameters().size())
writer.print(", ");
}
writer.println(");");
}
writer.println("}");
writer.close();
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
return true;
}
}
IDE语法检查(source使用)
在Android开发中， support-annotations 与androidx.annotation) 中均有提供@IntDef 注解，此注解的定义如下：
@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
int[] value() default {};
boolean flag() default false;
boolean open() default false;
}
此注解的意义在于能够取代枚举，实现如方法入参限制。
网友评论