Spring Boot + validation + AOP 请求参数校验

一、validation 校验注解

通用

@Null 被注释的属性必须为 null
@NotNull被注释的属性必须不为 null
@AssertTrue 被注释的属性必须为 true
@AssertFalse 被注释的属性必须为 false

字符串/数组/集合检查：(字符串本身就是个数组)

@Pattern(regexp="reg") 验证字符串满足正则
@Size(max, min) 验证字符串、数组、集合长度范围
@NotEmpty 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格

数值检查：同时能验证一个字符串是否是满足限制的数字的字符串

@Min(value) 被注释的属性必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的属性必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的属性必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)被注释的属性必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的属性的大小必须在指定的范围内
@Digits(integer, fraction) 被注释的属性必须是一个数字，其值必须在可接受的范围内
@Pattern(regex=,flag=) 被注释的属性必须符合指定的正则表达式

日期检查：Date/Calendar

@Past 限定一个日期，日期必须是过去的日期
@Future 限定一个日期，日期必须是未来的日期

Hibernate Validator 附加的 constraint

@Email 被注释的属性必须是电子邮箱地址
@Length(min=,max=)被注释的字符串的大小必须在指定的范围内
@Range(min=,max=,message=) 被注释的属性必须在合适的范围内

二、依赖

<!-- 包含有 validation 依赖-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- aop 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

三、代码实例

1.`SpmkApproveSummaryDto.java` 用 validation 校验


import java.util.List;

import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

import cn.hutool.json.JSONObject;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 审批汇总
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class SpmkApproveSummaryDto{

	@NotBlank(message = "title为空")
	@ApiModelProperty(value = "标题 ", example = "标题", required = true)
	private String title;

	@NotBlank(message = "approveName为空")
	@ApiModelProperty(value = "审批名称 ", example = "审批名称", required = true)
	private String approveName;

	@NotBlank(message = "initiator为空")
	@ApiModelProperty(value = "发起人名称 ", example = "发起人名称", required = true)
	private String initiator;
	
	@NotNull(message = "assoType为空")
	@DecimalMax(value = "9",message = "assoType 只能为 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪")
	@DecimalMin(value = "0",message = "assoType 只能为 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪")
	@ApiModelProperty(value = "关联类型 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪", example = "1")
	private Integer assoType;
	
	@NotNull(message = "requestData为空")
	@ApiModelProperty(value = "申请数据 ", example = "申请数据", required = true)
	private JSONObject requestData;

	@NotNull(message = "froms为空")
	@ApiModelProperty(value = "审批表单 ", example = "数组", required = true)
	private List<JSONObject> froms;

	@NotNull(message = "router为空")
	@ApiModelProperty(value = "审批流程", example = "审批流程", required = true)
	private Router router;

}

2.`ValidationError.java` 校验错误提示类


import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ValidationError {

	private String field;
	
	private String msg;
	
}

3.controller类

/**
 * 发起审批
 * @throws Exception 
 */
@PostMapping(value = "/start_approval")
public Result<Object> saveCa(@Valid @RequestBody SpmkApproveSummaryDto spmkApproveSummaryDto,BindingResult bindingResult) throws Exception{
	// 判断校验结果 bindingResult，hasErrors 为 true 则解析 返回给前端 校验错误提示信息
	if(bindingResult != null && bindingResult.hasErrors()){
      List<ObjectError> ls = bindingResult.getAllErrors();
      	 // 创建List 存放 校验错误提示信息
         List<ValidationError> listVe = new ArrayList<ValidationError>();
         ValidationError ve;
         for (ObjectError one : ls) {
         	String fieldString = one.getCodes().length >= 1 ? one.getCodes()[0] : "";
         	if (fieldString != null) {
         		fieldString = fieldString.substring(fieldString.lastIndexOf(".") + 1);
			}
         	ve = ValidationError.builder().field(fieldString).msg(one.getDefaultMessage()).build();
         	listVe.add(ve);
         }
         // 返回 校验校验错误提示信息
         return ResultUtil.error(listVe);
     }
	// 业务逻辑省略
	// ...
}

3.1.调试

3.2.校验失败返回数据

{
  "code": "400",
  "data": [
    {
      "field": "assoType",
      "msg": "assoType为空"
    },
    {
      "field": "title",
      "msg": "title为空"
    }
  ],
  "message": "参数错误",
  "result": true,
  "timestamp": 1588867983720
}

