spring validation作為數(shù)據(jù)校驗(yàn)的案例

這篇文章給大家分享的是有關(guān)spring validation作為數(shù)據(jù)校驗(yàn)的案例的內(nèi)容。小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧。

數(shù)據(jù)的校驗(yàn)是交互式網(wǎng)站一個(gè)不可或缺的功能，前端的js校驗(yàn)可以涵蓋大部分的校驗(yàn)職責(zé)，如用戶名唯一性，生日格式，郵箱格式校驗(yàn)等等常用的校驗(yàn)。但是為了避免用戶繞過(guò)瀏覽器，使用http工具直接向后端請(qǐng)求一些違法數(shù)據(jù)，服務(wù)端的數(shù)據(jù)校驗(yàn)也是必要的，可以防止臟數(shù)據(jù)落到數(shù)據(jù)庫(kù)中，如果數(shù)據(jù)庫(kù)中出現(xiàn)一個(gè)非法的郵箱格式，也會(huì)讓運(yùn)維人員頭疼不已。

JSR303/JSR-349，hibernate validation，spring validation之間的關(guān)系。JSR303是一項(xiàng)標(biāo)準(zhǔn),JSR-349是其的升級(jí)版本，添加了一些新特性，他們規(guī)定一些校驗(yàn)規(guī)范即校驗(yàn)注解，如@Null，@NotNull，@Pattern，他們位于javax.validation.constraints包下，只提供規(guī)范不提供實(shí)現(xiàn)。而hibernate validation是對(duì)這個(gè)規(guī)范的實(shí)踐（不要將hibernate和數(shù)據(jù)庫(kù)orm框架聯(lián)系在一起），他提供了相應(yīng)的實(shí)現(xiàn)，并增加了一些其他校驗(yàn)注解，如@Email，@Length，@Range等等，他們位于org.hibernate.validator.constraints包下。而萬(wàn)能的spring為了給開發(fā)者提供便捷，對(duì)hibernate validation進(jìn)行了二次封裝，顯示校驗(yàn)validated bean時(shí)，你可以使用spring validation或者h(yuǎn)ibernate validation，而spring validation另一個(gè)特性，便是其在springmvc模塊中添加了自動(dòng)校驗(yàn)，并將校驗(yàn)信息封裝進(jìn)了特定的類中。這無(wú)疑便捷了我們的web開發(fā)。本文主要介紹在springmvc中自動(dòng)校驗(yàn)的機(jī)制。

引入依賴
我們使用maven構(gòu)建springboot應(yīng)用來(lái)進(jìn)行demo演示。

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

我們只需要引入spring-boot-starter-web依賴即可，如果查看其子依賴，可以發(fā)現(xiàn)如下的依賴：

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

驗(yàn)證了我之前的描述，web模塊使用了hibernate-validation，并且databind模塊也提供了相應(yīng)的數(shù)據(jù)綁定功能。

構(gòu)建啟動(dòng)類

無(wú)需添加其他注解，一個(gè)典型的啟動(dòng)類

@SpringBootApplication
public class ValidateApp {

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

創(chuàng)建需要被校驗(yàn)的實(shí)體類

public class Foo {

    @NotBlank
    private String name;

    @Min(18)
    private Integer age;

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

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

    //... getter setter

}

使用一些比較常用的校驗(yàn)注解，還是比較淺顯易懂的，字段上的注解名稱即可推斷出校驗(yàn)內(nèi)容，每一個(gè)注解都包含了message字段，用于校驗(yàn)失敗時(shí)作為提示信息，特殊的校驗(yàn)注解，如Pattern（正則校驗(yàn)），還可以自己添加正則表達(dá)式。

在@Controller中校驗(yàn)數(shù)據(jù)

@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> 參數(shù)Foo前需要加上@Validated注解，表明需要spring對(duì)其進(jìn)行校驗(yàn)，而校驗(yàn)的信息會(huì)存放到其后的BindingResult中。注意，必須相鄰，如果有多個(gè)參數(shù)需要校驗(yàn)，形式可以如下。foo(@Validated Foo foo, BindingResult fooBindingResult ，@Validated Bar bar, BindingResult barBindingResult);即一個(gè)校驗(yàn)類對(duì)應(yīng)一個(gè)校驗(yàn)結(jié)果。

<2> 校驗(yàn)結(jié)果會(huì)被自動(dòng)填充，在controller中可以根據(jù)業(yè)務(wù)邏輯來(lái)決定具體的操作，如跳轉(zhuǎn)到錯(cuò)誤頁(yè)面。

一個(gè)最基本的校驗(yàn)就完成了，總結(jié)下框架已經(jīng)提供了哪些校驗(yàn)：

JSR提供的校驗(yàn)注解：         
@Null   被注釋的元素必須為 null    
@NotNull    被注釋的元素必須不為 null    
@AssertTrue     被注釋的元素必須為 true    
@AssertFalse    被注釋的元素必須為 false    
@Min(value)     被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值    
@Max(value)     被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值    
@DecimalMin(value)  被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值    
@DecimalMax(value)  被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值    
@Size(max=, min=)   被注釋的元素的大小必須在指定的范圍內(nèi)    
@Digits (integer, fraction)     被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)    
@Past   被注釋的元素必須是一個(gè)過(guò)去的日期    
@Future     被注釋的元素必須是一個(gè)將來(lái)的日期    
@Pattern(regex=,flag=)  被注釋的元素必須符合指定的正則表達(dá)式    


Hibernate Validator提供的校驗(yàn)注解：  
@NotBlank(message =)   驗(yàn)證字符串非null，且長(zhǎng)度必須大于0    
@Email  被注釋的元素必須是電子郵箱地址    
@Length(min=,max=)  被注釋的字符串的大小必須在指定的范圍內(nèi)    
@NotEmpty   被注釋的字符串的必須非空    
@Range(min=,max=,message=)  被注釋的元素必須在合適的范圍內(nèi)

分組校驗(yàn)

如果同一個(gè)類，在不同的使用場(chǎng)景下有不同的校驗(yàn)規(guī)則，那么可以使用分組校驗(yàn)。未成年人是不能喝酒的，而在其他場(chǎng)景下我們不做特殊的限制，這個(gè)需求如何體現(xiàn)同一個(gè)實(shí)體，不同的校驗(yàn)規(guī)則呢？

改寫注解，添加分組：

Class Foo{

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

    public interface Adult{}

    public interface Minor{}
}

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

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方法限定需要進(jìn)行Adult校驗(yàn)，而live方法則不做限制。

基于方法校驗(yàn)

@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> 校驗(yàn)方法的返回值和入?yún)?/p>

<4> 添加一個(gè)異常處理器，可以獲得沒(méi)有通過(guò)校驗(yàn)的屬性相關(guān)信息

感謝各位的閱讀！關(guān)于spring validation作為數(shù)據(jù)校驗(yàn)的案例就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，讓大家可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到吧！