一个注解搞定全局参数校验

心已赠人 2023-06-30 11:59 59阅读 0赞

一、引入maven依赖

  1. <dependencies>
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-web</artifactId>
  5.         </dependency>
  7.         <dependency>
  8.             <groupId>org.projectlombok</groupId>
  9.             <artifactId>lombok</artifactId>
  10.         </dependency>
  12.         <dependency>
  13.             <groupId>com.alibaba</groupId>
  14.             <artifactId>fastjson</artifactId>
  15.             <version>1.2.58</version>
  16.         </dependency>
  18.         <dependency>
  19.             <groupId>org.springframework.boot</groupId>
  20.             <artifactId>spring-boot-starter-aop</artifactId>
  21.         </dependency>
  23.         <dependency>
  24.             <groupId>org.apache.commons</groupId>
  25.             <artifactId>commons-lang3</artifactId>
  26.             <version>${commons-lang3.version}</version>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>commons-beanutils</groupId>
  31.             <artifactId>commons-beanutils</artifactId>
  32.             <version>1.9.3</version>
  33.         </dependency>
  35.     </dependencies>

二、自定义参数校验注解和异常

  1. /**
  2.  * @Author: guandezhi
  3.  * @Date: 2019/12/17 16:55
  4.  */
  5. @Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
  6. @Retention(RetentionPolicy.RUNTIME)
  7. @Documented
  8. public @interface ParamValidate {
  9. }
  11. /**
  12.  * @Author: guandezhi
  13.  * @Date: 2019/12/17 17:13
  14.  */
  15. public class ParamValidateException extends RuntimeException {
  17.     public ParamValidateException(String errorMsg) {
  18.         super(errorMsg);
  19.     }
  21.     public ParamValidateException(String errorMsg, Throwable e) {
  22.         super(errorMsg, e);
  23.     }
  24. }

三、定义参数校验切面

  1. /**
  2.  * 参数校验切面
  3.  *
  4.  * @Author: guandezhi
  5.  * @Date: 2019/12/17 15:07
  6.  */
  7. @Slf4j
  8. @Aspect
  9. @Component
  10. public class ParamValidateAspect {
  12.     @Resource
  13.     private LocalValidatorFactoryBean localValidatorFactoryBean;
  15.     /**
  16.      * 切入controller的方法参数加了自定义注解ParamValidate的方法
  17.      */
  18.     @Pointcut("execution(public * com.gdz.demo.controller.*." +
  19.             "*(@com.gdz.demo.annotation.ParamValidate (*),..)) ||" +
  20.             " execution(public * com.gdz.demo.controller.*." +
  21.             "*(..,@com.gdz.demo.annotation.ParamValidate (*)))")
  23.     public void webLog() {
  24.     }
  26.     @Before("webLog()")
  27.     public void before(JoinPoint joinPoint) throws Exception {
  28.         doBefore(joinPoint);
  29.     }
  31.     /**
  32.      * 参数校验
  33.      *
  34.      * @param joinPoint
  35.      */
  36.     private void doBefore(JoinPoint joinPoint) {
  37.         Object paramValue = getMethodParamValue(joinPoint);
  38.         if (paramValue != null) {
  39.             Set<ConstraintViolation<Object>> validErrors = this.localValidatorFactoryBean.validate(paramValue, new Class[]{Default.class});
  40.             Iterator iterator = validErrors.iterator();
  41.             StringBuilder errorMsg = new StringBuilder();
  43.             while (iterator.hasNext()) {
  44.                 ConstraintViolation constraintViolation = (ConstraintViolation) iterator.next();
  45.                 String error = constraintViolation.getPropertyPath() + ":" + constraintViolation.getMessage();
  46.                 errorMsg.append(iterator.hasNext() ? error + "; " : error);
  47.             }
  48.             if (!validErrors.isEmpty()) {
  49.                 throw new ParamValidateException(errorMsg.toString());
  50.             }
  51.         }
  52.     }
  55.     /**
  56.      * 获取加了自定义参数校验注解的参数值
  57.      *
  58.      * @param joinPoint
  59.      * @return
  60.      */
  61.     private Object getMethodParamValue(JoinPoint joinPoint) {
  62.         Object[] args = joinPoint.getArgs();
  63.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  64.         /*获取@ParamValidate注解*/
  65.         Annotation[][] parameterAnnotations = signature.getMethod().getParameterAnnotations();
  66.         if (parameterAnnotations != null) {
  67.             for (Annotation[] parameterAnnotation : parameterAnnotations) {
  68.                 int paramIndex = ArrayUtils.indexOf(parameterAnnotations, parameterAnnotation);
  69.                 for (Annotation annotation : parameterAnnotation) {
  70.                     if (annotation != null && annotation instanceof ParamValidate) {
  71.                         return args[paramIndex];
  72.                     }
  73.                 }
  74.             }
  75.         }
  76.         return null;
  77.     }
  78. }

