Java增加自定义注解校验入参

秒速五厘米 2023-10-09 17:25 35阅读 0赞

![format_png][]

也许这是个很基础的命题，之前只是看到可以这样操作，并没有自己操作过，也并不理解每一步的意义，这次有机会实操一下，还是决定记录下来。

## 背景 ##

客户使用我们系统的时候，查询**不带任何查询条件**，查询就返回**全部数据**，500多万条数据啊，然后直接**导出**，数据量庞大，接口超时，这可苦了我们这些开发人员，**一边优化**，**一边挨喷**。这么多数据就算导成功了，Excel也打不开呀。迫不得已，决定**强制让客户至少传入一个参数进行查询来缓解服务器以及开发人员的压力**。

首先想到的，最简单的，就是增加一个静态方法，在每个方法入口调一下，来校验以及抛出错误。但是转念一想，更优美的解决方案是在调用的方法上加一个注解，使用注解来完成这个功能，这岂不是很棒。

再一句话说下需求：

> 增加注解对入参进行校验，保证至少有一个参数不为空，若是有时间参数，则起始时间和结束时间之间的距离不能超过30天。

## 接下来，Show Time ##

### 注解类： ###

这里有三个参数，分别是三个参数名称，`起始时间参数名称`，`结束时间参数名称`，`需要校验的参数名称`

