Springboot validation 校驗方法

前言

接觸springboot一年多，是時候擺脫這種校驗方式了233 ，每個引數都if判斷，一眼看過去就是很low的程式員，

Validation有了這個插件就再也不用這樣去校驗引數了，可以讓我們在專案中不用浪費很多時間在引數校驗這里，從而更專注于業務邏輯

正文

首先引入依賴

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

這里創建一個用戶的DTO物件

@Data
@ApiModel("用戶-表單物件")
public class SportsUserCreatForm{

  @ApiModelProperty(value="用戶唯一標識",example = "0")
  @NotNull(groups = {Update.class})
  private long id;
  
  @ApiModelProperty(value = "所屬機構唯一標識(冗余欄位)", example = "0")
  private long organizationId;
  
  @ApiModelProperty("登錄用戶名")
  @NotBlank(message = "用戶名不能為空")
  @Length(max = 10, message = "用戶名最長為10位")
  private String loginName;
  
  @ApiModelProperty("密碼")
  private String password;
  
  @ApiModelProperty("手機號")
  private String phone;
  
  @ApiModelProperty("郵箱")
  private String email;

  @ApiModelProperty("性別( 'MALE', 'FEMALE' )")
  @NotNull(message = "用戶性別不能為空")
  private SportsUserEnumGender gander;
  
  @ApiModelProperty(value = "出生日期-13位時間戳",example = "0")
  private long birthday;
  
  @ApiModelProperty("身份證號")
  private String idNumber;
  
  @ApiModelProperty("用戶昵稱")
  private String nickname;
  
}

在controller層添加@Validated注解，添加注解之后spring就會逐個校驗DTO中加了校驗注解的欄位，完全通過才可以進入業務處理，否則就會拋出MethodArgumentNotValidException例外

  @PostMapping("user/add")
  @RequiresAuthentication
  @ApiOperation("添加用戶")
  public SportsUser addUser(@Validated @RequestBody SportsUserCreatForm user) throws Exception{
    return userBiz.addUser(user);
  }

一般專案來說拋出例外都會有約定好的JSON格式回傳錯誤碼和錯誤資訊，如果不處理就無法按照約定格式回傳，這里我們可以通過宣告全域例外處理類來攔截例外并將例外處理成前端能操作的JSON資料，（這里只需要關注MethodArgumentNotValidException例外）

@Slf4j
@Order(Ordered.HIGHEST_PRECEDENCE)
@RestControllerAdvice
public class GlobalExceptionAdvice {

  @ExceptionHandler(MethodArgumentNotValidException.class)
  @ResponseBody
  public ResponseEntity<Object> handleBeanValidation(HttpServletResponse res, MethodArgumentNotValidException e) throws Exception{
    res.setStatus(HttpStatus.OK.value());
    List<ObjectError> errors = e.getBindingResult().getAllErrors();
    ObjectError error = errors.get(0);// 如果有多個例外,這里只取第一個例外，沒有必要把所有例外都拋出（錯就是錯，第一個校驗都沒通過，自然也輪不到第二個校驗，）
    String json = JsonUtils.obj2json(error);
    Map map = JsonUtils.json2map(json);
    OkMessage result = new OkMessage();
    result.setMsg("請求引數錯誤"e.getBindingResult().getFieldError().getDefaultMessage() + "]");
    result.setCode("PARAM-000001");
    return new ResponseEntity<>(result, HttpStatus.OK);
  }
}

分組校驗

有的人就要發問了，"啊，你這校驗不行啊，我在添加的時候id是自動生成的不需要校驗，編輯的時候就需要校驗id了，我是不是要建兩個一模一樣的DTO，這樣豈不是顯得我很憨？！這不是增加無用代碼嗎？差評！"

其實不然，在此我們可以用到 groups 屬性來解決此場景下的問題，

宣告分組

注意:在宣告分組的時候盡量繼承 extend javax.validation.groups.Default， 否則，在你宣告@Validated(Update.class)的時候,就會出現你在默認沒添加groups = {}的時候的校驗組@Email(message = "郵箱格式不對")不會自動校驗，因為默認的校驗組是groups = {Default.class}，

import javax.validation.groups.Default;

/**
 * 資料新增分組
 */
public interface Create extends Default {
 
}

 
import javax.validation.groups.Default;
 
/**
 * 資料更新分組
 */
public interface Update extends Default {
 
}

修改Controller中的@Validated注解，宣告校驗分組(下面用的是Create.class所以并不會校驗id)

  @PostMapping("user/add")
  @RequiresAuthentication
  @ApiOperation("添加用戶")
  public SportsUser addUser(@Validated(Create.class) @RequestBody SportsUserCreatForm user) throws Exception{
    return userBiz.addUser(user);
  }

下面附上注解說明

此處只列出Hibernate Validator提供的大部分驗證約束注解，請參考hibernate validator官方檔案了解其他驗證約束注解和進行自定義的驗證約束注解定義，

常用的幾個:
1.@NotNull：不能為null，但可以為empty(""," ","   ")
2.@NotEmpty：不能為null，而且長度必須大于0 (" ","  ")
3.@NotBlank：只能作用在String上，不能為null，而且呼叫trim()后，長度必須大于0("test")    即：必須有實際字符