SpringBoot + validation 接口參數校驗的思路詳解

更新時間：2020年10月22日 10:51:08 作者：乾源

這篇文章主要介紹了SpringBoot + validation 接口參數校驗,本文通過項目實踐+場景分析給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

有參數傳遞的地方都少不了參數校驗。在web開發(fā)中，前端的參數校驗是為了用戶體驗，后端的參數校驗是為了安全。試想一下，如果在controller層中沒有經過任何校驗的參數通過service層、dao層一路來到了數據庫就可能導致嚴重的后果，最好的結果是查不出數據，嚴重一點就是報錯，如果這些沒有被校驗的參數中包含了惡意代碼，那就可能導致更嚴重的后果。

實踐

一、引入依賴

<!--引入spring-boot-starter-validation-->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

二、使用校驗

在controller層的參數校驗可以分為兩種場景：

單個參數校驗
實體類參數校驗

2.1 單參數校驗

/**
 * 參數校驗測試 控制類
 * @author oyc
 */
@RestController
@RequestMapping("user")
@Validated
public class RequestParamsValidatedController {
 
 private Logger logger = LoggerFactory.getLogger(this.getClass());
 
 @GetMapping
 public User test(@NotNull(message = "姓名不能為空") String name,
      @NotNull(message = "年齡不能為空") @Max(value = 99, message = "不能大于200歲") Integer age) {
  logger.info("name:" + name + " -age:" + age);
  return new User(name, age);
 }
}

2.2 實體類參數校驗

/**
 * 參數校驗測試 控制類
 * @author oyc
 */
@RestController
@RequestMapping("user")
@Validated
public class RequestParamsValidatedController {
 
 private Logger logger = LoggerFactory.getLogger(this.getClass());
 
 @PostMapping
 public User save(@Validated User user) {
  logger.info(user.toString());
  return user;
 }
}

package com.oycbest.springbootvalidated.vo;
 
 
import javax.validation.constraints.*;
import java.io.Serializable;
 
/**
 * 用戶實體類
 * @author oyc
 */
public class User implements Serializable {
 private String userId;
 
 @NotNull(message = "用戶名不能為空")
 private String userName;
 
 @NotNull(message = "年齡不能為空")
 @Max(value = 100, message = "年齡不能大于100歲")
 private int age;
 
 @NotNull(message = "郵箱不能為空")
 @Email(message = "郵箱格式不正確")
 private String email;
 
 @NotNull(message = "電話號碼不能為空")
 private String phoneNumber;
 
 public User(@NotNull(message = "用戶名不能為空") String userName, int age) {
  this.userName = userName;
  this.age = age;
 }
 
 public User() {
 }
 
 public User(String userId, @NotNull(message = "用戶名不能為空") String userName, int age, String email, String phoneNumber) {
  this.userId = userId;
  this.userName = userName;
  this.age = age;
  this.email = email;
  this.phoneNumber = phoneNumber;
 }
 
 public String getUserId() {
  return userId;
 }
 
 public void setUserId(String userId) {
  this.userId = userId;
 }
 
 public String getUserName() {
  return userName;
 }
 
 public void setUserName(String userName) {
  this.userName = userName;
 }
 
 public int getAge() {
  return age;
 }
 
 public void setAge(int age) {
  this.age = age;
 }
 
 public String getEmail() {
  return email;
 }
 
 public void setEmail(String email) {
  this.email = email;
 }
 
 public String getPhoneNumber() {
  return phoneNumber;
 }
 
 public void setPhoneNumber(String phoneNumber) {
  this.phoneNumber = phoneNumber;
 }
 
 @Override
 public String toString() {
  return "User{" +
    "userId='" + userId + '\'' +
    ", userName='" + userName + '\'' +
    ", age=" + age +
    ", email='" + email + '\'' +
    ", phoneNumber='" + phoneNumber + '\'' +
    '}';
 }
}

2.3 定義統(tǒng)一異常處理

package com.oycbest.springbootvalidated.exception;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
 
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
import java.util.List;
import java.util.Set;
 
/**
 * 全局異常處理
 *
 * @author oyc
 */
@ControllerAdvice
@Component
public class GlobalExceptionHandler {
 private Logger logger = LoggerFactory.getLogger(this.getClass());
 
 @Bean
 public MethodValidationPostProcessor methodValidationPostProcessor() {
  return new MethodValidationPostProcessor();
 }
 
 @ExceptionHandler
 @ResponseBody
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 public String handle(ValidationException exception) {
  logger.error("請求異常：" + exception.getMessage());
  if (exception instanceof ConstraintViolationException) {
   ConstraintViolationException exs = (ConstraintViolationException) exception;
 
   Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();
   for (ConstraintViolation<?> item : violations) {
    //打印驗證不通過的信息
    logger.error("請求異常：" + item.getMessage());
   }
  }
  return "請求異常： " + exception.getMessage();
 }
 
 @ResponseBody
 @ExceptionHandler(value = BindException.class)
 public String bindException(Exception e) {
  if (e instanceof BindException) {
   BindException exs = (BindException) e;
   List<FieldError> fieldErrors = exs.getFieldErrors();
   for (FieldError item : fieldErrors) {
    logger.error("請求異常：" + item.getDefaultMessage());
   }
  }
  logger.error("數據綁定異常：" + e.getMessage());
  return "數據綁定異常";
 }
 
 @ResponseBody
 @ExceptionHandler(value = Exception.class)
 public String defaultException(Exception e) {
  logger.error("請求異常：" + e.getMessage());
  return "請求異常 " + e.getMessage();
 }
 
}

三、約束性注解(簡單)說明

注解	功能
@AssertFalse	可以為null,如果不為null的話必須為false
@AssertTrue	可以為null,如果不為null的話必須為true
@DecimalMax	設置不能超過最大值
@DecimalMin	設置不能超過最小值
@Digits	設置必須是數字且數字整數的位數和小數的位數必須在指定范圍內
@Future	日期必須在當前日期的未來
@Past	日期必須在當前日期的過去
@Max	最大不得超過此最大值
@Min	最大不得小于此最小值
@NotNull	不能為null，可以是空
@Null	必須為null
@Pattern	必須滿足指定的正則表達式
@Size	集合、數組、map等的size()值必須在指定范圍內
@Email	必須是email格式
@Length	長度必須在指定范圍內
@NotBlank	字符串不能為null,字符串trim()后也不能等于“”
@NotEmpty	不能為null，集合、數組、map等size()不能為0；字符串trim()后可以等于“”
@Range	值必須在指定范圍內
@URL	必須是一個URL