Java 反射读取注解信息

在 Java 中，反射机制允许程序在运行时检查和操作类、方法、字段等。注解则是 Java 提供的一种元数据机制，用于为代码添加额外的信息。在 Java 开发领域，大量框架借助反射来读取注解信息，以此实现各种强大的功能。

例如 Spring 框架中的 @Service、@Repository、@Controller 等注解。Spring 在启动时会扫描指定包路径下的类，利用反射检查类上是否存在 @Service、@Repository、@Controller 等注解。当发现这些注解时，Spring 会将这些类注册为 Bean 并进行管理，实现依赖注入和组件扫描的功能。

下面是一个完整的示例，展示如何通过反射读取注解中的信息。

步骤：

1. 定义注解：创建一个自定义注解，用于存储需要的信息。
2. 使用注解：在类、方法或字段上使用自定义注解。
3. 通过反射读取注解信息：使用 Java 的反射机制获取类、方法或字段上的注解，并读取其中的信息。

定义注解

package org.example.reflect;

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.METHOD)
@interface MyAnnotation {
    String value() default "default value";
    int number() default 0;
}

• @Retention(RetentionPolicy.RUNTIME)：指定注解的保留策略为运行时，这样在运行时可以通过反射获取注解信息。
• @Target(ElementType.METHOD)：指定注解的使用范围为方法。
• 注解中定义了两个属性：value 和 number，并为它们设置了默认值。

使用注解

class MyClass {
    @MyAnnotation(value = "Hello, Reflection!", number = 123)
    public void myMethod() {
        System.out.println("This is my method.");
    }
}

在 myMethod 方法上使用了 MyAnnotation 注解，并为 value 和 number 属性指定了具体的值。

通过反射读取注解信息

package org.example.reflect;

import java.lang.reflect.Method;

public class AnnotationReflectionExample {
    public static void main(String[] args) {
        try {
            // 获取 MyClass 的 Class 对象
            Class<?> clazz = MyClass.class;

            // 获取 myMethod 方法
            Method method = clazz.getMethod("myMethod");

            // 检查方法上是否存在 MyAnnotation 注解
            if (method.isAnnotationPresent(MyAnnotation.class)) {
                // 获取 MyAnnotation 注解实例
                MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);

                // 读取注解中的信息
                String value = annotation.value();
                int number = annotation.number();

                // 输出注解信息
                System.out.println("Annotation value: " + value);
                System.out.println("Annotation number: " + number);
            } else {
                System.out.println("MyAnnotation is not present on myMethod.");
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
    }
}

• 通过 Class.forName() 或直接使用 MyClass.class 获取 MyClass 的 Class 对象。
• 使用 getMethod() 方法获取 myMethod 的 Method 对象。
• 使用 isAnnotationPresent() 方法检查方法上是否存在 MyAnnotation 注解。
• 如果存在，使用 getAnnotation() 方法获取注解实例，并读取其中的信息。

运行上述代码，输出结果如下：

Annotation value: Hello, Reflection!
Annotation number: 123

这表明通过反射成功读取了注解中的信息。