手把手教你写Java注解

Java 注解

注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”，注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”。

1. 注解的作用

从JVM的角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。

Java注解可以分为三类：

1. 由编译器使用的注解：

• @Override : 让编译器检查该方法是否正确的实现了覆写；
• @SuppressWarnings： 告诉编译器忽略此处代码产生的警告

这类注解不会被编译进入.class文件，它们在编译后就被编译器扔掉了。

2. 由工具处理 .class 文件

有些工具会在加载class的时候，对class做动态修改，实现一些特殊的功能。这类注解会被编译进入.class文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般我们不必自己处理。

3. 在程序运行期能够读取的注解，加载后一直存在于JVM

一个配置了@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。

定义一个注解时，还可以定义配置参数。配置参数可以包括：

• 所有基本类型；
• String；
• 枚举类型；
• 基本类型、String、Class以及枚举的数组。

2. 定义注解

Java语言使用 @interface 语法来定义注解（Annotation），它的格式如下：

public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

注解的参数类似无参数方法，可以用default设定一个默认值（强烈推荐）。最常用的参数应当命名为value。

元注解

有一些注解可以修饰其他注解，这些注解就称为元注解（meta annotation）

@Target

最常用的元注解是@Target。使用@Target可以定义Annotation能够被应用于源码的哪些位置：

• 类或接口：ElementType.TYPE；
• 字段：ElementType.FIELD；
• 方法：ElementType.METHOD；
• 构造方法：ElementType.CONSTRUCTOR；
• 方法参数：ElementType.PARAMETER。

可以把@Target注解参数变为数组{ ElementType.METHOD, ElementType.FIELD }：

@Retention

另一个重要的元注解@Retention定义了Annotation的生命周期：

• 仅编译期：RetentionPolicy.SOURCE；
• 仅class文件：RetentionPolicy.CLASS；
• 运行期：RetentionPolicy.RUNTIME。

如果@Retention不存在，则该Annotation默认为CLASS。因为通常我们自定义的Annotation都是RUNTIME，所以，务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解：

@Repeatable

使用@Repeatable这个元注解可以定义Annotation是否可重复

经过@Repeatable修饰后，在某个类型声明处，就可以添加多个@Report注解：

@Report(type=1, level="debug")
@Report(type=2, level="warning")
public class Hello {
}

@Inherited

使用@Inherited定义子类是否可继承父类定义的Annotation。@Inherited仅针对@Target(ElementType.TYPE)类型的annotation有效，并且仅针对class的继承，对interface的继承无效

3. 处理注解

Java的注解本身对代码逻辑没有任何影响。根据@Retention的配置：

• SOURCE类型的注解在编译期就被丢掉了；
• CLASS类型的注解仅保存在class文件中，它们不会被加载进JVM；
• RUNTIME类型的注解会被加载进JVM，并且在运行期可以被程序读取。

如何使用注解完全由工具决定。SOURCE类型的注解主要由编译器使用，因此我们一般只使用，不编写。CLASS类型的注解主要由底层工具库使用，涉及到class的加载，一般我们很少用到。只有RUNTIME类型的注解不但要使用，还经常需要编写。

因为注解定义后也是一种class，所有的注解都继承自java.lang.annotation.Annotation，因此，读取注解，需要使用反射API。

Java提供的使用反射API读取Annotation的方法包括：

判断某个注解是否存在于Class、Field、Method或Constructor：

• Class.isAnnotationPresent(Class)
• Field.isAnnotationPresent(Class)
• Method.isAnnotationPresent(Class)
• Constructor.isAnnotationPresent(Class)

使用反射API读取Annotation：

• Class.getAnnotation(Class)
• Field.getAnnotation(Class)
• Method.getAnnotation(Class)
• Constructor.getAnnotation(Class)

使用反射API读取Annotation有两种方法。方法一是先判断Annotation是否存在，如果存在，就直接读取：

Class cls = Person.class;
if (cls.isAnnotationPresent(Report.class)) {
    Report report = cls.getAnnotation(Report.class);
    ...
}

