快捷導(dǎo)航

Java Reflect如何利用反射獲取屬性上的注解

更新時間：2024年09月27日 08:49:59 作者：我一直在流浪

AnnotatedElement接口是Java反射機制的一部分,用于讀取運行中程序的注釋信息,通過getAnnotation、getAnnotations、isAnnotationPresent和getDeclaredAnnotations方法,可以訪問和判斷注解,Field類實現(xiàn)了該接口

1. AnnotatedElement接口

AnnotatedElement接口表示目前正在此 JVM 中運行的程序的一個已注釋元素，該接口允許反射性地讀取注釋。

調(diào)用AnnotatedElement對象的如下方法可以訪問Annotation信息：

getAnnotation(Class<T>annotationClass)：返回該程序元素上存在的指定類型的注釋，如果該類型的注釋不存在，則返回null。
Annotation[] getAnnotations()：返回此元素上存在的所有注釋。
boolean isAnnotationPresent(Class<?extendsAnnotation>annotationClass)：判斷該程序元素上是否存在指定類型的注釋，如果存在則返回true，否則返回false。
Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同，該方法將忽略繼承的注釋。

2. Field類實現(xiàn)了AnnotatedElement接口

3. 獲取屬性上的注解

① 自定義注解

@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD,ElementType.PARAMETER} )
public @interface MyParam1 {

    String value() default "";
}

@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD,ElementType.PARAMETER} )
public @interface MyParam2 {

    String value() default "";
}

② 給方法參數(shù)上添加注解

@ControllerAdvice
@Controller
@MyAnnotation(name = "李四",age=12)
public class Test {

    @MyField1("name1")
    @MyField2("name2")
    @Value("name")
    private String name;

    @MyField1("email1")
    @MyField2("email2")
    @Value("email")
    private String email;

}

③ 獲取屬性上的注解

public class Main {
    public static void main(String[] args) throws NoSuchMethodException, ClassNotFoundException {
        // 得到Class類對象
        Class<?> clazz = Class.forName("com.example.redislock.annotation.Test");

        // 獲取類的所有屬性
        Field[] fields = clazz.getDeclaredFields();

        // 獲取屬性上的所有注解
        int i = 1;
        for (Field field : fields) {
            System.out.println("第"+i+++"個屬性的注解有：");
            Annotation[] annotations = field.getAnnotations();
            for (Annotation annotation : annotations) {
                System.out.println(annotation.annotationType());
            }
        }

        // 獲取屬性上指定MyField2類型的注解
        System.out.println();
        System.out.println("獲取屬性上指定MyField2類型的注解:");
        for (Field field : fields) {
            MyField2 myField2 = field.getAnnotation(MyField2.class);
            System.out.println(myField2);
            System.out.println(myField2.value());
        }

        // 獲取屬性上指定MyField2類型的注解
        System.out.println();
        System.out.println("獲取屬性上指定MyField2類型的注解:");
        for (Field field : fields) {
            MyField2[] myField2s = field.getAnnotationsByType(MyField2.class);
            for (MyField2 myField2 : myField2s) {
                System.out.println(myField2);
            }
        }
    }
}