@Valid和BindingResult配套使用，@Valid用在参数前，BindingResult作为校验结果绑定返回
后端通过对 BindingResult 校验结果的再次解析和封装为 ValidationError列表再返回给客户端
如果不设置 BindingResult 参数, 校验失败后后端会直接返回BindingResult校验结果,错误提示有冗余

4.不设置 BindingResult 参数

/**
 * 发起审批
 * @throws Exception 
 */
@PostMapping(value = "/start_approval")
public Result<Object> saveCa(@Valid @RequestBody SpmkApproveSummaryDto spmkApproveSummaryDto) throws Exception{
	// ...
	// 业务逻辑省略
	// ...
}

4.1.调试

4.2.校验失败返回数据

{
  "timestamp": "2020-05-08 00:18:13",
  "status": 400,
  "error": "Bad Request",
  "errors": [
    {
      "arguments": [
        {
          "code": "title",
          "codes": [
            "spmkApproveSummaryDto.title",
            "title"
          ],
          "defaultMessage": "title"
        }
      ],
      "bindingFailure": false,
      "code": "NotBlank",
      "codes": [
        "NotBlank.spmkApproveSummaryDto.title",
        "NotBlank.title",
        "NotBlank.java.lang.String",
        "NotBlank"
      ],
      "defaultMessage": "title为空",
      "field": "title",
      "objectName": "spmkApproveSummaryDto"
    },
    {
      "arguments": [
        {
          "code": "assoType",
          "codes": [
            "spmkApproveSummaryDto.assoType",
            "assoType"
          ],
          "defaultMessage": "assoType"
        }
      ],
      "bindingFailure": false,
      "code": "NotNull",
      "codes": [
        "NotNull.spmkApproveSummaryDto.assoType",
        "NotNull.assoType",
        "NotNull.java.lang.Integer",
        "NotNull"
      ],
      "defaultMessage": "assoType为空",
      "field": "assoType",
      "objectName": "spmkApproveSummaryDto"
    }
  ],
  "message": "Validation failed for object='spmkApproveSummaryDto'. Error count: 2",
  "path": "/spmk/start_approval"
}

四、AOP切面处理 BindingResult 校验结果

1.`BindingResultAspect.java`(定义切面类，加上@Component @Aspect这两个注解)

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.validation.BeanPropertyBindingResult;
import org.springframework.validation.ObjectError;

import com.alibaba.fastjson.JSONObject;

import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.core.lang.Console;
import cn.hutool.core.util.ClassUtil;
import cn.timer.api.aspect.lang.annotation.BindingResultCtrol;
import cn.timer.api.aspect.lang.bean.ValidationError;
import cn.timer.api.utils.ResultUtil;

/**
 * 校验信息返回
 * 
 * @author TZQ
 */
@Aspect
@Component
public class BindingResultAspect {

    // execution 配置织入点 -匹配 cn.timer.api.controller 包下的所有子包的类的方法
    @Pointcut("execution(* cn.timer.api.controller.*.*.*(..))")
    public void clazzPointCut(){
    }
    
    @Around("clazzPointCut()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        Long startTime = System.currentTimeMillis();
        Object retVal;
        Object[] objs = joinPoint.getArgs();
        List<Object> listObj = CollectionUtil.toList(objs);
        // 从 joinPoint 中 取得 BeanPropertyBindingResult的对象 (相当与上面的 bindingResult)
        BeanPropertyBindingResult optional = (BeanPropertyBindingResult)listObj.stream()
	        .filter(p -> "BeanPropertyBindingResult".equals(ClassUtil.getClassName(p, true)))
	        .findFirst()
	        .orElse(null);
	    // 把 controller 方法里 对bindingResult的解析逻辑 迁移到这来做统一处理，这样每个被 切点 clazzPointCut() 匹配的方法都会做 一下处理
        if(optional != null && optional.hasErrors()){
            List<ObjectError> ls = optional.getAllErrors();
            List<ValidationError> listVe = new ArrayList<ValidationError>();
            ValidationError ve;
            for (ObjectError one : ls) {
            	String fieldString = one.getCodes().length >= 1 ? one.getCodes()[0] : "";
            	if (fieldString != null) {
            		fieldString = fieldString.substring(fieldString.lastIndexOf(".") + 1);
				}
            	ve = ValidationError.builder().field(fieldString).msg(one.getDefaultMessage()).build();
            	listVe.add(ve);
            	
            }
            retVal = ResultUtil.error(listVe);
        }else {
            retVal = joinPoint.proceed(joinPoint.getArgs());
        }
        Console.log("返回内容 {}: " ,JSONObject.toJSONString(retVal));
        Long endtime = System.currentTimeMillis();
        Console.log("执行耗时为{}：" ,endtime-startTime + "ms");

        return retVal;
    }
}

