SpringBoot--数据校验（普通校验、分组校验）

Dear 丶 2021-08-24 19:01 665阅读 0赞

### 普通校验 ###

普通检验是基础用法，非常容易，首先需要用户在SpringBootWeb项目中添加数据校验相关的依赖：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>

查看**LocalValidatorFactoryBean**类的源码，发现默认的**ValidationMessageSource（校验出错时的提示文件）** 是resources目录下的**ValidationMessages.properties** 文件，因此在resources目录下创建ValidationMessages.properties文件，内容如下：

user.name.size=用户名长度介于5到10个字符之间
    user.address.notnull=用户地址不能为空
    user.age.size=年龄输入不正确
    user.email.notnull=邮箱不能为空
    user.email.pattern=邮箱格式不正确

创建User类，配置数据校验：

public class User { 
        
        private Integer id;
        
        @Size(min = 5, max = 10, message = "{user.name.size}")
        private String name;
        
        @NotNull(message = "{user.address.notnull}")
        private String address;
        
        @DecimalMin(value = "1", message = "{user.age.size}")
        @DecimalMax(value = "200", message = "{user.age.size}")
        private Integer age;
        
        @Email(message = "{user.email.pattern}")
        @NotNull(message = "{user.email.notnull}")
        private String email;
    
        //省略getter和setter
    }

*  @Size表示一个字符串的长度或者一个集合的大小，必须在某一个范围中；min参数表示范围的下限；max参数表示范围的上限；message表示校验失败时的提示信息。
 *  @NotNull注解表示该字段不能为空
 *  @DecimalMin注解表示对应属性值的下限
 *  @DecimalMax注解表示对应属性值的上限
 *  @Email注解表示对应属性格式是一个Email

创建UserController：

@RestController
    public class UserController { 
    
        @PostMapping("/user")
        public List<String> addUser(@Validated User user, BindingResult result){ 
            List<String> errors = new ArrayList<>();
            if(result.hasErrors()){ 
                List<ObjectError> allErrors = result.getAllErrors();
                for(ObjectError error : allErrors){ 
                    errors.add(error.getDefaultMessage());
                }
            }
            return errors;
        }
    }

*  给User参数添加@Validated注解，表示需要对该参数做校验，紧接着的BindingResult参数表示在校验出错时保存的出错信息。
 *  如果BindingResult中的haiErrors方法返回true，表示有错误信息，此时遍历错误信息，将之返回给前端

使用Postman测试：

直接访问"/user"接口：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70]

传入用户地址、一个非法邮箱地址以及一个格式不正确的用户名：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 1]

### 分组校验 ###

有的时候，开发者在某一个实体类中定义了很多校验规则，但是在某一次业务处理中，并不需要这么多校验规则，此时就可以使用分组校验：

首先创建两个分组接口：

public interface ValidationGroup1 { 
    }
    public interface ValidationGroup2 { 
    }

在实体类中添加分组信息：

public class User { 
    
        private Integer id;
    	
    	//groups属性，表示该校验属性规则所属的分组
    
        @Size(min = 5, max = 10, message = "{user.name.size}", groups = ValidationGroup1.class)
        private String name;
    
        @NotNull(message = "{user.address.notnull}", groups = ValidationGroup2.class)
        private String address;
    
        @DecimalMin(value = "1", message = "{user.age.size}")
        @DecimalMax(value = "200", message = "{user.age.size}")
        private Integer age;
    
        @Email(message = "{user.email.pattern}")
        @NotNull(message = "{user.email.notnull}", groups = { ValidationGroup1.class, ValidationGroup2.class})
        private String email;
    }

在@Validated注解中指定校验分组：

@RestController
    public class UserController { 
    
        
        //@Validated(ValidationGroup2.class) 表示这里的校验使用ValidationGroup2分组的校验规则，即只校验邮箱地址是否为空、用户地址是否为空
        @PostMapping("/user")
        public List<String> addUser(@Validated(ValidationGroup2.class) User user, BindingResult result){ 
            List<String> errors = new ArrayList<>();
            if(result.hasErrors()){ 
                List<ObjectError> allErrors = result.getAllErrors();
                for(ObjectError error : allErrors){ 
                    errors.add(error.getDefaultMessage());
                }
            }
            return errors;
        }
    }

测试：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 2]

