使用spring validation 作為資料校驗

weixin_34127717發表於2019-02-11
Spring

簡介

JSR303/JSR-349，hibernate validation，spring validation之間的關係。JSR303是一項標準,JSR-349是其的升級版本，新增了一些新特性，他們規定一些校驗規範即校驗註解，如@Null，@NotNull，@Pattern，他們位於javax.validation.constraints包下，只提供規範不提供實現。而hibernate validation是對這個規範的實踐（不要將hibernate和資料庫orm框架聯絡在一起），他提供了相應的實現，並增加了一些其他校驗註解，如@Email，@Length，@Range等等，他們位於org.hibernate.validator.constraints包下。而萬能的spring為了給開發者提供便捷，對hibernate validation進行了二次封裝，顯示校驗validated bean時，你可以使用spring validation或者hibernate validation，而spring validation另一個特性，便是其在springmvc模組中新增了自動校驗，並將校驗資訊封裝進了特定的類中。這無疑便捷了我們的web開發。本文主要介紹在springmvc中自動校驗的機制。

引入依賴
我們使用maven構建springboot應用來進行demo演示。

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

我們只需要引入spring-boot-starter-web依賴即可，如果檢視其子依賴，可以發現如下的依賴：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>

驗證了我之前的描述，web模組使用了hibernate-validation，並且databind模組也提供了相應的資料繫結功能。

構建啟動類

無需新增其他註解，一個典型的啟動類

@SpringBootApplication
public class ValidateApp {

    public static void main(String[] args) {
        SpringApplication.run(ValidateApp.class, args);
    }
}

建立需要被校驗的實體類

public class Foo {

    @NotBlank
    private String name;

    @Min(18)
    private Integer age;

    @Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手機號碼格式錯誤")
    @NotBlank(message = "手機號碼不能為空")
    private String phone;

    @Email(message = "郵箱格式錯誤")
    private String email;

    //... getter setter

}

使用一些比較常用的校驗註解，還是比較淺顯易懂的，欄位上的註解名稱即可推斷出校驗內容，每一個註解都包含了message欄位，用於校驗失敗時作為提示資訊，特殊的校驗註解，如Pattern（正則校驗），還可以自己新增正規表示式。

在@Controller中校驗資料

@Controller
public class FooController {

    @RequestMapping("/foo")
    public String foo(@Validated Foo foo <1>, BindingResult bindingResult <2>) {
        if(bindingResult.hasErrors()){
            for (FieldError fieldError : bindingResult.getFieldErrors()) {
                //...
            }
            return "fail";
        }
        return "success";
    }

}

值得注意的地方：

<1> 引數Foo前需要加上@Validated註解，表明需要spring對其進行校驗，而校驗的資訊會存放到其後的BindingResult中。注意，必須相鄰，如果有多個引數需要校驗，形式可以如下。foo(@Validated Foo foo, BindingResult fooBindingResult ，@Validated Bar bar, BindingResult barBindingResult);即一個校驗類對應一個校驗結果。

<2> 校驗結果會被自動填充，在controller中可以根據業務邏輯來決定具體的操作，如跳轉到錯誤頁面。

一個最基本的校驗就完成了，總結下框架已經提供了哪些校驗：

JSR提供的校驗註解：         
@Null   被註釋的元素必須為 null    
@NotNull    被註釋的元素必須不為 null    
@AssertTrue     被註釋的元素必須為 true    
@AssertFalse    被註釋的元素必須為 false    
@Min(value)     被註釋的元素必須是一個數字，其值必須大於等於指定的最小值    
@Max(value)     被註釋的元素必須是一個數字，其值必須小於等於指定的最大值    
@DecimalMin(value)  被註釋的元素必須是一個數字，其值必須大於等於指定的最小值    
@DecimalMax(value)  被註釋的元素必須是一個數字，其值必須小於等於指定的最大值    
@Size(max=, min=)   被註釋的元素的大小必須在指定的範圍內    
@Digits (integer, fraction)     被註釋的元素必須是一個數字，其值必須在可接受的範圍內    
@Past   被註釋的元素必須是一個過去的日期    
@Future     被註釋的元素必須是一個將來的日期    
@Pattern(regex=,flag=)  被註釋的元素必須符合指定的正規表示式    


Hibernate Validator提供的校驗註解：  
@NotBlank(message =)   驗證字串非null，且長度必須大於0    
@Email  被註釋的元素必須是電子郵箱地址    
@Length(min=,max=)  被註釋的字串的大小必須在指定的範圍內    
@NotEmpty   被註釋的字串的必須非空    
@Range(min=,max=,message=)  被註釋的元素必須在合適的範圍內

分組校驗

如果同一個類，在不同的使用場景下有不同的校驗規則，那麼可以使用分組校驗。未成年人是不能喝酒的，而在其他場景下我們不做特殊的限制，這個需求如何體現同一個實體，不同的校驗規則呢？

改寫註解，新增分組：

Class Foo{

    @Min(value = 18,groups = {Adult.class})
    private Integer age;

    public interface Adult{}

    public interface Minor{}
}

這樣表明，只有在Adult分組下，18歲的限制才會起作用。

Controller層改寫：

@RequestMapping("/drink")
public String drink(@Validated({Foo.Adult.class}) Foo foo, BindingResult bindingResult) {
    if(bindingResult.hasErrors()){
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            //...
        }
        return "fail";
    }
    return "success";
}

@RequestMapping("/live")
public String live(@Validated Foo foo, BindingResult bindingResult) {
    if(bindingResult.hasErrors()){
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            //...
        }
        return "fail";
    }
    return "success";
}

drink方法限定需要進行Adult校驗，而live方法則不做限制。

基於方法校驗

@RestController
@Validated <1>
public class BarController {

    @RequestMapping("/bar")
    public @NotBlank <2> String bar(@Min(18) Integer age <3>) {
        System.out.println("age : " + age);
        return "";
    }

    @ExceptionHandler(ConstraintViolationException.class)
    public Map handleConstraintViolationException(ConstraintViolationException cve){
        Set<ConstraintViolation<?>> cves = cve.getConstraintViolations();<4>
        for (ConstraintViolation<?> constraintViolation : cves) {
            System.out.println(constraintViolation.getMessage());
        }
        Map map = new HashMap();
        map.put("errorCode",500);
        return map;
    }

}

<1> 為類新增@Validated註解

<2> <3> 校驗方法的返回值和入參

<4> 新增一個異常處理器，可以獲得沒有通過校驗的屬性相關資訊

tips: @NotNull  @NotEmpty  @NotBlank 3個註解的區別：

@NotNull           任何物件的value不能為null

@NotEmpty       集合物件的元素不為0，即集合不為空，也可以用於字串不為null

@NotBlank        只能用於字串不為null，並且字串trim()以後length要大於0

相關文章