2.简要说明

@Aspect(切面)
通常是一个类，里面可以定义切入点和通知
@Pointcut (切点)
配置切入点Pointcut的几种方式: 例
- 当切入点为所有的public方法时： execution(public**(…))
- 当切入点为所有的set开始方法时：execution(set(…))
- 当切入点为xxx类种所有的方法时：execution(xxx(…))
- 当切入点为com.abc包下所有的方法时：execution(*com.abc…(…))
- 当切入点为com.abc包及其子包下面所有的方法时:execution(*com.abc…(…))
@Befor（前置通知）
在方法调用之前调用
@After（后置通知）
在方法返回之后调用
@Afterthrow
在方法出现异常后调用
@Around
环绕通知

3.效果一样返回校验错误提示

感谢

感谢您的阅读，有收获？希望兄弟姐妹三叔六婶大姨大妈阿公阿婆来个三连击，给更多的同学看到这篇文章，感谢

你的每一次回眸都是永恒，每一次鼓励都是我前进的动力，每一次分享都是对我的认可。

Spring Boot + validation + AOP 请求参数校验

Spring Boot + validation + AOP 请求参数校验

一、validation 校验注解

通用

字符串/数组/集合检查：(字符串本身就是个数组)

数值检查：同时能验证一个字符串是否是满足限制的数字的字符串

日期检查：Date/Calendar

Hibernate Validator 附加的 constraint

二、依赖

三、代码实例

1.`SpmkApproveSummaryDto.java` 用 validation 校验

2.`ValidationError.java` 校验错误提示类

3.controller类

3.1.调试

3.2.校验失败返回数据

4.不设置 BindingResult 参数

4.1.调试

4.2.校验失败返回数据

四、AOP切面处理 BindingResult 校验结果

1.`BindingResultAspect.java`(定义切面类，加上@Component @Aspect这两个注解)

2.简要说明

3.效果一样返回校验错误提示

感谢

感谢您的阅读，有收获？希望兄弟姐妹三叔六婶大姨大妈阿公阿婆来个三连击，给更多的同学看到这篇文章，感谢

eclipse-lombok插件

學不會你來砍我！spring boot 整合 mybatis-plus

nrm安裝與配置-提高install速度

eclipse idea 大小寫切換快捷鍵

Windows / Linux 解決進程端口占用問題！

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

Spring Boot + validation + AOP 请求参数校验

Spring Boot + validation + AOP 请求参数校验

一、validation 校验注解

通用

字符串/数组/集合检查：(字符串本身就是个数组)

数值检查：同时能验证一个字符串是否是满足限制的数字的字符串

日期检查：Date/Calendar

Hibernate Validator 附加的 constraint

二、依赖

三、代码实例

1.SpmkApproveSummaryDto.java 用 validation 校验

2.ValidationError.java 校验错误提示类

3.controller类

3.1.调试

3.2.校验失败 返回数据

4.不设置 BindingResult 参数

4.1.调试

4.2.校验失败 返回数据

四、AOP切面 处理 BindingResult 校验结果

1.BindingResultAspect.java(定义切面类，加上@Component @Aspect这两个注解)

2.简要说明

3.效果一样 返回校验错误提示

感谢

感谢您的阅读，有收获？希望兄弟姐妹三叔六婶大姨大妈阿公阿婆来个三连击，给更多的同学看到 这篇文章，感谢

1.`SpmkApproveSummaryDto.java` 用 validation 校验

2.`ValidationError.java` 校验错误提示类

3.2.校验失败返回数据

4.2.校验失败返回数据

四、AOP切面处理 BindingResult 校验结果

1.`BindingResultAspect.java`(定义切面类，加上@Component @Aspect这两个注解)

3.效果一样返回校验错误提示

感谢您的阅读，有收获？希望兄弟姐妹三叔六婶大姨大妈阿公阿婆来个三连击，给更多的同学看到这篇文章，感谢