@Target({ElementType.PARAMETER, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface VerifyParameters {
        /**
         * 起始时间参数名称
         */
        String startTimeParamName() default "startTime";
        /**
         * 结束时间参数名称
         */
        String endTimeParamName() default "endTime";
    
        /**
         * 需要校验的参数名称
         */
        String paramName() default "";
    }
    复制代码

### 注解的Aspect类 ###

这里贴一个完整的，目的是有的小伙伴想用的话，贴过去就能用。

@Component
    @Aspect
    public class VerifyParametersAspect {
    
        private static final Logger logger = LoggerFactory.getLogger(VerifyParametersAspect.class);
    
        /**
         * 切点
         */
        @Pointcut("@annotation(com.guava.mall.app.annotation.VerifyParameters)")
        public void serviceAspect() {
        }
    
    
        /**
         * service 方法前调用
         *
         * @param joinPoint
         */
        @Before("serviceAspect()")
        public void doBeforeService(JoinPoint joinPoint) {
            try {
    
                //获取方法参数名
                MethodSignature signature = (MethodSignature) joinPoint.getSignature();
                //获取方法
                Method method = signature.getMethod();
                //获取参数名
                LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
                String[] parameterNames = u.getParameterNames(method);
                Map<String, Object> params = new HashMap<>(8);
                params = getParamMap(joinPoint, method, parameterNames, params);
                //获取注解
                VerifyParameters verifyParameters = method.getAnnotation(VerifyParameters.class);
    
                //参数名
                String paramName = verifyParameters.paramName();
                Object o = params.get(paramName);
                ValidationUtils.validate(o == null, "参数不能为空");
                ValidationUtils.validate(!atLeastOnePropertyNotNull(o), "请至少输入一个查询条件进行查询和导出");
                //开始时间和结束时间的参数名
                String s = verifyParameters.startTimeParamName();
                String e = verifyParameters.endTimeParamName();
                Map<?, ?> map = JSONUtils.bean2Map(o);
                Object startTime = map.get(s);
                Object endTime = map.get(e);
                if (startTime != null || endTime != null) {
                    ValidationUtils.validate(startTime == null || endTime == null, "开始时间和结束时间必须同时存在");
                    ValidationUtils.validate(Integer.parseInt(String.valueOf(endTime)) - Integer.parseInt(String.valueOf(startTime)) > 30 * 24 * 60 * 60, "时间间隔不能超过一个月");
                }
            } catch (NumberFormatException ex) {
                logger.error(ex.getMessage(), ex);
            }
    
        }
    
        private Map<String, Object> getParamMap(JoinPoint joinPoint, Method method, String[] parameterNames, Map<String, Object> params) {
    
            int i = 0;
            if (parameterNames != null && parameterNames.length > 0) {
                for (String parameterName : parameterNames) {
                    params.put(parameterName, joinPoint.getArgs()[i]);
                    i++;
                }
            }
            return params;
        }
    
        public static boolean atLeastOnePropertyNotNull(Object obj) {
            for (Field field : obj.getClass().getDeclaredFields()) {
                //忽略serialVersionUID
                if ("serialVersionUID".equals(field.getName())) {
                    continue;
                }
                field.setAccessible(true);
                try {
                    if (field.get(obj) != null && !field.get(obj).toString().isEmpty()) {
                        return true;
                    }
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
            return false;
        }
        /**
         * 方法后调用
         */
        @After("serviceAspect()")
        public void doAfterInService(JoinPoint joinPoint) {
        }
    
    }
    复制代码

#### 然后，解释一下 ####

MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    复制代码

这是我们的第一行代码，这里的joinPoint对象表示**应用建议的程序执行点**，getSignature()方法则会返回正在执行的方法的**方法签名**，签名里就包含了该**方法名称**、**返回类型**和**参数类型**。然后再强制转换成`MethodSignature`对象，便于访问方法相关的信息。

> MethodSignature是一个对象，它表示正在执行的方法的签名，包括方法名称、返回类型和参数类型。它是Spring AOP框架中的一个类，用于在切面中获取方法的信息。

Method method = signature.getMethod();获取方法
    复制代码

这个则是从MethodSignature中获取到了正在执行的方法信息。

LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
    复制代码

> LocalVariableTableParameterNameDiscoverer是一个类，它可以用于在运行时获取方法参数的名称。它是Spring框架中的一个类，通常与反射一起使用，以便在运行时获取有关方法参数的信息。

通过 `String[] parameterNames = u.getParameterNames(method);` 可以获取到目前方法的入参名称。

`getParamMap();` 方法则会返回一个key是参数名称，value是参数本身的map对象。 我们可以从中取出我们需要的那个参数对象。

VerifyParameters verifyParameters = method.getAnnotation(VerifyParameters.class);
    复制代码

上边这行代码则会获取到方法上注解的**注解对象本身**，和我们**传入的参数值**，因为每个方法的入参不尽相同，里边时间的字段也不尽相同，需要主动传入来做处理。

这里再解释下`atLeastOnePropertyNotNull()`方法，这个方法的作用是判断参数内的属性是否至少有一个不为空，这里我们忽略了`serialVersionUID`。

> serialVersionUID是Java中的一个序列化机制，用于在反序列化期间验证发送方和接收方的对象是否具有兼容的序列化版本。如果发送方和接收方的serialVersionUID不同，则反序列化将失败。如果未指定serialVersionUID，则Java运行时将根据类的特定方面自动生成它。

之后的方法就很简单了，拿出值根据我们的需要做处理即可

### controller ###

再看看是如何使用的吧，添加`@VerifyParameters`注解，传入时间的属性名称，和需要校验的参数名称，这里传入参数名称的原因是，可能和我这里一样还有其他的参数影响，而我们只想校验我们需要的参数。

@ApiOperation(value = "查询列表")
    @GetMapping("/test")
    @VerifyParameters(startTimeParamName = "beginTime", endTimeParamName = "endTime",paramName = "orderRequest")
    public Page<Map<String, Object>> findOrderTestList(Pageable pageable, ERPOrderRequest orderRequest) {
        log.info("模拟逻辑处理");
        return null;
    }
    复制代码

这样我们就实现了通过一个自定义注解对方法的入参进行了校验，在取到入参和方法的各个值之后，我们其实可以做各种各样的操作，各位小伙伴可以任意发挥。

[format_png]: https://img-blog.csdnimg.cn/img_convert/927856517e4c92d36cf30bb7374e6632.webp?x-oss-process=image/format,png