Spring MVC后端参数校验

Spring MVC后端参数校验

Spring MVC后端参数校验

• 一、相关概念
• • 1.为什么要进行统一参数校验
  • 2. 统一参数校验框架
  • 3. 统一参数校验基本流程
  • 4. @Validated 和 @Valid 的区别
• 二、不同类型参数校验举例
• • 1. 简单参数校验
  • 2. 嵌套校验
  • 3. 分组校验
  • 4. 自定义校验
  • 5. 多属性交叉校验

一、相关概念 1.为什么要进行统一参数校验

  通常为保证接口的安全性，后端接口需要对入参进行合法性校验，如所填参数是否为空、参数长度是否在规定范围内、手机号或邮箱是否为正确格式等。因此，不可避免在业务代码中进行手动校验，但这种方式使得代码臃肿，可读性差。在Spring中提供了统一参数校验框架，将校验逻辑与业务逻辑进行隔离，进而优雅处理这个问题，简化开发人员负担

2. 统一参数校验框架

  在Spring中，其自身不仅拥有独立的参数校验框架，还支持符合JSR303标准的框架。JSR303是java为Bean数据合法性校验提供的标准框架，通过在Bean属性上标注注解，来设置对应的校验规则，下表展示JSR303部分注解

注解说明@Null被注释元素必须为null@NotNull被注释元素必须不为null@Max（value）被注释元素必须是一个数字，且值必须小于等于指定最大值@Size（max,min）被注释元素的大小在指定范围内@Pattern（value）被注释元素必须符合指定的正则表达式

  Spring本身并没有提供JSR303标准的实现，在使用JSR303参数校验时，需要引入具体的第三方实现。 Hibernate Validator是一个符合JSR303标准的官方参考实现，除支持以上所有标准注解外，它还支持以下的扩展注解

注解说明@Email被注释元素必须是电子邮箱地址@Length被注释字符串大小必须在指定范围内@NotEmpty被注释字符串必须非空@Range被注释元素必须在合适范围内

  当然，若以上校验注解均无法满足实际校验需求，可以通过实现ConstraintValidator接口，来自定义注解和校验规则。

3. 统一参数校验基本流程

• 首先需要在Spring容器中创建一个LocalValidatorFactoryBean（SpringBoot会自动装配好一个LocalValidateFactoryBean）
• 然后在已标注校验注解的入参bean对象前加上一个@Valid，表明需要被校验，当Spring MVC框架将请求参数绑定到该bean对象后，交由spring校验框架进行处理
• 根据注解声明的校验规则进行校验，若不合法抛出javax.validation.ConstraintViolationException异常。另外也可将校验的结果保存到随后的入参中，入参必须是BindingResult或Errors类型，并通过对应方法获取到校验失败的字段及信息（需要被校验的入参bean对象和接收校验结果的对象是成对出现，它们之间不允许声明其它入参）
  
  

4. @Validated 和 @Valid 的区别

   在Spring参数校验框架中增加了一个@Validated注解（它是JSR303的一个变种，对JSR303进行一定程度的封装和扩展），@Validated和@Valid在进行基本验证功能上没有太多区别，但它们主要区别在于注解范围、分组校验、嵌套校验上有所不同

• @Validatd注解范围可以用在类、方法和方法参数上，但是不能用在成员属性（字段）上，而@Valid可以用在类、方法、方法参数和成员属性（字段）上

• @Validatd提供了分组校验功能，而@Valid未提供分组校验功能

• @Validated和@Valid单独加在方法参数前，都不会自动对参数进行嵌套检验，因为@Valid可应用在成员属性上，通过添加该注解，配合@Validated或者@Valid来进行嵌套校验
  
  

二、不同类型参数校验举例 1. 简单参数校验

1. 定义一个简单的入参类，作为用户注册时入参所绑定的bean对象

   @Data
   public class AdminVo {
   
       
       private Long id;
   
       
       @NotBlank(message = "用户名不能为空")
       private String username;
   
       
       @NotBlank(message = "密码不能为空")
       private String password;
   
       
       @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")  //入参格式化
       private Date createTime;
   
       
       @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
       private Date updateTime;
   }
   

2. 定义controller类，创建一个新增用户接口

   @RestController
   public class AdminController {
     @Autowired
     AdminService adminService;
           
     @PostMapping("/add")
     public Long add(@Validated @RequestBody AdminVo adminVo) {
         Admin admin = new Admin();
         BeanUtils.copyProperties(adminVo, admin);
         Date date = new Date();
         admin.setCreateTime(date);
         admin.setUpdateTime(date);
         adminService.save(admin);
         return admin.getId();
     }
   }
   

3. 定义一个全局异常处理类，用来接收参数校验异常的结果

   @Slf4j
   @RestControllerAdvice
   public class GlobalExceptionHandler {
         
          @ExceptionHandler(value = Exception.class)
          public R