SpringBoot集成JSR303

JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。

此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。
Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。

下面，我使用SpringBoot来详细讲解如何使用JSR303做数据校验

1.maven依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!--JSR303-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
</dependencies>

这里就不连数据库了，我们的目的只是验证数据是否能得到校验。

2.注解

使用JSR303主要就是用它提供的注解，下面是注解讲解：

空检查

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

Booelan检查

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

长度检查

  • @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
  • @Length(min=, max=) 验证约束字符串是否包含在最小和最大之间。

日期检查

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

数值检查
建议使用在Stirng,Integer类型，不建议使用在 int 类型上，因为表单值为 空 时无法转换为int，

  • @Min 验证 Number
  • 和 String 对象是否大等于指定的值
  • @Max 验证 Number和 String 对象是否小等于指定的值
  • @DecimalMax 被标注的值必须不大于约束中指定的最大值.这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示. 小数存在精度（ Double,float, BigDecimal ）
  • @DecimalMin 被标注的值必须不小于约束中指定的最小值.这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示. 小数存在精度
  • @Digits 验证 Number和 String 的构成是否合法
  • @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
  • @Range(min=, max=) 被指定的元素必须在合适的范围内
  • @Range(min=10000,max=50000,message=”range.bean.wage”)
  • @Valid 递归的对关联对象进行校验,如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
  • @CreditCardNumber 信用卡验证
  • @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
  • @ScriptAssert(lang= ,script=, alias=)
  • @URL(protocol=,host=, port=,regexp=, flags=)

3.表单校验

User.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/**
 * 用户实体类
 * @author 路飞
 * @create 2021/1/23
 */
@Data
public class User {

    private Integer uid; //主键

    @NotEmpty(message = "姓名不能为空")
    @Length(min = 1,max = 10,message = "长度必须在1-10之间")
    private String name; //姓名

    @NotBlank
    @Pattern(regexp = "^134[0-8]\\d{7}$|^13[^4]\\d{8}$|^14[5-9]\\d{8}$|^15[^4]\\d{8}$|^16[6]\\d{8}$|^17[0-8]\\d{8}$|^18[\\d]{9}$|^19[8,9]\\d{8}$", message = "电话号码格式不正确")
    private String tel; //电话

    @Email(message = "邮件格式不正确")
    @NotEmpty
    private String mail; //邮箱

    @NotBlank
    @Pattern(regexp = "[1-9][0-9]{4,14}", message = "qq格式不正确")
    private String qq; //qq

}

在属性是加上合适的注解，即可实现校验，对于电话，qq等等可以用正则表达式进行校验。

UserController.Java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * 用户注册
 * @param user
 * @return
 */
@PostMapping("/user")
//@Valid 加入参数校验
// @Validated 两者基本使用无区别
/**
 * @Valid----
 * public @interface Valid {
 * }
 *
 * @Validated-----
 * public @interface Validated {
 *     Class<?>[] value() default {};
 * }
 *
 */
public BaseResponse<Integer> insUser(@RequestBody @Valid User user){

    log.info("表单传值====>"+user);
    Integer integer = userService.registerUser(user);
    return new BaseResponse<>(true,"注册成功",integer);
}

在校验@RequestBody注解的数据时,可以使用@Validated和@Valid，两者有区别吗？

3.1 所属包不同

可以看到@Validated属于spring，而@Valid属于javax。

  • @Validated ：org.springframework.validation.annotation.Validated
  • @Valid：javax.validation.Valid

3.2 源码区别

@Valid

1
2
3
4
5
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Valid {
}

@Validated

1
2
3
4
5
6
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
    Class<?>[] value() default {};
}

通过源码可以看到@Validated可以在类上面使用，并且多了一个value属性。

@Validated提供了一个分组功能，在校验参数时，可以根据不同的分组采用不同的校验机制。没有添加分组属性时，默认验证没有分组的验证属性。

这里我们之间启动项目，利用Postman测试：

提交不符合格式的数据，校验不通过，返回400请求失败

可以看到SpringMVC的通过注解实现了校验@RequestBody中的数据，测试通过！

4.分组校验

上面的表单提交，有一个问题就是不能分情况去提交数据，比如用户在修在电话号码的时候，需要在请求中传入用户名，邮箱等等信息，否则也会返回400，数据冗余，所以就当产生这种需求时，我们就可以使用@Validated的分组校验功能。

编写分组校验接口

1
2
3
4
5
6
7
8
9
10
11
/**
 * 分组校验
 * @author 路飞
 * @create 2021/1/23
 */
public class ValidatedGroup {
    public interface  Add extends Default {}
    public interface  Delete extends Default {}
    public interface  Update extends Default {}
    public interface  Query extends Default {}
}

改造下之前的User.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
 * @author 路飞
 * @create 2021/1/23
 */
@Data
public class TestUser {
    private Integer uid; //主键

    @NotEmpty(groups = {ValidatedGroup.Add.class},message = "更新不能为空")
    @Length(min = 1,max = 10,message = "长度必须在1-10之间")
    private String name; //姓名

    @NotBlank(groups = {ValidatedGroup.Add.class},message = "更新电话号码不能为空")
    @Pattern(regexp = "^134[0-8]\\d{7}$|^13[^4]\\d{8}$|^14[5-9]\\d{8}$|^15[^4]\\d{8}$|^16[6]\\d{8}$|^17[0-8]\\d{8}$|^18[\\d]{9}$|^19[8,9]\\d{8}$", message = "电话号码格式不正确")
    private String tel; //电话

    @Email(message = "邮件格式不正确")
    @NotBlank(groups = {ValidatedGroup.Add.class} , message = "更新邮箱不能为空")
    private String mail; //邮箱

    @NotBlank(groups = {ValidatedGroup.Update.class,ValidatedGroup.Add.class},message = "更新和新增的qq不能为空")
    @Pattern(regexp = "[1-9][0-9]{4,14}", message = "qq格式不正确")
    private String qq; //qq
}

通过上面分析@Validated和@Valid注解的源码，我们知道@Validated还提供了分组校验，具体实现思路：

在实体类中的注解中说明需要校验的条件，如：

@NotBlank(groups = {ValidatedGroup.Add.class},message = “更新电话号码不能为空”)

此注解标明只有在新增的时候，才会校验电话号码，在controller中写明校验的条件即可。

1
2
3
4
5
6
7
8
9
10
11
/**
    * 修改信息
    * @param testUser
    * @return
    */
   @PostMapping("/updateUser")
   public BaseResponse<Integer> updateUser(@RequestBody  @Validated(value = ValidatedGroup.Update.class) TestUser testUser){
       log.info("表单传值====>"+testUser);
       Integer integer = userService.updateUser(testUser);
       return new BaseResponse<>(true,"修改成功",integer);
   }

调用updateUser()方法时，由于在@Validated中加入了分组校验，只有在实体类中加入了Update分组的方法才会被进行参数校验，减少数据冗杂。

可以看到，只有校验qq格式的注解生效

测试通过！

5.GitHub源码

springboot-jsr303