注解 | 桂子飘香

自JDK5.0开始，新增了注解的功能。注解是一种特殊的注释，注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”。

Annotation其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证
或者进行部署。

Annotation 可以像修饰符一样被使用, 可用修饰包, 类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。

未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

Table of Contents

常见的注解

文档相关注解：

@author 标明开发该类模块的作者，多个作者之间使用,分割

@version 标明该类模块的版本

@see 参考转向，也就是相关主题

@since 从哪个版本开始增加的

@param 对方法中某参数的说明，如果没有参数就不能写

@return 对方法返回值的说明，如果方法的返回值类型是void就不能写

@exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写

其中

@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名形参类型形参说明
@return 的格式要求：@return 返回值类型返回值说明
@exception的格式要求：@exception 异常类型异常说明
@param和@exception可以并列多个

/**
 * @author gwx
 * created 2021-01-03
 */
class Util
{
    /**
     * 获取一段范围内的随机整数
     * @param min 最小值
     * @param max 最大值
     * @return int
     */
    public static int numRand (int min, int max)
    {
        double n = Math.random() * (max - min + 1) + min;
        return (int) n;
    }

}

编译时进行检查的注解：(JDK内置三个基本注解)：

@Override: 限定重写父类方法, 该注解只能用于方法

@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告

public class T4{
    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int a = 10;
    }
    @Deprecated
    public void print(){
        System.out.println("过时的方法");
    }
    @Override
    public String toString() {
        return "重写的toString方法()";
    }
}

自定义注解

自定义注解，参照SuppressWarnings。

定义新的 Annotation 类型使用 @interface 关键字，它与interface没有关系
自定义注解自动继承了java.lang.annotation.Annotation 接口
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String 类型、Class 类型、enum 类型、Annotation 类型、以上所有类型的数组。
可以在定义Annotation的成员变量时为其指定初始值, 指定成员变量的初始值可使用default关键字
如果只有一个参数成员，建议使用参数名为value
如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
注意：自定义注解必须配上注解的信息处理流程（反射）才有意义。

public @interface MyAnnotation {
    String value();
}

@MyAnnotation("hello")  // 简写
class Employee implements Comparable
{
    @MyAnnotation(value = "nihao")
    private String name;
}

给注解参数成员设置默认值

public @interface MyAnnotation {

    String value() default "hello";
}

@MyAnnotation()  // 简写
class Employee implements Comparable
{
    @MyAnnotation(value = "nihao")
    private String name;
}

元注解

有一些注解可以修饰其他注解，这些注解就称为元注解（meta annotation）。Java标准库已经定义了一些元注解，我们只需要使用元注解，通常不需要自己去编写元注解。

Retention
Target
Documented
Inherited
Repeatable

@Retention

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy（枚举类）类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值：

SOURCE ：源文件有效，编译器直接忽略这类注释
CLASS：在class文件有效（默认值）
RUNTIME：运行时有效

@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {

    String value() default "hello";
}

@Target

@Target：用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。value是一个枚举数组，存放ElementType枚举元素。枚举元素有：

TYPE（描述类、接口或enum声明）,
FIELD,
METHOD,
PARAMETER,
CONSTRUCTOR,
LOCAL_VARIABLE,
ANNOTATION_TYPE,
PACKAGE,
TYPE_PARAMETER（1.8后新增，表示该注解能写在类型变量（泛型）的声明语句中）,
TYPE_USE(1.8后新增，表示注解能写在使用类型的任何语句中)

@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface MyAnnotation {

    String value() default "hello";
}

@Documented

@Documented: 用于指定被该元注解修饰的注解类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。（实际开发中，很少用）

下面介绍JDK8之后，新增的两类元注解

@Inherited

@Inherited：被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。（实际开发中，基本用不上）

@Repeatable

@Repeatable(1.8新增）:使用@Repeatable这个元注解可以定义Annotation是否可重复。这个注解应用不是特别广泛。

1.8没有这个元注解前，是如何使用重复注解的

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Writer {
    String value() default "MonkeykingGWX";
}

public @interface Writers {
    Writer[] value();
}

@Writers({@Writer("鲁迅"), @Writer("金庸")})
class Employee implements Comparable
{
    .....
}

使用@Repeatable修改上述代码：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Repeatable(Writers.class)
public @interface Writer {

    String value() default "MonkeykingGWX";
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Writers {
    Writer[] value();
}

@Writer("金庸")
@Writer("梁羽生")
class Employee implements Comparable
{
    // ......
}

① 在Writer上声明@Repeatable，成员值为Writers.class

② Writer的Target、Inherited和Retention等元注解与Writers相同。

注解