Spring Boot ：使用 validation 驗證參數

一、簡介

　　開發web項目有時候我們需要對controller層傳過來的參數進行一些基本的校驗，比如非空，非null，整數值的范圍，字符串的個數，日期，郵箱等等。最常見的就是我們直接寫代碼校驗，這樣以后比較繁瑣，而且不夠靈活。 
　　Bean Validation 1.0（JSR-303）是一個校驗規范，在Spring Boot項目由於自帶了Hibernate validator 5(http://hibernate.org/validator/)實現，所以我們可以非常方便的使用這個特性 

 

二、關鍵使用

1、添加包

　　hibernate-validator

    <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>6.0.2.Final</version>
    </dependency>

　　或者添加spring-boot-starter-validation

     <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation -->
     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-validation</artifactId>
         <version>1.4.0.RELEASE</version>
     </dependency>

　　或者添加spring-boot-starter-web

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

 

2、注解說明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，且trim后長度必須大於0    
@Email  被注釋的元素必須是電子郵箱地址    
@Length(min=,max=)  被注釋的字符串的大小必須在指定的范圍內    
@NotEmpty   被注釋的字符串的必須非空    
@Range(min=,max=,message=)  被注釋的元素必須在合適的范圍內

@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、Controller添加@Valid或者@Validated都可以

@RestController
@RequestMapping("/")
public class UserController {
    
    @RequestMapping("testValidation")
    public String testValidation(@Valid @RequestBody UserRequest userRequest) {
        return "success";
    }
}

 

2、實體類添加校驗注解

import java.io.Serializable;
import javax.validation.constraints.Max;
import javax.validation.constraints.Pattern;
import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotEmpty;
import org.hibernate.validator.constraints.Range;
import lombok.Data;

@Data
public class UserRequest implements Serializable{

    private static final long serialVersionUID = 1L;
    
    @NotEmpty(message="用戶id不能為空")
    private String userId;
    
    @Email(message="非法郵件地址")
    private String email;
    
    @Pattern(regexp="^(\\d{6})(\\d{4})(\\d{2})(\\d{2})(\\d{3})([0-9]|X)$",message="身份證號不合規")
    private String cardNo;
    
    @Length(min=1,max=10,message="昵稱長度必須在1~10")
    private String nickName;
    
    @Range(min=0,max=2,message="非法性別")
    private String sex;
    
    @Max(value=100,message="非法年齡")
    private int age;

}

 

3、添加全局異常攔截

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
    
    /**
     * 參數合法性校驗異常
     * @param exception
     * @return
     */
    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public String validationBodyException(MethodArgumentNotValidException exception){

        StringBuffer buffer = new StringBuffer();
        
        BindingResult result  = exception.getBindingResult();
        if (result.hasErrors()) {

            List<ObjectError> errors = result.getAllErrors();

            errors.forEach(p ->{

                FieldError fieldError = (FieldError) p;
                log.error("Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+
                        "},errorMessage{"+fieldError.getDefaultMessage()+"}");
                buffer.append(fieldError.getDefaultMessage()).append(",");
            });
        }
        BaseResponse response = new BaseResponse(BusinessCodeEnum.INVALID_PARAM);
        response.setRespMsg(buffer.toString().substring(0, buffer.toString().length()-1));
        return JSONObject.toJSONString(response);
    }

}

 

 

四、備注

　　參考鏈接： https://www.cnblogs.com/hongdada/p/9179053.html