SpringBoot 校驗 validator

數據的校驗的重要性就不用說了，即使在前端對數據進行校驗的情況下，我們還是要對傳入后端的數據再進行一遍校驗，避免用戶繞過瀏覽器直接通過一些 HTTP 工具直接向后端請求一些違法數據。

JSR(Java Specification Requests） 是一套 JavaBean 參數校驗的標准，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們 JavaBean 的屬性上面，這樣就可以在需要校驗的時候進行校驗了，非常方便！

校驗的時候我們實際用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 團隊最初的數據校驗框架，Hibernate Validator 4.x 是 Bean Validation 1.0（JSR 303）的參考實現，Hibernate Validator 5.x 是 Bean Validation 1.1（JSR 349）的參考實現，目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0（JSR 380）的參考實現。

SpringBoot 項目的 spring-boot-starter-web 依賴中已經有 hibernate-validator 包，不需要引用相關依賴。

使用 Spring Boot 程序的話只需要spring-boot-starter-web 就夠了，它的子依賴包含了我們所需要的東西。非 SpringBoot 項目需要自行引入相關依賴包

但有一點需要注意，在更新版本的SpringBoot中，默認移除了Bean Validtion相關依賴。具體的對應關系可以參照如下表格：

maven地址

    <!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
    <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>6.0.16.Final</version>
    </dependency>

1.字段注解

@NotEmpty 被注釋的字符串的不能為 null 也不能為空
@NotBlank 被注釋的字符串非 null，並且必須包含一個非空白字符
@Null 被注釋的元素（數字）必須為 null
@NotNull 被注釋的元素（數字）必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Pattern(regex=,flag=)被注釋的元素必須符合指定的正則表達式
@Email 被注釋的元素必須是 Email 格式。
@Min(value)被注釋的元素必須是一個數字，其值必須大於等於指定的最小值
@Max(value)被注釋的元素必須是一個數字，其值必須小於等於指定的最大值
@DecimalMin(value)被注釋的元素必須是一個數字，其值必須大於等於指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個數字，其值必須小於等於指定的最大值
@Size(max=, min=) 被注釋的元素（集合）的大小必須在指定的范圍內
@Digits (integer, fraction)被注釋的元素必須是一個數字，其值必須在可接受的范圍內
@Past被注釋的元素必須是一個過去的日期
@Future 被注釋的元素必須是一個將來的日期
@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內
@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內

@ApiModel(value="測試")
@Data
public class Test {

    @NotNull(message = "id不為空")
    @Max(value = 1,message ="最大值不超過1" )
    private Long id;

    //只校驗格式，  不校驗null
    @Email(message = "郵箱格式錯誤!")
    @NotBlank(message = "郵箱 不為空！")
    private String email;
}

1.參數校驗

一定一定不要忘記在類上加上 Validated 注解了，這個參數可以告訴 Spring 去校驗方法參數。否則驗證注解不生效
Path Variables 和 Request Parameters

@RestController
@RequestMapping("/api")
@Validated
public class PersonController {

    @GetMapping("/person/{id}")
    public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超過 id 的范圍了") Integer id) {
        return ResponseEntity.ok().body(id);
    }

2.實體校驗 @Valid

對接受實體加注解的字段進行校驗，如果驗證失敗，它將拋出MethodArgumentNotValidException。

    @ApiOperation(value = "測試")
    @PostMapping()
    public CommonResult test(@Valid @RequestBody Test test) {}

3.分組校驗

兩個接口的DTO相同，校驗項不同，加入分組groups

3.1 方法一

import javax.validation.groups.Default;

public interface AddGroupextends Default {
}

import javax.validation.groups.Default;

public interface UpdateGroupextends Default{
}

@ApiModel(value="測試")
@Data
public class TestDTO {

    @NotNull(message = "id不為空")
    @Max(value = 1,message ="最大值不超過1" )
    private Long id;

    @NotBlank(message = "name不為空！",groups = {AddGroup.class, UpdateGroup.class})
    private String name;

    @NotBlank(message = "task 不為空！",groups = {UpdateGroup.class})
    private String task;

    @Email(message = "郵箱格式錯誤!")//只校驗格式，不校驗null
    @NotBlank(message = "郵箱 不為空！")
    private String email;
}

再在需要校驗的地方@Validated聲明校驗組此處失敗會觸發ConstraintViolationException 異常。

 /**
     * 走參數校驗注解的 groups 組合校驗
     *
     * @param userDTO
     * @return
     */
    @PostMapping("/update/groups")
    public RspDTO update(@RequestBody @Validated(UpdateGroup.class) TestDTO test) {
      
        return RspDTO.success();
 }

注意:在聲明分組的時候盡量加上 extend javax.validation.groups.Default否則,在你聲明@Validated(Update.class)的時候,就會出現你在默認沒添加groups = {}的時候的校驗組@Email(message = "郵箱格式不對"),會不去校驗,因為默認的校驗組是 groups = {Default.class}

3.2 方法二(推薦)

@ApiOperation(value = "測試")

    @PostMapping()

    public CommonResult test(@Valid @RequestBody Test test) {

        //校驗未加group的和加了group = UpdateGroup
        //獲取java默認的校驗器。在spring項目中可以設為單例bean然后注入，本demo直接獲取
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        //獲得校驗不通過的結果，保存到set
        Set<ConstraintViolation<Object>> set = validator.validate(test, UpdateGroup.class);
        if (set != null && set.size() > 0){
            throw new VisualException(ResultCode.FAILED.getCode(),set.iterator().next().getMessage());
        }
        return CommonResult.success();
 }  

4.自定義注解

原有注解不能滿足校驗需求時，需要引入自定義注解

@Documented
@Constraint(validatedBy = PhoneNumberValidator.class)
@Target({FIELD, PARAMETER})
@Retention(RUNTIME)
public@interface PhoneNumber {
    String message() default "Invalid phone number";
    Class[] groups() default {};
    Class[] payload() default {};
}

publicclass PhoneNumberValidator implements ConstraintValidator<PhoneNumber,String> {

    @Override
    public boolean isValid(String phoneField, ConstraintValidatorContext context) {
        if (phoneField == null) {
            // can be null
            returntrue;
        }
        return phoneField.matches("^1(3[0-9]|4[57]|5[0-35-9]|8[0-9]|70)\\d{8}$") && phoneField.length() > 8 && phoneField.length() < 14;
    }
}

搞定，我們現在就可以使用這個注解了。

@PhoneNumber(message = "phoneNumber 格式不正確")
@NotNull(message = "phoneNumber 不能為空")
private String phoneNumber;

5.service校驗

總結

/**
     * @Valid 只校驗未分組的,帶group的不校驗
     * @Validated 只校驗未分組的,帶group的不校驗
     * @Validated(AddGroup.class) 只校驗AddGroup的
     * @Valid@Validated(AddGroup.class) 只校驗未分組的,帶group的不校驗
     * 只有@Max (value = 1,message ="最大值不超過1" )  不校驗
     * 方法上 @Validated  @Max (value = 1,message ="最大值不超過1" )  不校驗
     * @Validated 類上 @Max (value = 1,message ="最大值不超過1" ) 成功校驗
     */