SpringBoot使用Validator進(jìn)行參數(shù)校驗(yàn)實(shí)戰(zhàn)教程(自定義校驗(yàn)，分組校驗(yàn))
在日常的接口開(kāi)發(fā)中，為了防止非法參數(shù)對(duì)業(yè)務(wù)造成影響，經(jīng)常需要對(duì)接口的參數(shù)做校驗(yàn)，例如登錄的時(shí)候需要校驗(yàn)用戶名密碼是否為空，創(chuàng)建用戶的時(shí)候需要校驗(yàn)郵件、手機(jī)號(hào)碼格式是否準(zhǔn)確?？看a對(duì)接口參數(shù)一個(gè)個(gè)校驗(yàn)的話就太繁瑣了，代碼可讀性極差。因?yàn)榫W(wǎng)絡(luò)傳輸?shù)牟豢煽啃?，以及前端?shù)據(jù)控制的可篡改性，后端的參數(shù)校驗(yàn)是必須的，應(yīng)用程序必須通過(guò)某種手段來(lái)確保輸入進(jìn)來(lái)的數(shù)據(jù)從語(yǔ)義上來(lái)講是正確的。
Validator校驗(yàn)框架遵循了JSR-303驗(yàn)證規(guī)范（參數(shù)校驗(yàn)規(guī)范）, JSR是Java Specification Requests的縮寫(xiě)。Validator專(zhuān)門(mén)用來(lái)進(jìn)行接口參數(shù)校驗(yàn)，例如常見(jiàn)的必填校驗(yàn)，email格式校驗(yàn)，用戶名必須位于6到12之間等，就是為了解決開(kāi)發(fā)人員在開(kāi)發(fā)的時(shí)候少寫(xiě)代碼，提升開(kāi)發(fā)效率。
一、SpringBoot集成參數(shù)校驗(yàn)
1. 引入依賴
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
注：從springboot-2.3開(kāi)始，校驗(yàn)包被獨(dú)立成了一個(gè)starter組件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依賴就可以了。
2. 定義實(shí)體類(lèi)
在實(shí)際開(kāi)發(fā)中對(duì)于需要校驗(yàn)的字段都需要設(shè)置對(duì)應(yīng)的業(yè)務(wù)提示，即message屬性。
@Data
public class ValidVO {
private String id;
@Length(min = 6,max = 12,message = "appId長(zhǎng)度必須位于6到12之間")
private String appId;
@NotBlank(message = "名字為必填項(xiàng)")
private String name;
@Email(message = "請(qǐng)?zhí)顚?xiě)正確的郵箱地址")
private String email;
private String sex;
@NotEmpty(message = "級(jí)別不能為空")
private String level;
}常見(jiàn)約束注解如下：
| 注解 | 功能 |
|---|---|
| @AssertFalse | 可以為null,如果不為null的話必須為false |
| @AssertTrue | 可以為null,如果不為null的話必須為true |
| @DecimalMax | 設(shè)置不能超過(guò)最大值 |
| @DecimalMin | 設(shè)置不能超過(guò)最小值 |
| @Digits | 設(shè)置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi) |
| @Future | 日期必須在當(dāng)前日期的未來(lái) |
| @Past | 日期必須在當(dāng)前日期的過(guò)去 |
| @Max | 最大不得超過(guò)此最大值 |
| @Min | 最大不得小于此最小值 |
| @NotNull | 不能為null，可以是空 |
| @Null | 必須為null |
| @Pattern | 必須滿足指定的正則表達(dá)式 |
| @Size | 集合、數(shù)組、map等的size()值必須在指定范圍內(nèi) |
| 必須是email格式 | |
| @Length | 長(zhǎng)度必須在指定范圍內(nèi) |
| @NotBlank | 字符串不能為null,字符串trim()后也不能等于“” |
| @NotEmpty | 不能為null，集合、數(shù)組、map等size()不能為0；字符串trim()后可以等于“” |
| @Range | 值必須在指定范圍內(nèi) |
| @URL | 必須是一個(gè)URL |
3. 校驗(yàn)測(cè)試
@RestController
@Slf4j
@Validated
public class ValidController {
@ApiOperation("RequestBody校驗(yàn)")
@PostMapping("/valid/test1")
public String test1(@Validated @RequestBody ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test1 valid success";
}
@ApiOperation("Form校驗(yàn)")
@PostMapping(value = "/valid/test2")
public String test2(@Validated ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test2 valid success";
}
@ApiOperation("單參數(shù)校驗(yàn)")
@PostMapping(value = "/valid/test3")
public String test3(@Email String email){
log.info("email is {}", email);
return "email valid success";
}
}這里先定義三個(gè)方法test1，test2，test3。test1使用了@RequestBody注解，用于接受前端發(fā)送的json數(shù)據(jù)，test2模擬表單提交，test3模擬單參數(shù)提交。注意，當(dāng)使用單參數(shù)校驗(yàn)時(shí)需要在Controller上加上@Validated注解，否則不生效。
4. 檢查效果
1.調(diào)用test1方法，提示的是org.springframework.web.bind.MethodArgumentNotValidException異常
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}{
"status": 500,
"message": "Validation failed for argument [0] in public java.lang.String com.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一個(gè)合法的電子郵件地址]]...",
"data": null,
"timestamp": 1628239624332
}2.調(diào)用test2方法，提示的是org.springframework.validation.BindException異常
POST http://localhost:8080/valid/test2
Content-Type: application/x-www-form-urlencoded
id=1&level=12&email=476938977&appId=ab1c
{
"status": 500,
"message": "org.springframework.validation.BeanPropertyBindingResult: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字為必填項(xiàng)]...",
"data": null,
"timestamp": 1628239301951
}調(diào)用test3方法，提示的是javax.validation.ConstraintViolationException異常
POST http://localhost:8080/valid/test3
Content-Type: application/x-www-form-urlencoded
email=476938977
{
"status": 500,
"message": "test3.email: 不是一個(gè)合法的電子郵件地址",
"data": null,
"timestamp": 1628239281022
}通過(guò)加入Validator校驗(yàn)框架可以幫助我們自動(dòng)實(shí)現(xiàn)參數(shù)的校驗(yàn)。
二、參數(shù)異常加入全局異常處理器
雖然我們之前定義了全局異常攔截器，也看到了攔截器確實(shí)生效了，但是Validator校驗(yàn)框架返回的錯(cuò)誤提示太臃腫了，不便于閱讀，為了方便前端提示，我們需要將其簡(jiǎn)化一下。
直接修改之前定義的RestExceptionHandler，單獨(dú)攔截參數(shù)校驗(yàn)的三個(gè)異常：javax.validation.ConstraintViolationException，org.springframework.validation.BindException，org.springframework.web.bind.MethodArgumentNotValidException，代碼如下：
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseEntity<ResultData<String>> handleValidatedException(Exception e) {
ResultData<String> resp = null;
if (e instanceof MethodArgumentNotValidException) {
// BeanValidation exception
MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getBindingResult().getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof ConstraintViolationException) {
// BeanValidation GET simple param
ConstraintViolationException ex = (ConstraintViolationException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getConstraintViolations().stream()
.map(ConstraintViolation::getMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof BindException) {
// BeanValidation GET object param
BindException ex = (BindException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
}
return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
}體驗(yàn)效果
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}{
"status": 400,
"message": "名字為必填項(xiàng); 不是一個(gè)合法的電子郵件地址; appId長(zhǎng)度必須位于6到12之間",
"data": null,
"timestamp": 1628435116680
}是不是感覺(jué)清爽多了？
三、自定義參數(shù)校驗(yàn)
雖然Spring Validation 提供的注解基本上夠用，但是面對(duì)復(fù)雜的定義，還是需要自己定義相關(guān)注解來(lái)實(shí)現(xiàn)自動(dòng)校驗(yàn)。比如sex性別屬性，只允許前端傳遞傳 M，F(xiàn) 這2個(gè)枚舉值，如何實(shí)現(xiàn)呢？
1. 創(chuàng)建自定義注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//標(biāo)明由哪個(gè)類(lèi)執(zhí)行校驗(yàn)邏輯
public @interface EnumString {
String message() default "value not in enum values.";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
* @return date must in this value array
*/
String[] value();
/**
* Defines several {@link EnumString} annotations on the same element.
*
* @see EnumString
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@interface List {
EnumString[] value();
}
}2. 自定義校驗(yàn)邏輯
public class EnumStringValidator implements ConstraintValidator<EnumString, String> {
private List<String> enumStringList;
@Override
public void initialize(EnumString constraintAnnotation) {
enumStringList = Arrays.asList(constraintAnnotation.value());
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if(value == null){
return true;
}
return enumStringList.contains(value);
}
}3. 在字段上增加注解
@ApiModelProperty(value = "性別")
@EnumString(value = {"F","M"}, message="性別只允許為F或M")
private String sex;4. 檢查效果
POST http://localhost:8080/valid/test2
Content-Type: application/x-www-form-urlencoded
id=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N
{
"status": 400,
"message": "性別只允許為F或M",
"data": null,
"timestamp": 1628435243723
}四、分組校驗(yàn)
一個(gè)VO對(duì)象在新增的時(shí)候某些字段為必填，在更新的時(shí)候又非必填。如上面的ValidVO中 id 和 appId 屬性在新增操作時(shí)都是非必填，而在編輯操作時(shí)都為必填，name在新增操作時(shí)為必填，面對(duì)這種場(chǎng)景你會(huì)怎么處理呢？
在實(shí)際開(kāi)發(fā)中可能會(huì)建立兩個(gè)VO對(duì)象，ValidCreateVO，ValidEditVO來(lái)處理這種場(chǎng)景，這樣確實(shí)也能實(shí)現(xiàn)效果，但是會(huì)造成類(lèi)膨脹。
其實(shí)Validator校驗(yàn)框架已經(jīng)考慮到了這種場(chǎng)景并且提供了解決方案，就是分組校驗(yàn)。要使用分組校驗(yàn)，只需要三個(gè)步驟：
1. 定義分組接口
public interface ValidGroup extends Default {
interface Crud extends ValidGroup{
interface Create extends Crud{
}
interface Update extends Crud{
}
interface Query extends Crud{
}
interface Delete extends Crud{
}
}
}這里我們定義一個(gè)分組接口ValidGroup讓其繼承javax.validation.groups.Default，再在分組接口中定義出多個(gè)不同的操作類(lèi)型，Create，Update，Query，Delete。至于為什么需要繼承Default我們稍后再說(shuō)。
2. 在模型中給參數(shù)分配分組
@Data
@ApiModel(value = "參數(shù)校驗(yàn)類(lèi)")
public class ValidVO {
@ApiModelProperty("ID")
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = "應(yīng)用ID不能為空")
private String id;
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = "應(yīng)用ID不能為空")
@ApiModelProperty(value = "應(yīng)用ID",example = "cloud")
private String appId;
@ApiModelProperty(value = "名字")
@NotBlank(groups = ValidGroup.Crud.Create.class,message = "名字為必填項(xiàng)")
private String name;
@ApiModelProperty(value = "郵箱")
@Email(message = "請(qǐng)?zhí)顚?xiě)正取的郵箱地址")
privte String email;
}給參數(shù)指定分組，對(duì)于未指定分組的則使用的是默認(rèn)分組。
3. 給需要參數(shù)校驗(yàn)的方法指定分組
@RestController
@Api("參數(shù)校驗(yàn)")
@Slf4j
@Validated
public class ValidController {
@ApiOperation("新增")
@PostMapping(value = "/valid/add")
public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test3 valid success";
}
@ApiOperation("更新")
@PostMapping(value = "/valid/update")
public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test4 valid success";
}
}這里我們通過(guò)value屬性給add()和update()方法分別指定Create和Update分組。
4. 檢查效果
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded name=javadaily&level=12&email=476938977@qq.com&sex=F
在Create時(shí)我們沒(méi)有傳遞id和appId參數(shù)，校驗(yàn)通過(guò)。
當(dāng)我們使用同樣的參數(shù)調(diào)用update方法時(shí)則提示參數(shù)校驗(yàn)錯(cuò)誤。
{
"status": 400,
"message": "ID不能為空; 應(yīng)用ID不能為空",
"data": null,
"timestamp": 1628492514313
}由于email屬于默認(rèn)分組，而我們的分組接口ValidGroup已經(jīng)繼承了Default分組，所以也是可以對(duì)email字段作參數(shù)校驗(yàn)的。如：
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded name=javadaily&level=12&email=476938977&sex=F
{
"status": 400,
"message": "請(qǐng)?zhí)顚?xiě)正取的郵箱地址",
"data": null,
"timestamp": 1628492637305
}當(dāng)然如果你的ValidGroup沒(méi)有繼承Default分組，那在代碼屬性上就需要加上@Validated(value = {ValidGroup.Crud.Create.class, Default.class}才能讓email字段的校驗(yàn)生效。
到此這篇關(guān)于SpringBoot使用Validator進(jìn)行參數(shù)校驗(yàn)（自定義校驗(yàn)，分組校驗(yàn)）的文章就介紹到這了,更多相關(guān)SpringBoot Validator校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
- 如何通過(guò)自定義spring?invalidator注解校驗(yàn)數(shù)據(jù)合法性
- Spring 校驗(yàn)(validator,JSR-303)簡(jiǎn)單實(shí)現(xiàn)方式
- springboot validator枚舉值校驗(yàn)功能實(shí)現(xiàn)
- SpringBoot 使用hibernate validator校驗(yàn)
- Spring中校驗(yàn)器(Validator)的深入講解
- springboot使用Validator校驗(yàn)方式
- springboot使用hibernate validator校驗(yàn)方式
- Spring Validator從零掌握對(duì)象校驗(yàn)的詳細(xì)過(guò)程
相關(guān)文章
Java刷題之最小k個(gè)數(shù)的思路及具體實(shí)現(xiàn)
這篇文章主要介紹了Java刷題之最小k個(gè)數(shù)的思路及具體實(shí)現(xiàn),最小K個(gè)數(shù)是一個(gè)經(jīng)典的top-K問(wèn)題,可以通過(guò)整體排序、建立小根堆或大根堆的方式解決,排序方式時(shí)間復(fù)雜度較高,適合數(shù)據(jù)量小的場(chǎng)景,小根堆適合k較小的情況,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-10-10
Spring實(shí)戰(zhàn)之Qualifier注解用法示例
這篇文章主要介紹了Spring實(shí)戰(zhàn)之Qualifier注解用法,結(jié)合實(shí)例形式詳細(xì)分析了spring Qualifier注解相關(guān)配置、定義與使用方法,需要的朋友可以參考下2019-12-12
Netty分布式高性能工具類(lèi)recycler的使用及創(chuàng)建
這篇文章主要為大家介紹了Netty分布式高性能工具類(lèi)recycler的使用和創(chuàng)建，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步2022-03-03
java實(shí)現(xiàn)登錄之后抓取數(shù)據(jù)
這篇文章給大家分享了用JAVA實(shí)現(xiàn)在登陸以后抓取網(wǎng)站的數(shù)據(jù)的相關(guān)知識(shí)，有興趣的朋友可以測(cè)試參考下。2018-07-07
以下是關(guān)于string的七種用法，注意哦，記得要時(shí)常去查看java的API文檔，那個(gè)里面也有很詳細(xì)的介紹2013-10-10
SpringData JPA實(shí)現(xiàn)查詢分頁(yè)demo
本篇文章主要介紹了SpringData JPA實(shí)現(xiàn)查詢分頁(yè)demo，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-03-03
JAVA實(shí)現(xiàn)按時(shí)間段查詢數(shù)據(jù)操作
這篇文章主要介紹了JAVA實(shí)現(xiàn)按時(shí)間段查詢數(shù)據(jù)操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-08-08
Java 多線程Synchronized和Lock的區(qū)別
這篇文章主要介紹了Java 多線程Synchronized和Lock的區(qū)別，幫助大家更好的理解和使用Java，感興趣的朋友可以了解下2021-01-01
詳解Java中二叉樹(shù)的基礎(chǔ)概念(遞歸&迭代)
二叉樹(shù)（Binary?tree）是樹(shù)形結(jié)構(gòu)的一個(gè)重要類(lèi)型。本文將通過(guò)圖片和示例代碼詳細(xì)為大家講解一下Java中的二叉樹(shù)的基礎(chǔ)概念，需要的可以參考一下2022-03-03
Java實(shí)現(xiàn)多文件壓縮加密并重命名壓縮文件對(duì)象的方法
這篇文章主要介紹了Java實(shí)現(xiàn)多文件壓縮加密并重命名壓縮文件對(duì)象的方法,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-01-01