SpringBoot-JSR303

JSR303校验

JSR-303 是 JAVA EE 6 中的一项子规范

JAR: validation-api-1.0.0.GA.jar:JDK的接口;

校验规则

核心就是正则表达式

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
28
29
30
31
32
33
34
35
36
空检查 
@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=) Validates that the annotated string is between min and max included.

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

数值检查
建议使用在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=) 被指定的元素必须在合适的范围内
@Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)


在SpringBoot中使用JSR303校验

  1. 在pom.xml中导入包

    1
    2
    3
    4
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
  2. 在实体类加上@Validated注解

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @Validated
    public class Person {
    @Email // 将会校验name是否为email
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    }

实战

  1. 验证实体类

    直接在前面加上@Valid即可(前提:实体类包含校验规则)

    1
    2
    3
    @PostMapping()
    public JsonResult addToLib(@RequestBody @Valid ImageLibDTO imageLibDTO) {
    }
  2. 验证实体类1中的依赖实体类2

    在实体类1中的实体类2上加上@Valid注解(前提:实体类2包含校验规则)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    public class ImageLibDTO {

    @NotEmpty(message = "projectCode不能为空")
    @Size(min = 5,max = 5,message = "projectCode长度错误")
    @ApiModelProperty("项目代码")
    private String projectCode;

    @NotEmpty(message = "lib不能为空")
    @ApiModelProperty("要操作的库名")
    private String lib;

    @ApiModelProperty("Image实体List")
    @Valid //验证实体类1中的依赖实体类2
    private List<Image> imageList;

    public String getKey(){
    return "face" + ":" + this.getProjectCode() + ":" + this.getLib();
    }
    }
  3. 验证get方式的单个参数

    参数前加上@NutBlank即可

    在该Controller类上面加上@Validated

    并且删除该参数前面的@RequestParam

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    @RestController
    @RequestMapping("/lib")
    @Validated
    public class FaceLibController {
    @GetMapping()
    public JsonResult getFromLib(
    @NotBlank(message = "projectCode不能为空") String projectCode,
    @NotBlank(message = "lib不能为空") String lib,
    @NotEmpty(message = "uidList不能为空") List<String> uidListr
    ) {}
    }