【Java】注解

Java注解

使用注解

编译器可以使用的注解：

• @Override：让编译器检查该方法是否正确地实现了覆写
• @Deprecated：告诉编译器该方法已经被标记为“作废”，引用它会提示横线 p.hello()
• @SuppressWarnings：让编译器忽略某些警告

---

定义注解

注解的参数类似于无参方法，可以用default设定一个默认值。最常用的参数应命名为value

元注解：可以修饰其他注解的注解

• @Target：定义Annotation可以被应用于源码的哪些位置（最常用）

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

  @Target({
          ElementType.METHOD,
          ElementType.FIELD
  })
  @interface Age{
      int value() default 18;
  }
  

• @Retention：定义Annotation的生命周期

  • RetentionPolicy.SOURCE： 在编译期就被丢掉了
  • RetentionPolicy.CLASS： 仅保存在class文件中，它们不会被加载进JVM （默认）
  • **RetentionPolicy.RUNTIME： 会被加载进JVM，并且在运行期可以被程序读取 **

通常我们自定义的Annotation都是RUNTIME，所以务必要加上：

@Retention(RetentionPolicy.RUNTIME)

• @Repeatable： 定义Annotation是否可重复（用的很少）

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

• @Inherited： 定义子类是否可继承父类定义的Annotation

定义Annotation的步骤：

1. 用@interface定义注解

@interface Age{
}

2. 添加参数、默认值

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

@interface Age{
    String level() default "teenager";
    int value() default 18;
}

3. 用元注解配置注解

必须设置@Target和@Retention，@Retention一般设置为RUNTIME，因为我们自定义的注解通常要求在运行期读取。

一般情况下，不必写@Inherited和@Repeatable。

@Target({ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@interface Age{
    String level() default "teenager";
    int value() default 18;
}

---

处理注解

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

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

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

2. 使用反射API读取Annotation

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

读取Annotation有两种方法：

1. 先判断Annotation是否存在，若存在就读取

Class cls = People.class;
if(cls.isAnnotationPresent(Ages.class)){
    Ages ages = cls.getAnnotation(Ages.class);
    ...
}

2. 直接读取Annotation，如果不存在就返回null

Class cls = People.class;
Ages ages = cls.getAnnotation(Ages.class);
if(ages != null){
    ...
}

使用注解

我们来看一个@Range注解，我们希望用它来定义一个String字段的规则：字段长度满足@Range的参数定义：

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

在某个JavaBean中，我们可以使用该注解：

public class Person {
    @Range(min=1, max=20)
    public String name;

    @Range(max=10)
    public String city;
}

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

void check(Person person) throws IllegalArgumentException, ReflectiveOperationException {
    // 遍历所有Field:
    for (Field field : person.getClass().getFields()) {
        // 获取Field定义的@Range:
        Range range = field.getAnnotation(Range.class);
        // 如果@Range存在:
        if (range != null) {
            // 获取Field的值:
            Object value = field.get(person);
            // 如果值是String:
            if (value instanceof String) {
                String s = (String) value;
                // 判断值是否满足@Range的min/max:
                if (s.length() < range.min() || s.length() > range.max()) {
                    throw new IllegalArgumentException("Invalid field: " + field.getName());
                }
            }
        }
    }
}

这样一来，我们通过@Range注解，配合check()方法，就可以完成Person实例的检查。注意检查逻辑完全是我们自己编写的，JVM不会自动给注解添加任何额外的逻辑。