Spring boot validation校驗(yàn)方法實(shí)例
前言

接觸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ō)明
| 驗(yàn)證注解 | 驗(yàn)證的數(shù)據(jù)類(lèi)型 | 說(shuō)明 |
|---|---|---|
| @AssertFalse | Boolean,boolean | 驗(yàn)證注解的元素值是false |
| @AssertTrue | Boolean,boolean | 驗(yàn)證注解的元素值是true |
| @NotNull | 任意類(lèi)型 | 驗(yàn)證注解的元素值不是null |
| @Null | 任意類(lèi)型 | 驗(yàn)證注解的元素值是null |
| @Min(value=值) | BigDecimal,BigInteger, byte,short, int, long,等任何Number或CharSequence(存儲(chǔ)的是數(shù)字)子類(lèi)型 | 驗(yàn)證注解的元素值大于等于@Min指定的value值 |
| @Max(value=值) | 和@Min要求一樣 | 驗(yàn)證注解的元素值小于等于@Max指定的value值 |
| @DecimalMin(value=值) | 和@Min要求一樣 | 驗(yàn)證注解的元素值大于等于@ DecimalMin指定的value值 |
| @DecimalMax(value=值) | 和@Min要求一樣 | 驗(yàn)證注解的元素值小于等于@ DecimalMax指定的value值 |
| @Digits(integer=整數(shù)位數(shù), fraction=小數(shù)位數(shù)) | 和@Min要求一樣 | 驗(yàn)證注解的元素值的整數(shù)位數(shù)和小數(shù)位數(shù)上限 |
| @Size(min=下限, max=上限) | 字符串、Collection、Map、數(shù)組等 | 驗(yàn)證注解的元素值的在min和max(包含)指定區(qū)間之內(nèi),如字符長(zhǎng)度、集合大小 |
| @Past | java.util.Date,java.util.Calendar;Joda Time類(lèi)庫(kù)的日期類(lèi)型 | 驗(yàn)證注解的元素值(日期類(lèi)型)比當(dāng)前時(shí)間早 |
| @Future | 與@Past要求一樣 | 驗(yàn)證注解的元素值(日期類(lèi)型)比當(dāng)前時(shí)間晚 |
| @NotBlank | CharSequence子類(lèi)型 | 驗(yàn)證注解的元素值不為空(不為null、去除首位空格后長(zhǎng)度為0),不同于@NotEmpty,@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的首位空格 |
| @Length(min=下限, max=上限) | CharSequence子類(lèi)型 | 驗(yàn)證注解的元素值長(zhǎng)度在min和max區(qū)間內(nèi) |
| @NotEmpty | CharSequence子類(lèi)型、Collection、Map、數(shù)組 | 驗(yàn)證注解的元素值不為null且不為空(字符串長(zhǎng)度不為0、集合大小不為0) |
| @Range(min=最小值, max=最大值) | BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類(lèi)型和包裝類(lèi)型 | 驗(yàn)證注解的元素值在最小值和最大值之間 |
| @Email(regexp=正則表達(dá)式,flag=標(biāo)志的模式) | CharSequence子類(lèi)型(如String) | 驗(yàn)證注解的元素值是Email,也可以通過(guò)regexp和flag指定自定義的email格式 |
| @Pattern(regexp=正則表達(dá)式,flag=標(biāo)志的模式) | String,任何CharSequence的子類(lèi)型 | 驗(yàn)證注解的元素值與指定的正則表達(dá)式匹配 |
| @Valid | 任何非原子類(lèi)型 | 指定遞歸驗(yàn)證關(guān)聯(lián)的對(duì)象如用戶(hù)對(duì)象中有個(gè)地址對(duì)象屬性,如果想在驗(yàn)證用戶(hù)對(duì)象時(shí)一起驗(yàn)證地址對(duì)象的話,在地址對(duì)象上加@Valid注解即可 |
此處只列出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í)際字符
總結(jié)
到此這篇關(guān)于Spring boot validation校驗(yàn)的文章就介紹到這了,更多相關(guān)Springboot validation校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- springboot使用校驗(yàn)框架validation校驗(yàn)的示例
- springboot+dubbo+validation 進(jìn)行rpc參數(shù)校驗(yàn)的實(shí)現(xiàn)方法
- spring boot validation參數(shù)校驗(yàn)實(shí)例分析
- SpringBoot使用validation-api實(shí)現(xiàn)對(duì)枚舉類(lèi)參數(shù)校驗(yàn)的方法
- SpringBoot使用validation-api實(shí)現(xiàn)參數(shù)校驗(yàn)的示例
- SpringBoot集成validation校驗(yàn)參數(shù)遇到的坑
- SpringBoot + validation 接口參數(shù)校驗(yàn)的思路詳解
- springboot使用hibernate validation對(duì)參數(shù)校驗(yàn)的實(shí)現(xiàn)方法
相關(guān)文章
Java日常練習(xí)題,每天進(jìn)步一點(diǎn)點(diǎn)(33)
下面小編就為大家?guī)?lái)一篇Java基礎(chǔ)的幾道練習(xí)題(分享)。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧,希望可以幫到你2021-07-07
Mybatis-Plus自定義集合類(lèi)型的類(lèi)型處理器詳解
這篇文章主要介紹了Mybatis-Plus自定義集合類(lèi)型的類(lèi)型處理器詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01
Java開(kāi)發(fā)中的容器概念、分類(lèi)與用法深入詳解
這篇文章主要介紹了Java開(kāi)發(fā)中的容器概念、分類(lèi)與用法,結(jié)合實(shí)例形式較為詳細(xì)的分析了java容器的相關(guān)概念、分類(lèi)、使用方法與注意事項(xiàng),需要的朋友可以參考下2017-11-11
java無(wú)鎖hashmap原理與實(shí)現(xiàn)詳解
本文主要介紹了java無(wú)鎖hashmap原理與實(shí)現(xiàn),大家參考使用吧2014-01-01
深入學(xué)習(xí)MyBatis中的參數(shù)(推薦)
大家日常使用MyBatis經(jīng)常會(huì)遇到一些異常,想要避免參數(shù)引起的錯(cuò)誤,我們需要深入了解參數(shù)。想了解參數(shù),我們首先看MyBatis處理參數(shù)和使用參數(shù)的全部過(guò)程。下面這篇文章主要給大家介紹了MyBatis中參數(shù)的的相關(guān)資料,需要的朋友可以參考借鑒,下面來(lái)一起看看吧。2017-06-06
vue+springboot+shiro+jwt實(shí)現(xiàn)登錄功能
這篇文章主要介紹了vue+springboot+shiro+jwt實(shí)現(xiàn)登錄功能,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-04-04

