在Java中如何检查当前方法的参数是否有注释并检索该参数值？

Question

考虑这段代码：

public example(String s, int i, @Foo Bar bar) {
  /* ... */
}

我想检查该方法是否有注释 @Foo 并获取参数，如果没有找到 @Foo 注释则抛出异常。

我当前的方法是首先获取当前方法，然后迭代参数注释：

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

class Util {

    private Method getCurrentMethod() {
        try {
            final StackTraceElement[] stes = Thread.currentThread().getStackTrace();
            final StackTraceElement ste = stes[stes.length - 1];
            final String methodName = ste.getMethodName();
            final String className = ste.getClassName();   
            final Class<?> currentClass = Class.forName(className);
            return currentClass.getDeclaredMethod(methodName);
        } catch (Exception cause) {
            throw new UnsupportedOperationException(cause);
        }  
    }

    private Object getArgumentFromMethodWithAnnotation(Method method, Class<?> annotation) {
        final Annotation[][] paramAnnotations = method.getParameterAnnotations();    
            for (Annotation[] annotations : paramAnnotations) {
                for (Annotation an : annotations) {
                    /* ... */
                }
            }
    }

}

这是正确的方法还是有更好的方法？ forach 循环内的代码是什么样的？我不确定我是否理解了 getParameterAnnotations 实际返回的内容......

Answer 1

外部 for 循环

for (Annotation[] annotations : paramAnnotations) {
   ...
}

应该使用显式计数器，否则您不知道现在正在处理什么参数

final Annotation[][] paramAnnotations = method.getParameterAnnotations();
final Class[] paramTypes = method.getParameterTypes();
for (int i = 0; i < paramAnnotations.length; i++) {
    for (Annotation a: paramAnnotations[i]) {
        if (a instanceof Foo) {
            System.out.println(String.format("parameter %d with type %s is annotated with @Foo", i, paramTypes[i]);
        }
    }
}

还要确保您的注释类型用 @Retention(RetentionPolicy.RUNTIME) 注释

从您的问题来看不完全清楚你想做什么。我们同意形式参数与实际参数的区别：

void foo(int x) { }

{ foo(3); }

其中 x 是参数，3 是参数？

不可能通过反射获取方法的参数。如果可能的话，您必须使用 sun.unsafe 包。不过我不能告诉你太多。

Answer 2

如果您正在寻找方法上的注释，您可能需要 method.getAnnotations() 或 method.getDeclaredAnnotations()。

method.getParameterAnnotations() 调用为您提供方法的形式参数的注释，而不是方法本身的注释。

回头看一下问题标题，我怀疑您正在寻找参数的注释，而我没有在问题的内容中阅读这些注释。如果是这样，您的代码看起来没问题。

请参阅 方法 Javadoc 和 AnnotatedElement Javadoc。

Answer 3

getParameterAnnotations 返回一个数组，其长度等于方法参数的数量。该数组中的每个元素都包含一个 注释数组< /a> 该参数。
因此，getParameterAnnotations()[2][0] 包含第三个 ([2]) 参数的第一个 ([0]) 注释。

如果您只需要检查至少一个参数是否包含特定类型的注释，则该方法可能如下所示：

private boolean isAnyParameterAnnotated(Method method, Class<?> annotationType) {
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();    
    for (Annotation[] annotations : paramAnnotations) {
        for (Annotation an : annotations) {
            if(an.annotationType().equals(annotationType)) {
                return true;
            }
        }
    }
    return false;
}