前言

在接口開發(fā)中，經(jīng)常是需要對(duì)傳入?yún)?shù)完整性進(jìn)行驗(yàn)證的，或者對(duì)手機(jī)號(hào)格式進(jìn)行驗(yàn)證等，而一般不了解@Valid注解之前，都是通過自己封裝方法來驗(yàn)證，都是一堆if else集合，這樣判斷對(duì)于代碼結(jié)構(gòu)很不友好，開發(fā)效率也不高，使用@Valid注解可以快速的對(duì)參數(shù)進(jìn)行驗(yàn)證，并且可以通過抓取全局異常，從而實(shí)現(xiàn)統(tǒng)一返回

引用

@Valid是使用hibernate validation的時(shí)候使用,其中java的jsr303聲明了這類接口，hibernate-validator對(duì)其進(jìn)行了實(shí)現(xiàn)

在進(jìn)行maven整合時(shí)，需要引入的依賴

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

一般情況下早已被其他框架引入了，只是在不存在的時(shí)候需要進(jìn)行引用一下，@Valid只是驗(yàn)證參數(shù)是否符合要求，但是具體參數(shù)需要符合什么要求，還是需要其他注解來標(biāo)志驗(yàn)證規(guī)則

驗(yàn)證規(guī)則標(biāo)簽

@Null 驗(yàn)證對(duì)象是否為null

@NotNull 驗(yàn)證對(duì)象是否不為null, 無法查檢長度為0的字符串

@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對(duì)字符串,且會(huì)去掉前后空格.

@NotEmpty 檢查約束元素是否為NULL或者是EMPTY.

@AssertTrue 驗(yàn)證 Boolean 對(duì)象是否為 true

@AssertFalse 驗(yàn)證 Boolean 對(duì)象是否為 false

@Size(min=, max=) 驗(yàn)證對(duì)象（Array,Collection,Map,String）長度是否在給定的范圍之內(nèi)

@Length(min=, max=) 驗(yàn)證字符串長度是否在給定的范圍之內(nèi)

@Past 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之前

@Future 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之后

@Pattern 驗(yàn)證 String 對(duì)象是否符合正則表達(dá)式的規(guī)則

@Min 驗(yàn)證 Number 和 String 對(duì)象是否大等于指定的值

@Max 驗(yàn)證 Number 和 String 對(duì)象是否小等于指定的值

@DecimalMax 被標(biāo)注的值必須不大于約束中指定的最大值. 這個(gè)約束的參數(shù)是一個(gè)通過BigDecimal定義的最大值的字符串表示.小數(shù)存在精度

@DecimalMin 被標(biāo)注的值必須不小于約束中指定的最小值. 這個(gè)約束的參數(shù)是一個(gè)通過BigDecimal定義的最小值的字符串表示.小數(shù)存在精度

@Digits 驗(yàn)證 Number 和 String 的構(gòu)成是否合法

@Digits(integer=,fraction=) 驗(yàn)證字符串是否是符合指定格式的數(shù)字，interger指定整數(shù)精度，fraction指定小數(shù)精度。

@Range(min=, max=) 驗(yàn)證元素是否在合適的范圍內(nèi)

@Email 驗(yàn)證是否是郵件地址，如果為null,不進(jìn)行驗(yàn)證，算通過驗(yàn)證。

使用

在需要驗(yàn)證的類屬性上添加相應(yīng)的注解，如：

import lombok.Data;
import org.hibernate.validator.constraints.NotBlank;

@Data
public class LoginVO {

    @NotBlank
    private String username;
    @NotBlank
    private String password;
}

在SpringMVC控制層中使用@Valid注解進(jìn)行驗(yàn)證,并判斷是否有異常

@PostMapping("login")
public String login(@Valid LoginVO vo, Errors errors){
    if (errors.hasErrors()) {
        List<FieldError> list = errors.getFieldErrors();
        StringBuffer sb = new StringBuffer("參數(shù)：");
        for(FieldError error : list){
             sb.append(error.getField()).append(",");
         }
         sb.append("不符合要求");
         return sb.toString();
     }
     return "驗(yàn)證通過";
}

當(dāng)然上面Controller層的代碼非常容易重復(fù)，畢竟差不多的方法都需要驗(yàn)證參數(shù)，所以為了方面和簡潔代碼，可以通過抓取全局異常的方式返回提示信息

全局異常處理

通過配置全局異常處理方法，抓取BindException，返回異常提示信息

import com.wxkingbos.patrol.model.WebResult;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 全局異常處理器
 * Created by Raye on 2019-04-15
 */
@ControllerAdvice
public class ExceptionControllerAdvice {

    @ExceptionHandler(BindException.class)
    @ResponseBody
    public String bindExceptionHandler(BindException ex){
        if(ex.hasErrors()){
            List<FieldError> list = ex.getFieldErrors();
            StringBuffer sb = new StringBuffer("參數(shù)：");
            for(FieldError error : list){
                sb.append(error.getField()).append(",");
            }
            sb.append("不符合要求");
            return sb.toString();
        }
        return ex.getMessage();
    }
}

同理，也可以采用此方法抓取其他全局異常，進(jìn)行異常日志捕捉獲取其他異常提示，另外以上全局異常配置只有在Springboot項(xiàng)目上運(yùn)行過，因?yàn)楝F(xiàn)在項(xiàng)目差不多都是基于Springboot構(gòu)建的了，所以也沒有在非Springboot上面測(cè)試過可行性