Java 加在类上面的注解获取方法的参数

原创

mob649e8154f2e5 2023-08-15 11:36:56 ©著作权

文章标签 java Java 获取参数 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e8154f2e5的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 加在类上的注解获取方法的参数

1. 简介

在Java开发中，我们经常会使用注解来描述类、方法、变量等信息。有时候，我们希望能够通过注解获取方法的参数，这样可以方便地进行参数校验、日志记录等操作。本文将介绍如何在Java中通过在类上添加注解来获取方法的参数。

2. 实现步骤

下面是实现的整体流程，我们可以通过一个表格来展示每个步骤需要做什么。

步骤	动作	代码示例
1.	定义注解	@interface ParamAnnotation {}
2.	添加注解到类上	@ParamAnnotation public class MyClass {}
3.	定义方法并添加参数注解	public void myMethod(@ParamAnnotation String param) {}
4.	通过反射获取注解信息	Annotation[] annotations = parameter.getAnnotations();

下面我们将逐步完成上述步骤。

3. 定义注解

首先，我们需要定义一个注解，用来标识方法参数。使用@interface关键字定义注解，并给注解添加一些元素，用来接收参数。

public @interface ParamAnnotation {
    String value() default "";
}

上述代码定义了一个名为ParamAnnotation的注解，并为注解添加了一个名为value的元素，该元素的默认值为空字符串。

4. 添加注解到类上

接下来，我们需要在需要获取参数的类上添加刚刚定义的注解。假设我们的类名为MyClass，则可以在类声明之前添加@ParamAnnotation注解。

@ParamAnnotation
public class MyClass {
    // ...
}

5. 定义方法并添加参数注解

接下来，我们需要在方法中定义需要获取参数的注解。假设我们的方法名为myMethod，参数名为param，则可以在参数前添加@ParamAnnotation注解。

public void myMethod(@ParamAnnotation String param) {
    // ...
}

6. 通过反射获取注解信息

现在，我们已经在类和方法上添加了注解。接下来，我们需要通过反射获取方法的参数注解。在方法内部，我们可以使用getAnnotations()方法获取参数的所有注解信息。

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

public class Main {
    public static void main(String[] args) {
        Method[] methods = MyClass.class.getMethods();
        for (Method method : methods) {
            Parameter[] parameters = method.getParameters();
            for (Parameter parameter : parameters) {
                Annotation[] annotations = parameter.getAnnotations();
                for (Annotation annotation : annotations) {
                    if (annotation instanceof ParamAnnotation) {
                        String value = ((ParamAnnotation) annotation).value();
                        System.out.println("Parameter: " + parameter.getName() + ", Value: " + value);
                    }
                }
            }
        }
    }
}

上述代码中，我们通过MyClass.class.getMethods()方法获取到类中的所有方法。然后，通过method.getParameters()方法获取到每个方法的参数。最后，通过parameter.getAnnotations()方法获取到参数的所有注解信息。我们遍历注解数组，找到我们定义的ParamAnnotation注解并获取注解的元素值。