開發web項目有時候我們需要對controller層傳過來的參數進行一些基本的校驗，比如非空，非null，整數值的范圍，字符串的個數，日期，郵箱等等。最常見的就是我們直接寫代碼校驗，這樣以后比較繁瑣，而且不夠靈活。
Bean Validation 1.0（JSR-303）是一個校驗規范，在spring Boot項目由于自帶了hibernate validator 5(http://hibernate.org/validator/)實現，所以我們可以非常方便的使用這個特性 。
核心的pom依賴：
|
1
2
3
4
5
|
<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.3.1.Final</version></dependency> |
首先，需要我們聲明一個Bean，注入校驗器到Spring Boot的運行環境
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@Configuration@EnableAutoConfigurationpublic class FactoryConfig { final static Logger logger= LoggerFactory.getLogger(FactoryConfig.class); @Bean public MethodValidationPostProcessor methodValidationPostProcessor(){ return new MethodValidationPostProcessor(); } } |
校驗常用的注解如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@AssertFalse 校驗false@AssertTrue 校驗true@DecimalMax(value=,inclusive=) 小于等于value，inclusive=true,是小于等于@DecimalMin(value=,inclusive=) 與上類似@Max(value=) 小于等于value@Min(value=) 大于等于value@NotNull 檢查Null@Past 檢查日期@Pattern(regex=,flag=) 正則@Size(min=, max=) 字符串，集合，map限制大小@Valid 對po實體類進行校驗 |
下面看一個使用例子：
|
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
37
38
|
package hello;import javax.validation.constraints.Min;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;public class PersonForm { //名字不能為空，而且長度必須在2和30之間 @NotNull(message = "名稱不能為空") @Size(min=2, max=30, message = "名字長度必須在2和30之間") private String name; //年齡不能為空，而且必須大于等于18歲 @NotNull @Min(18) private Integer age; public String getName() { return this.name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public String toString() { return "Person(Name: " + this.name + ", Age: " + this.age + ")"; }} |
接著看下如何在Controller層使用
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
//非實體類參數可以直接使用注解 @GetMapping("/check")@ResponseBodypublic String check(@Min(0,message = "kpId必須大于等于0") @RequestParam int kpId,@RequestParam int level) { return "ok";} //實體類注解校驗使用@Valid @PostMapping("/") public String checkPersonInfo(@Valid PersonForm personForm, BindingResult bindingResult) { if (bindingResult.hasErrors()) { return "form"; } return "redirect:/results"; } |
注意上面的Spring提供的BindingResult是錯誤結果的一個封裝，我們可以在web頁面中通過這個對象拿到詳細的錯誤信息,
|
1
|
<td th:if="${#fields.hasErrors('age')}" th:errors="*{age}">Age Error</td> |
總結：
通過使用注解來快速檢驗傳入的web參數還是非常簡潔強大的，這里僅僅列舉了一小部分的校驗的知識，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：http://blog.csdn.net/u010454030/article/details/53009327
