怎么在Spring boot中利用validation進(jìn)行校驗(yàn)

這篇文章主要為大家詳細(xì)介紹了怎么在Spring boot中利用validation進(jìn)行校驗(yàn)，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，發(fā)現(xiàn)的小伙伴們可以參考一下：

前言

接觸springboot一年多，是時(shí)候擺脫這種校驗(yàn)方式了233 ，每個(gè)參數(shù)都if判斷，一眼看過(guò)去就是很low的程序員。

Validation有了這個(gè)插件就再也不用這樣去校驗(yàn)參數(shù)了，可以讓我們?cè)陧?xiàng)目中不用浪費(fèi)很多時(shí)間在參數(shù)校驗(yàn)這里，從而更專(zhuān)注于業(yè)務(wù)邏輯

正文

首先引入依賴(lài)

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

這里創(chuàng)建一個(gè)用戶(hù)的DTO對(duì)象

@Data
@ApiModel("用戶(hù)-表單對(duì)象")
public class SportsUserCreatForm{
 
 @ApiModelProperty(value="用戶(hù)唯一標(biāo)識(shí)",example = "0")
 @NotNull(groups = {Update.class})
 private long id;
 
 @ApiModelProperty(value = "所屬機(jī)構(gòu)唯一標(biāo)識(shí)(冗余字段)", example = "0")
 private long organizationId;
 
 @ApiModelProperty("登錄用戶(hù)名")
 @NotBlank(message = "用戶(hù)名不能為空")
 @Length(max = 10, message = "用戶(hù)名最長(zhǎng)為10位")
 private String loginName;
 
 @ApiModelProperty("密碼")
 private String password;
 
 @ApiModelProperty("手機(jī)號(hào)")
 private String phone;
 
 @ApiModelProperty("郵箱")
 private String email;
 
 @ApiModelProperty("性別( 'MALE', 'FEMALE' )")
 @NotNull(message = "用戶(hù)性別不能為空")
 private SportsUserEnumGender gander;
 
 @ApiModelProperty(value = "出生日期-13位時(shí)間戳",example = "0")
 private long birthday;
 
 @ApiModelProperty("身份證號(hào)")
 private String idNumber;
 
 @ApiModelProperty("用戶(hù)昵稱(chēng)")
 private String nickname;
 
}

在controller層添加@Validated注解，添加注解之后spring就會(huì)逐個(gè)校驗(yàn)DTO中加了校驗(yàn)注解的字段，完全通過(guò)才可以進(jìn)入業(yè)務(wù)處理，否則就會(huì)拋出MethodArgumentNotValidException異常

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

一般項(xiàng)目來(lái)說(shuō)拋出異常都會(huì)有約定好的JSON格式返回錯(cuò)誤碼和錯(cuò)誤信息，如果不處理就無(wú)法按照約定格式返回。這里我們可以通過(guò)聲明全局異常處理類(lèi)來(lái)攔截異常并將異常處理成前端能操作的JSON數(shù)據(jù)。（這里只需要關(guān)注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);// 如果有多個(gè)異常,這里只取第一個(gè)異常。沒(méi)有必要把所有異常都拋出（錯(cuò)就是錯(cuò)，第一個(gè)校驗(yàn)都沒(méi)通過(guò)，自然也輪不到第二個(gè)校驗(yàn)。）
 String json = JsonUtils.obj2json(error);
 Map map = JsonUtils.json2map(json);
 OkMessage result = new OkMessage();
 result.setMsg("請(qǐng)求參數(shù)錯(cuò)誤"e.getBindingResult().getFieldError().getDefaultMessage() + "]");
 result.setCode("PARAM-000001");
 return new ResponseEntity<>(result, HttpStatus.OK);
 }
}

分組校驗(yàn)

有的人就要發(fā)問(wèn)了，"啊，你這校驗(yàn)不行啊，我在添加的時(shí)候id是自動(dòng)生成的不需要校驗(yàn)，編輯的時(shí)候就需要校驗(yàn)id了，我是不是要建兩個(gè)一模一樣的DTO，這樣豈不是顯得我很憨？！這不是增加無(wú)用代碼嗎？差評(píng)！"

 其實(shí)不然，在此我們可以用到 groups 屬性來(lái)解決此場(chǎng)景下的問(wèn)題。

聲明分組

注意:在聲明分組的時(shí)候盡量繼承 extend javax.validation.groups.Default。 否則，在你聲明@Validated(Update.class)的時(shí)候,就會(huì)出現(xiàn)你在默認(rèn)沒(méi)添加groups = {}的時(shí)候的校驗(yàn)組@Email(message = "郵箱格式不對(duì)")不會(huì)自動(dòng)校驗(yàn)，因?yàn)槟J(rèn)的校驗(yàn)組是groups = {Default.class}。

 import javax.validation.groups.Default;
 
/**
 * 數(shù)據(jù)新增分組
 */
public interface Create extends Default {
 
}

 import javax.validation.groups.Default;
 
/**
 * 數(shù)據(jù)更新分組
 */
public interface Update extends Default {
 
}

修改Controller中的@Validated注解，聲明校驗(yàn)分組(下面用的是Create.class所以并不會(huì)校驗(yàn)id)

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

下面附上注解說(shuō)明

此處只列出Hibernate Validator提供的大部分驗(yàn)證約束注解，請(qǐng)參考hibernate validator官方文檔了解其他驗(yàn)證約束注解和進(jìn)行自定義的驗(yàn)證約束注解定義。

常用的幾個(gè):
1.@NotNull：不能為null，但可以為empty(""," ","   ")
2.@NotEmpty：不能為null，而且長(zhǎng)度必須大于0 (" ","  ")
3.@NotBlank：只能作用在String上，不能為null，而且調(diào)用trim()后，長(zhǎng)度必須大于0("test")    即：必須有實(shí)際字符

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。