如何在Spring Boot項目使用參數校驗

開發web項目有時候咱們須要對controller層傳過來的參數進行一些基本的校驗，好比非空，非null，整數值的範圍，字符串的個數，日期，郵箱等等。最多見的就是咱們直接寫代碼校驗，這樣之後比較繁瑣，並且不夠靈活。

Bean Validation 1.0（JSR-303）是一個校驗規範，在Spring Boot項目因爲自帶了Hibernate validator 5(http://hibernate.org/validator/)實現，因此咱們能夠很是方便的使用這個特性 。

核心的pom依賴：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.3.1.Final</version>
</dependency>

首先，須要咱們聲明一個Bean，注入校驗器到Spring Boot的運行環境

@Configuration
@EnableAutoConfiguration
public class FactoryConfig {
    
    final static Logger logger= LoggerFactory.getLogger(FactoryConfig.class);
 
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor(){
     return new MethodValidationPostProcessor();
    }
    
    }

校驗經常使用的註解以下：

@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實體類進行校驗

下面看一個使用例子：

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層使用

//非實體類參數能夠直接使用註解
 @GetMapping("/check")
@ResponseBody
public 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頁面中經過這個對象拿到詳細的錯誤信息,

<td th:if="${#fields.hasErrors('age')}" th:errors="*{age}">Age Error</td>

總結：

經過使用註解來快速檢驗傳入的web參數仍是很是簡潔強大的，這裏僅僅列舉了一小部分的校驗的知識，若是想要更深刻的 瞭解和學習，請參考hibernate官網文檔：http://hibernate.org/validator/

有什麼問題能夠掃碼關注微信公衆號：我是攻城師(woshigcs)，在後臺留言諮詢。 技術債不能欠，健康債更不能欠， 求道之路，與君同行。