java 注解

一、基本语法

1. 注解说明

1. Annotation 其实就是代码里的 特殊标记, 并没有功能函数。这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。

2. 注解不支持继承：不能使用关键词extends继承某个@interface

2. 定义注解

• 常用到的注解

@Override：限定重写父类方法, 该注解只能用于方法
@Deprecated：用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings：关闭不当的编译器警告

• 自定义一个最简单的注解示例，

// 允许在类、接口下使用
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Myinterface{
    String value() default ""; 
    // 如果定义为String name() 那么赋值name不能省略 
    // 必须@Myinterface(name="OK") 不能 @Myinterface("OK")
}

• 注解的使用

• 注解在使用时必须对变量赋值，所以常用的是用default设置初值，就可以不用每次赋值

@Myinterface("OK") // value的值为"OK" 

// @Myinterface()  value的值为默认值""

public class MyClass{
}

3. 元注解

• @Target: 表示注解用到什么地方。下面是可能的ElementType参数

CONSTRUCTOR： 构造器声明
FIELD: 域声明（包括enum实例）
LOCAL_VARIABLE： 局部变量声明
PACKAGE： 包声明
PARAMETER： 参数声明
TYPE： 类、接口（包括注解类型）或enum声明
TYPE_USER： 表示该注解能写在类型参数的声明语句中（如：泛型声明）
TYPE_PARAMETER ： 表示注解可以再任何用到类型的地方使用
ANNOTATION_TYPE ：可以用于注解声明
METHOD ： 作用于函数

@Target(ElementType.TYPE)、
// 使用多个
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})

• @Retention: 表示需要在什么级别保存该注解信息。下面是可选择的RetentionPolicy参数

SOURCE：注解将被编译器丢弃，自能留在源文件中
CLASS：注解在class文件中可用，但会被VM丢弃
RUNTIME：VM在运行期间也保留注解，因此可以通过反射机制读取注解的信息

• @Documented：将注解包含在Javadoc中

• @Inherited：允许子类继承父类中的注解

4. 可重复注解

• @Repeatable ：允许重复注解，这是java1.8以后加入的注解功能，以前要实验多个重复注解需要通过数组实现，此处的注解只是简化的开发，其他没有变化

• 注意：两个注解使用的元注解的内容需要保持一致，不然很容易报错。

// 用于演示全部的功能

// 创建Persons注解，作为Person的容器
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Persons{
    Person[] value();
}

// 创建Person注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Persons.class)
public @interface Person {
    // 注解在使用时必须赋值，设置default值是常见的作法
    String name() default ""; 
}

// 注解的使用
@Person(name="张三")
@Person(name="李四")
class MyClass{
}

二、注解处理器

说明：注解本身只是一种标识，没有直接的功能操作。我们可以通过反射的方式来让注解有特殊的功能

1. 运行时注解器

运行时注解器是通过反射和注解完成，因为反射需要在编译完成生成.class文件有class对象以后才能使用，下面举一个简单的例子，执行被注解的方法

• 创建一个注解，

// 类的方法可被修饰
@Target(ElementType.METHOD)
// 必须是RUNTIME，需要在运行时使用
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "";
}

• 创建一个类

public class MyClass {
    @MyAnnotation("this is my annotation")
    public void play1(){
        System.out.println("play1");
    }

    public void play2(){
        System.out.println("play2");
    }
    
    
    public void play3(){
        System.out.println("play3");
    }

}

• 通过反射操纵函数，执行MyClass类里面被注解的函数

    @Test
    public void myAnnotationProcessor() throws 
NoSuchMethodException, InvocationTargetException, 
InstantiationException, IllegalAccessException {

        Class<MyClass> clazz = MyClass.class;
        Method[] methods = clazz.getMethods();
        for (Method method : methods) {
            // 确认是否被MyAnnotation注解修饰过
            if(method.isAnnotationPresent(MyAnnotation.class)){
                // 获得注解的内容
                MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
                System.out.println("MyAnnotation注解的value="+annotation.value());
                // 反射创建MyClass的对象
                Object obj = clazz.getConstructor().newInstance();
                // 执行函数
                method.invoke(obj);
            }
        }

    }

下面是结果，可以取试试

2. 编译时注解器（APT）

APT（Annotation Processing Tool）是一种注解处理工具，它对 源代码文件进行检测，并找出源文件所包含的注解信息，然后针对注 解信息进行额外的处理。

Java提供的javac.exe工具有一个-processor选项，该选项可指定 一个注解处理器，如果在编译Java源文件时通过该选项指定了注解处 理器，那么这个注解处理器将会在编译时提取并处理Java源文件中的 注解

每个注解处理器都需要实现javax.annotation.processing包下的 Processor接口。不过实现该接口必须实现它里面所有的方法，因此通 常会采用继承AbstractProcessor的方式来实现注解处理器。一个注解 处理器可以处理一种或者多种注解类型

下面是简单的创建模板例子，总结特点就是在编译时处理相关注解

下面是创建步骤

• 创建注解

@Target(ElementType.TYPE)
// SOURCE：注解将被编译器丢弃，自能留在源文件中
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {
    String value() default "";
}

• 创建使用的类

@MyAnnotation
public class MyClass {
    
}

• 创建处理器,其中重要的是process函数

import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
import java.util.HashSet;
import java.util.Set;


// 用来指示注释处理器所支持的版本的注释
@SupportedSourceVersion(SourceVersion.RELEASE_8)
// 指定可处理的注解 多个时用{"","".""}
@SupportedAnnotationTypes("MyAnnotation")
public class MyProcessor extends AbstractProcessor {

    // Processor初始化回调
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        System.out.println("MyProcessor init");
    }

    // processor处理过程的回调, 如果需要生成代码, 就在这个方法中写.
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历每一个被MyAnnotation注解修饰的class文件
        for (Element element : 
             roundEnv.getElementsAnnotatedWith(MyAnnotation.class)) {
            // 判断element的类型
            if(element.getKind()!= ElementKind.CLASS){
            }
        }
        return true;
    }

    // 可以在此处声明该processor支持的注解类型，也可直接通过上面注解的形式完成
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> set = new HashSet<>();
        set.add(MyAnnotation.class.getCanonicalName());
        return set;
    }

    // 用来指示注释处理器所支持的最新源版本的注释，也可以通过注解完成
    @Override
    public SourceVersion getSupportedSourceVersion() {
        // 可以自己指定 return SourceVersion.RELEASE_8;
        // 通常直接返回SourceVersion.latestSupported()就可以
        return SourceVersion.latestSupported();
    }
}

• 编译使用函数

javac -processor MyProcessor MyClass.java