### 校验注解 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">校验注解</th> 
   <th align="left">注解的元素类型</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">AssertFalse</td> 
   <td align="left">Boolean、boolean</td> 
   <td align="left">被注解的元素值必须为false</td> 
  </tr> 
  <tr> 
   <td align="left">AssertTrue</td> 
   <td align="left">Boolean、boolean</td> 
   <td align="left">被注解的元素值必须为true</td> 
  </tr> 
  <tr> 
   <td align="left">DecimalMax</td> 
   <td align="left">BigDecimal、BigInteger、CharSequence、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素值小于等于@DecimalMax注解中的value值</td> 
  </tr> 
  <tr> 
   <td align="left">DecimalMin</td> 
   <td align="left">BigDecimal、BigInteger、CharSequence、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素值大于等于@decimalMin注解中的value值</td> 
  </tr> 
  <tr> 
   <td align="left">Max</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素值小于等于@Max注解中的value值</td> 
  </tr> 
  <tr> 
   <td align="left">Min</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素值必须大于等于@Min注解中的value值</td> 
  </tr> 
  <tr> 
   <td align="left">Digits</td> 
   <td align="left">BigDecimal、BigInteger、CharSequence、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素必须是一个数字，其值必须在可接受的范围内（整数位数和小数位数在指定范围内）</td> 
  </tr> 
  <tr> 
   <td align="left">Email</td> 
   <td align="left">CharSequence</td> 
   <td align="left">被注解的元素值必须是Email格式</td> 
  </tr> 
  <tr> 
   <td align="left">Future</td> 
   <td align="left">java.util.Date、java.util.Calendar以及java.time包下的时间类</td> 
   <td align="left">被注解的元素值必须是一个未来的日期</td> 
  </tr> 
  <tr> 
   <td align="left">Past</td> 
   <td align="left">java.util.Date、java.util.Calendar以及java.time包下的时间类</td> 
   <td align="left">被注解的元素值必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td align="left">PastOrPresent</td> 
   <td align="left">java.util.Date、java.util.Calendar以及java.time包下的时间类</td> 
   <td align="left">被注解的元素值必须是一个过去的日期或者当前日期</td> 
  </tr> 
  <tr> 
   <td align="left">FutureOrPresent</td> 
   <td align="left">java.util.Date、java.util.Calendar以及java.time包下的时间类</td> 
   <td align="left">被注解的元素值必须是一个未来的日期或者当前的日期</td> 
  </tr> 
  <tr> 
   <td align="left">Negative</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素必须是负数</td> 
  </tr> 
  <tr> 
   <td align="left">NegativeOrZero</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素必须是负数或0</td> 
  </tr> 
  <tr> 
   <td align="left">Positive</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素必须是正数</td> 
  </tr> 
  <tr> 
   <td align="left">PositiveOrZero</td> 
   <td align="left">BigDecimal、BigInteger、byte、short、int、long以及它们各自的包装类</td> 
   <td align="left">被注解的元素必须是正数或0</td> 
  </tr> 
  <tr> 
   <td align="left">NotBlank</td> 
   <td align="left">CharSequence</td> 
   <td align="left">被注解的元素必须不为null并且至少有一个非空白的字符</td> 
  </tr> 
  <tr> 
   <td align="left">NotEmpty</td> 
   <td align="left">CharSequence、Collection、Map、Array</td> 
   <td align="left">被注解的字符集不为null或空字符串，被注解的集合或数组不为空。和@NotBlank注解相比，一个空格字符串在@NotBlank验证不通过，但是在@NotEmpty中验证通过</td> 
  </tr> 
  <tr> 
   <td align="left">NotNull</td> 
   <td align="left">任意类型</td> 
   <td align="left">被注解的元素不为null</td> 
  </tr> 
  <tr> 
   <td align="left">Null</td> 
   <td align="left">任意类型</td> 
   <td align="left">被注解的元素为null</td> 
  </tr> 
  <tr> 
   <td align="left">Pattern</td> 
   <td align="left">CharSequence</td> 
   <td align="left">被注解的元素必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td align="left">Size</td> 
   <td align="left">CharSequence、Collection、Map、Array</td> 
   <td align="left">被朱姐的字符串长度、集合或者数组的大小必须在指定范围内</td> 
  </tr> 
 </tbody> 
</table>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70]: /images/20210813/e7f74b59ebdb467ea5bb3662564604a9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 1]: /images/20210813/1b2789e0df494dbb8d7ebf2ed7f1c5ef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 2]: /images/20210813/df9dd5f688754edba112f2720e1e917b.png