【Java SE】十六、注解

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容。当然它也支持自定义 Java 标注。

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解：

@Override：检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
@Deprecated：标记过时方法。如果使用该方法，会报编译警告。
@SuppressWarnings：指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说元注解)：

@Retention：标识这个注解的生命周期，是只在源代码中，还是编入 class 文件中，或者是在运行时可以通过反射访问。
@Documented：标记这些注解是否包含在 Javadoc 中。
@Target：标记这个注解可以修饰哪种 Java 成员。
@Inherited：标记这个注解是可被子类继承的。

从 Java 7 开始，额外添加了 3 个注解：

@SafeVarargs：Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
@FunctionalInterface：Java 8 开始支持，标识一个匿名函数或函数式接口。
@Repeatable：Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

基本注解

这三个注解常用在代码当中，如下所示：

interface Info {
    void fuck();
}

class Shit implements Info {
    @Override // 检查是否正确重写方法
    void fuck() {
        System.out.println("Oh,fuck!");
    }
    
    @Deprecated // 表明方法已过时，不建议使用
    void shit() {
        @SuppressWarnings("unused") // 忽略变量未使用的警告
        String desire = "breast";
        System.out.println("Oh,shit!");
    }
}

自定义注解

在 Java 中自定义注解需要用到 @interface 修饰符，但它跟接口没啥关系。

public @interface MyAnnotation {
    String value(); // 单参数形式，也可以无参数，跟@Override一样
 // String value() default "fuck"; - 还可以指定默认参数
 // String[] value() - 如果要传入多个值,可以像这样定义
}
/* 跟据自定义的类型，选择合适的形式
 * @MyAnnotation 无参或默认参数形式，作为标识
 * @MyAnnotation("hello") 传参形式
 * @MyAnnotation({"fuck", "your", "mother"}) 多参形式
 */
class Test {...}

自定义注解必须配上注解的信息处理流程(使用反射)才有意义，反射部分后续再讲。

元注解

元注解就是修饰注解的注解，Java 提供了四种元注解，如上文所述，示例如下：

@Retention(RetentionPolicy.RUNTIME) // 标识该注解可在运行时访问
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) // 标识该注解可标注的Java成员
@Documented // 标识该注解可包含在Javadoc中
@Inherited // 标识该注解可被所修饰的父类的子类继承
public @interface MyAnnotation {String value();}

可重复注解

这是 JDK 8 新增的一个新特性，示例如下：

@interface MyAnnotations {MyAnnotation[] value();} // 先定义复数类

@Repeatable(MyAnnotations.class) // 在声明这个
public @interface MyAnnotation {String value();}

@MyAnnotation("hello")
@MyAnnotation("world") // 重复注解
class Test {...}

注意：复数类必须与原来的注解类设定相同，如：生命周期、可修饰类型等

类型注解

JDK 8 中 @Target 新增了两个修饰类型 TYPE_PARAMETER , TYPE_USE，使得注解可以应用在更多的地方，示例如下：

class Generic<@MyAnnotation T> { // 需要在@Target中添加TYPE_PARAMETER
    public void show() throws @MyAnnotation RuntimeException { // 需要在@Target中添加TYPE_USE
        ArrayList<@MyAnnotation String> list = new ArrayList<>(); // 需要在@Target中添加TYPE_USE
        int num = (@MyAnnotation int) 10L; // 需要在@Target中添加TYPE_USE
    }
}

Hualiang's Blog