如何使用反射获取注释类名称、属性值

2022-09-01 02:21:06

我知道如果我们知道注释类,我们可以很容易地获得特定的注释并访问其属性。例如:

field.getAnnotation(Class<T> annotationClass) 

这将返回特定注释接口的引用,因此您可以轻松访问其值。

我的问题是,如果我对特定的注释类没有预先了解。我只想使用反射在运行时获取所有注释类名及其属性,以便将类信息转储为 JSON 文件。我怎么能用一个简单的方式做到这一点。

Annotation[] field.getAnnotations();

此方法将仅返回注释接口的动态代理。


答案 1

与人们所期望的相反,注释的元素不是属性 - 它们实际上是返回提供的值或默认值的方法。

您必须循环访问批注的方法并调用它们以获取值。用于获取注释的类,返回的对象只是一个代理。annotationType()getClass()

下面是一个示例,它打印类的@Resource注释的所有元素及其值:

@Resource(name = "foo", description = "bar")
public class Test {

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

        for (Annotation annotation : Test.class.getAnnotations()) {
            Class<? extends Annotation> type = annotation.annotationType();
            System.out.println("Values of " + type.getName());

            for (Method method : type.getDeclaredMethods()) {
                Object value = method.invoke(annotation, (Object[])null);
                System.out.println(" " + method.getName() + ": " + value);
            }
        }

    }
}

输出:

Values of javax.annotation.Resource
 name: foo
 type: class java.lang.Object
 lookup: 
 description: bar
 authenticationType: CONTAINER
 mappedName: 
 shareable: true

感谢 Aaron 指出您需要强制执行 null 参数以避免警告。


答案 2

只是为了跟进上面的答案(我没有足够的代表来回复它):

method.invoke(annotation, null)

应更改为以下内容,否则将引发异常:

method.invoke(annotation, (Object[])null) or method.invoke(annotation, new Object[0])