Java 注解怎么取方法入参的值

原创

mob649e81567471 2023-12-10 03:49:29 ©著作权

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

使用Java注解获取方法入参的值

问题描述

在开发Java应用程序的过程中，我们经常需要获取方法的入参值，并根据这些值进行相应的处理。但是，传统的方式可能需要手动编写获取入参值的代码，而且需要重复进行相同的操作，这样会增加代码的冗余度和维护成本。

解决方案

Java注解是一种在程序中添加元数据的方式，它可以用来给类、方法、字段等添加标记或者其他信息。通过使用Java注解，我们可以在方法上标记需要获取入参值的注解，然后通过反射机制来获取这些注解，并获取对应的入参值。下面是一个使用Java注解获取方法入参值的示例方案。

步骤

定义一个自定义注解@ParamValue，用于标记需要获取入参值的方法。

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.PARAMETER)
public @interface ParamValue {
    String value() default "";
}

在需要获取入参值的方法上使用@ParamValue注解，并设置对应的值。

public class UserService {
    public void saveUser(@ParamValue("name") String name, @ParamValue("age") int age) {
        // 业务逻辑处理
    }
}

创建一个工具类ParamValueUtils，用于获取方法入参值。

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

public class ParamValueUtils {
    public static Map<String, Object> getParamValues(Object object, Method method, Object[] args) {
        Map<String, Object> paramValues = new HashMap<>();
        Annotation[][] parameterAnnotations = method.getParameterAnnotations();
        for (int i = 0; i < parameterAnnotations.length; i++) {
            for (Annotation annotation : parameterAnnotations[i]) {
                if (annotation instanceof ParamValue) {
                    ParamValue paramValue = (ParamValue) annotation;
                    paramValues.put(paramValue.value(), args[i]);
                }
            }
        }
        return paramValues;
    }
}

在业务逻辑中调用ParamValueUtils.getParamValues方法获取方法入参值，并进行后续处理。

public class Main {
    public static void main(String[] args) throws NoSuchMethodException {
        UserService userService = new UserService();
        Method method = UserService.class.getMethod("saveUser", String.class, int.class);
        Object[] args = {"John", 18};
        Map<String, Object> paramValues = ParamValueUtils.getParamValues(userService, method, args);
        System.out.println(paramValues);
        // 输出：{name=John, age=18}
    }
}

序列图

下面是使用mermaid语法绘制的获取方法入参值的序列图：

sequenceDiagram
    participant Main
    participant UserService
    participant ParamValueUtils
    
    Main->>UserService: saveUser("John", 18)
    UserService->>ParamValueUtils: getParamValues()
    ParamValueUtils->>Main: {name=John, age=18}

旅行图

下面是使用mermaid语法绘制的获取方法入参值的旅行图：

journey
    title 获取方法入参值的旅行图
    section 定义注解
        UserService->ParamValue: @ParamValue("name")
        UserService->ParamValue: @ParamValue("age")
    section 使用注解
        UserService->>Main: saveUser("John", 18)
    section 获取入参值
        Main->>ParamValueUtils: getParamValues()
    section 处理入参值
        ParamValueUtils-->>Main: {name=John, age=18}