第二种方法是直接读取Annotation，如果Annotation不存在，将返回null：

Class cls = Person.class;
Report report = cls.getAnnotation(Report.class);
if (report != null) {
   ...
}

读取方法、字段和构造方法的Annotation和Class类似。但要读取方法参数的Annotation就比较麻烦一点，因为方法参数本身可以看成一个数组，而每个参数又可以定义多个注解，所以，一次获取方法参数的所有注解就必须用一个二维数组来表示。例如，对于以下方法定义的注解：

public void hello(@NotNull @Range(max=5) String name, @NotNull String prefix) {
}

要读取方法参数的注解，我们先用反射获取Method实例，然后读取方法参数的所有注解：

// 获取Method实例:
Method m = ...
// 获取所有参数的Annotation:
Annotation[][] annos = m.getParameterAnnotations();
// 第一个参数（索引为0）的所有Annotation:
Annotation[] annosOfName = annos[0];
for (Annotation anno : annosOfName) {
    if (anno instanceof Range) { // @Range注解
        Range r = (Range) anno;
    }
    if (anno instanceof NotNull) { // @NotNull注解
        NotNull n = (NotNull) anno;
    }
}

4. 使用注解

注解如何使用，完全由程序自己决定。每个注解的功能都要根据自己业务决定。

下面以定义一个注解@Range，用于检查长度。int检查范围，String检查字符长度

1.使用@interface定义注解，并添加参数

把最常用的参数定义为value()，推荐所有参数都尽量设置默认值。

/** 
* @author hz 
* @date 2020/8/7 14:36 
*/
// 定义一个注解 

public @interface Range {    
    int min() default 0;   
    int max() default 255;
}

2. 用元注解配置注解

其中，必须设置@Target和@Retention，@Retention一般设置为RUNTIME，因为我们自定义的注解通常要求在运行期读取。一般情况下，不必写@Inherited和@Repeatable。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {    
    int min() default 0;    
    int max() default 255;
}

3. 通过反射定义业务

定义了注解，本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解。这里，我们编写一个Person实例的检查方法，它可以检查Person实例的String和int字段长度是否满足@Range的定义：

/**
 * @author hz
 * @date 2020/8/7 14:41
 */

// 定义了注解，本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解

    // 1. 通过反射获取所有属性
    // 2. 获取属性的注解， 如果注解存在，获取该属性的值
    // 3. 判断属性值是否合法

public class Check {


    public static void check(Person person){
        System.out.println("开始校验...");
        // 获取所有filed
        for (Field field : person.getClass().getDeclaredFields()) {
            field.setAccessible(true);
            if(field.isAnnotationPresent(Range.class)){
                Range range = field.getAnnotation(Range.class);
                // System.out.println(field.getName() + "=>最小值：" + range.min() + " 最大值: " + range.max());
                // 如果注解存在
                if (range != null) {
                    // 获取字段值
                    Object o = null;
                    try {
                        o = field.get(person);
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }
                    if (o instanceof String) {
                        String str = (String) o;
                        if (str.length() > range.max() || str.length() < range.min() ) {
                            throw new IllegalArgumentException("无效参数" + field.getName());
                        }
                    }
                    if (o instanceof Integer) {
                        int i = (int) o;
                        if (i > range.max() || i < range.min())
                            throw new IllegalArgumentException("无效参数" + field.getName());
                    }
                }
            }
        }
    }

}

在实体类Person使用注解@Range

/ 定义一个javaBean, 使用自定义注解 @Range

public class Person {

    @Range(min = 0, max = 100)
    private Integer age;

    @Range(min = 2, max = 8)
    private String name;

    public Person(int age, String name) {
        this.age = age;
        this.name = name;
    }
}

4. 测试注解

public class TestAnnotation {
    public static void main(String[] args) {
        Person person = new Person(110, "张三张三张三张三张三张三");
        Check.check(person);
        System.out.println(person);
    }
}