spring validation


前言

數據的校驗是交互式網站一個不可或缺的功能,前端的js校驗可以涵蓋大部分的校驗職責,如用戶名唯一性,生日格式,郵箱格式校驗等等常用的校驗。但是為了避免用戶繞過瀏覽器,使用http工具直接向后端請求一些違法數據,服務端的數據校驗也是必要的,可以防止臟數據落到數據庫中,如果數據庫中出現一個非法的郵箱格式,也會讓運維人員頭疼不已。我在之前保險產品研發過程中,系統對數據校驗要求比較嚴格且追求可變性及效率,曾使用drools作為規則引擎,兼任了校驗的功能。而在一般的應用,可以使用本文將要介紹的validation來對數據進行校驗。
簡述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中校驗數據


springmvc為我們提供了自動封裝表單參數的功能,一個添加了參數校驗的典型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=) 被注釋的元素必須在合適的范圍內



校驗實驗

我們對上面實現的校驗入口進行一次測試請求:
訪問 http://localhost:8080/foo?name=xujingfeng&email=000&age=19 可以得到如下的debug信息:


實驗告訴我們,校驗結果起了作用。並且,可以發現當發生多個錯誤,spring validation不會在第一個錯誤發生后立即停止,而是繼續試錯,告訴我們所有的錯誤。debug可以查看到更多豐富的錯誤信息,這些都是spring validation為我們提供的便捷特性,基本適用於大多數場景。
更多免費技術資料可關注:annalin1203


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM