SpringBoot系列（三）JSR303数据校验

拼搏现实的明天。 2022-11-13 04:20 140阅读 0赞

**拓展**  
点击跳转哦~：[SpringBoot系列学习汇总和拓展][SpringBoot]

### 文章目录 ###

*   *   *  前言
         *  一、校验数据案例
         *  二、validated类
         *   *  2.1、空检查：
             *  2.2、Boelan检查：
             *  2.3、长度检查：
             *  2.4、日期检查：
             *  2.5、数值检查：

### 前言 ###

*  我使用的SpringBoot版本是2.4.4，理论上其**spring-boot-starter-web**模块里面会包含**hibernate-validator**包，但是我找了一圈没有找到。。所以默默的在本项目里加了上去  
    ![在这里插入图片描述][20210325162345107.png]
 *  添加**hibernate-validator** 包

<dependency>
    			<groupId>org.hibernate</groupId>
    			<artifactId>hibernate-validator</artifactId>
    			<version>6.2.0.CR1</version>
    		</dependency>

### 一、校验数据案例 ###

*  SpringBoot支持使用 **@validated** 来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。
 *  @NotNull 不能为空

①、实体类代码：

import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    import org.springframework.validation.annotation.Validated;
    
    import javax.validation.constraints.NotNull;
    
    @Data
    @Component
    @ConfigurationProperties(prefix = "student")
    @Validated //开启数据校验
    public class Student { 
        private String name;
        private Integer age;
        private String high;
        private String like;
    }

②、配置文件：

server:
      port: 7777
    
    student:
      age: 23
      high: 172
      like: 钓鱼

③、执行结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70]  
④、加上@NotNull注解  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 1]

⑤、再次执行：报错  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 2]

⑥错误信息：

Property: student.name
        Value: null
        Reason: 不能为null

⑦、自定义异常返回  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 4]

### 二、validated类 ###

- 可以校验的种类有哪些？不可能每个都写一遍来试试的，哪种需要用哪种。

#### 2.1、空检查： ####

@Null 验证对象是否为null
    @NotNull 验证对象是否不为null, 无法查检长度为0的字符串
    @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
    @NotEmpty 检查约束元素是否为NULL或者是EMPTY.

#### 2.2、Boelan检查： ####

@AssertTrue 验证 Boolean 对象是否为 true
    @AssertFalse 验证 Boolean 对象是否为 false

#### 2.3、长度检查： ####

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
    @Length(min=, max=) 验证字符串的长度在min和max范围之内.

#### 2.4、日期检查： ####

@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
    @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
    @Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

#### 2.5、数值检查： ####

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为""时无法转换为int，但可以转换为Stirng为"",Integer为null
    @Min 验证 Number 和 String 对象是否大等于指定的值
    @Max 验证 Number 和 String 对象是否小等于指定的值
    @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
    @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
    @Digits 验证 Number 和 String 的构成是否合法
    @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
    @Range(min=, max=) 被指定的元素必须在合适的范围内
    @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
    @CreditCardNumber信用卡验证
    @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
    @ScriptAssert(lang= ,script=, alias=)
    @URL(protocol=,host=, port=,regexp=, flags=)

*  总结： 需要啥用啥，做个记录自己查询着使用！

***路漫漫其修远兮，吾必将上下求索~***  
如果你认为i博主写的不错！写作不易，请点赞、关注、评论给博主一个鼓励吧\*\*转载请注明出处哦\*\*

[SpringBoot]: https://blog.csdn.net/weixin_43829443/article/details/115165660
[20210325162345107.png]: /images/20221022/d64d7bf830fe41bc8f163ec39cb62fa0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70]: /images/20221022/481138eb4098415db2d9b5a2bcc0ee9e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 1]: /images/20221022/51a84305b9e04bb29306a9677e3521cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 2]: /images/20221022/bac91f5ea4564a4a9684e66575de98a5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 3]: /images/20221022/8c67592e87544536a09e97d80e3db0ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzgyOTQ0Mw_size_16_color_FFFFFF_t_70 4]: /images/20221022/e7ab55448ce949c68e5425add150d796.png