四、全局捕获参数校验异常，并转换成自己想要的格式返回。

  1. /**
  2.  * @Author: guandezhi
  3.  * @Date: 2019/12/17 16:53
  4.  */
  5. @Slf4j
  6. @ControllerAdvice
  7. public class GlobalExceptionHandler {
  10.     @ResponseBody
  11.     @ExceptionHandler(value = Exception.class)
  12.     public ResultVo<Object> handleException(Exception e) {
  13.         String errorMsg = "";
  14.         ResultVo<Object> resultVo = new ResultVo<>();
  16.         if (e instanceof NullPointerException) {
  17.             errorMsg = "参数空指针异常";
  18.             resultVo.setResultCode(HttpCode.FAIL.getMsgCode());
  19.         } else if (e instanceof ParamValidateException) {
  20.             errorMsg = "请求参数匹配错误," + e.getLocalizedMessage();
  21.             resultVo.setResultCode(HttpCode.ILLEGAL_INPUT.getMsgCode());
  22.         } else {
  23.             errorMsg = e.getMessage();
  24.             resultVo.setResultCode(HttpCode.ERROR.getMsgCode());
  25.             log.error("系统异常：", e);
  26.         }
  27.         resultVo.setResultMsg(errorMsg);
  28.         return resultVo;
  29.     }
  30. }

五、测试一下：只需要在需要校验的参数旁边加上@ParamValidate 即可

  1. /**
  2.  * @Author: guandezhi
  3.  * @Date: 2020/1/17 15:04
  4.  */
  5. @Slf4j
  6. @RestController
  7. public class IndexController {
  9.     @PostMapping("/index")
  10.     public String test(@RequestBody @ParamValidate User user) {
  11.         return "success";
  12.     }
  13. }

其中User实体如下：

  1. /**
  2.  * @Author: guandezhi
  3.  * @Date: 2020/1/17 15:05
  4.  */
  5. @Data
  6. public class User {
  8.     @NotNull(message = "用户名不能为空")
  9.     private String userName;
  11.     @NotBlank
  12.     private String city;
  14.     @Min(value = 1, message = "年龄最小值不能小于1")
  15.     @Max(value = 99, message = "年龄最大值不能大于99")
  16.     private int age;
  18.     @Size(min = 1, max = 3, message = "别名不能少于1个，大于3个")
  19.     private List<String> alias;
  20. }

测试结果如下：

  1. {
  2.   "resultCode": 401,
  3.   "resultMsg": "请求参数匹配错误,alias:别名不能少于1个，大于3个; age:年龄最大值不能大于99; userName:用户名不能为空",
  4.   "data": null
  5. }

代码地址：https://github.com/dezhiguan/paramvalidate.git

发表评论

表情：
评论列表 （有 0 条评论，59人围观）

还没有评论，来说两句吧...

相关阅读

    相关 SpringBoot 注解校验参数

    在项目开发中我们经常会遇到各种参数校验，尤其是表单参数的校验。当参数不多时我们可以在控制器中手动校验，但是一旦遇到需要校验的参数较多的post接口时，还去一个个的校验的话那会累

    清疚清疚/ 0 赞/ 212 阅读