java注解

June 20, 2022

Java 注解是特殊的 interface
注解作用于：类、方法、字段、参数以及注解本身等等
Java 作为编译型解释语言，有的注解可以在编译时生效，有的可以在运行时生效
注解可以有参数及默认参数，参数必须为常量，且只能为：基本类型、String、Class 以及枚举的数组

注解的作用位置：

java

public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE,
    MODULE,
    RECORD_COMPONENT;
}

注解的生命周期：

java

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

声明注解

java

import java.lang.annotation.*;

public class Main {
    @AnnotationName("Example annotation value")
    // 等效于 @AnnotationName(value = "Example annotation value")
    public String str = "Hello";
}

// @Target 用于指定注解作用的位置。参数是ElementType[]，元素只有一个时可以省略数组写法
// @Target(ElementType.TYPE)
@Target({ // ElementType.TYPE, ElementType.METHOD, ElementType.FIELD,
          // ElementType.PARAMETER, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE,
          // ElementType.ANNOTATION_TYPE, ElementType.PACKAGE, ElementType.TYPE_PARAMETER,
          // ElementType.TYPE_USE
        ElementType.METHOD,
        ElementType.FIELD
})
// @Retention 用于指定注解的生命周期。参数默认为RetentionPolicy.CLASS，可选
// RetentionPolicy.SOURCE, RetentionPolicy.CLASS, RetentionPolicy.RUNTIME
@Retention(RetentionPolicy.RUNTIME)
// @Repeatable(AnnotationNames.class)
@Inherited // 允许子类继承父类的注解（子类继承父类时也同时使用了父类的注解）
@Documented // 允许被javadoc工具获取
// ... ...
@interface AnnotationName {
    int type() default 0; // 声明默认值，则在使用注解时可以不指定该值

    String level() default "info"; // 若无默认值，则必须指定，例如 @AnnotationName(type = 1, level = "Example")

    String value() default ""; // 参数名称是value，且只有一个参数（其它参数可为默认值），可以省略参数名称，例如 @AnnotationName("Value")
}

// 若 AnnotationName 指定 @Repeatable 则还需要定义 AnnotationNames 注解
// 其 @Retention 需指定为 RetentionPolicy.RUNTIME
// 修饰 AnnotationName 的许多注解也必须用于修饰 AnnotationNames
// 为了节省篇幅，下面没有重复指定与 AnnotationName 相同的注解
@Retention(RetentionPolicy.RUNTIME)
@interface AnnotationNames {
    AnnotationName[] value();
}

获取注解

下面只考虑 RUNTIME 类型的注解，需要使用反射 API 获取
注解的完整类名为 java.lang.annotation.Annotation

java

// 形式化语法，不是Java代码
class Class,Method,Field,Constructor {
    // 顾名思义，这个 annotationClass 就是注解对应的 Class 对象
    public <A extends Annotation> A getAnnotation(Class<A> annotationClass);
    public <T extends Annotation> T getAnnotation(Class<T> annotationClass);
}

example from https://www.liaoxuefeng.com/wiki/1252599548343744/1265102026065728

java

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


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

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


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());
                }
            }
        }
    }
}

←Back to home