Java 注解

注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”

注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”。

目录

1. 注解的作用

2. 定义注解

3. 处理注解

4. 使用注解

---

1. 注解的作用

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

Java的注解可以分为三类：

第一类是由编译器使用的注解，例如：

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

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

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

第三类是在程序运行期能够读取的注解，它们在加载后一直存在于JVM中，这也是最常用的注解。例如，一个配置了@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。

2. 定义注解

package com.learn.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {

    int min() default 0;
    int max() default 255;
}

Java语言使用@interface语法来定义注解（Annotation）

元注解

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

1.）@Target

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

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

2.）@Retention

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

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

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

3.）@Repeatable

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

4.）@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)

例如

// 判断@Range是否存在于Person类:
Person.class.isAnnotationPresent(Range.class);

使用反射API读取Annotation：

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

例如：

// 获取Person定义的@Range注解:
Range range = Person.class.getAnnotation(Range.class);
int min = range.min();

4. 使用注解

package com.learn.annotation;

public class Person {

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

    @Range(max=10)
    public String city;

    @Range(min=1,max=100)
    public int age;

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

    @Override
    public String toString() {
        return String.format("{Person: name=%s, city=%s, age=%d}",name,city,age);
    }
}

 

package com.learn.annotation;

import java.lang.reflect.Field;

public class Test {

    static void check(Person person) throws IllegalAccessException {
        for(Field field:person.getClass().getFields()){
            Range range=field.getAnnotation(Range.class);
            if(range!=null){
                Object value=field.get(person);
                if(value instanceof String){
                    String s= (String) value;
                    if(s.length()<range.min()||s.length()>range.max()){
                        throw new IllegalArgumentException("Invalid field: "+field.getName());
                    }
                }
                if(value instanceof Integer){
                    int i= (int) value;
                    if(i<range.min()||i>range.max()){
                        throw new IllegalArgumentException(("invalid field: "+field.getName()));
                    }
                }
            }
        }
    }

    public static void main(String[] args) throws IllegalAccessException {

        Person person=new Person("aaa","shanghai",20);
        Person person2=new Person("bbb","shanghaihuangpujiangpan",2);
        Person person3=new Person("ccc","shanghai",666);

        for(Person p:new Person[]{person,person2,person3}){
            try{
                check(p);
                System.out.println("person "+p+" checkd ok");
            }catch (IllegalArgumentException e){
                System.out.println("person "+p+" checkd failed: "+e);

            }
        }

    }
}

 

注：

1. 注解（Annotation）是Java语言用于工具处理的标注：

注解可以配置参数，没有指定配置的参数使用默认值；

如果参数名称是value，且只有一个参数，那么可以省略参数名称。

2. Java使用@interface定义注解：

可定义多个参数和默认值，核心参数使用value名称；

必须设置@Target来指定Annotation可以应用的范围；

应当设置@Retention(RetentionPolicy.RUNTIME)便于运行期读取该Annotation。

3. 可以在运行期通过反射读取RUNTIME类型的注解，注意千万不要漏写@Retention(RetentionPolicy.RUNTIME)，否则运行期无法读取到该注解。

可以通过程序处理注解来实现相应的功能：

• 对JavaBean的属性值按规则进行检查；
• JUnit会自动运行@Test标记的测试方法。

4. Annotation