java開發(fā)SpringBoot參數(shù)校驗過程示例教程
大家好，我是飄渺。
前幾天寫了一篇SpringBoot如何統(tǒng)一后端返回格式？老鳥們都是這樣玩的！
閱讀效果還不錯，而且被很多號主都轉(zhuǎn)載過，今天我們繼續(xù)第二篇，來聊聊在SprinBoot中如何集成參數(shù)校驗Validator，以及參數(shù)校驗的高階技巧（自定義校驗，分組校驗）。
此文是依賴于前文的代碼基礎(chǔ)，已經(jīng)在項目中加入了全局異常校驗器。（代碼倉庫在文末）
首先我們來看看什么是Validator參數(shù)校驗器，為什么需要參數(shù)校驗？
為什么需要參數(shù)校驗
在日常的接口開發(fā)中，為了防止非法參數(shù)對業(yè)務(wù)造成影響，經(jīng)常需要對接口的參數(shù)做校驗，例如登錄的時候需要校驗用戶名密碼是否為空，創(chuàng)建用戶的時候需要校驗郵件、手機號碼格式是否準(zhǔn)確?？看a對接口參數(shù)一個個校驗的話就太繁瑣了，代碼可讀性極差。
Validator框架就是為了解決開發(fā)人員在開發(fā)的時候少寫代碼，提升開發(fā)效率；Validator專門用來進行接口參數(shù)校驗，例如常見的必填校驗，email格式校驗，用戶名必須位于6到12之間 等等…
Validator校驗框架遵循了JSR-303驗證規(guī)范（參數(shù)校驗規(guī)范）,
JSR是 Java Specification Requests的縮寫。
接下來我們看看在SpringbBoot中如何集成參數(shù)校驗框架。
SpringBoot中集成參數(shù)校驗
第一步，引入依賴
<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開始，校驗包被獨立成了一個 starter組件，所以需要引入validation和web
而 springboot-2.3之前的版本只需要引入 web 依賴就可以了。
第二步，定義要參數(shù)校驗的實體類
@Data
public class ValidVO {
private String id;
@Length(min = 6,max = 12,message = "appId長度必須位于6到12之間")
private String appId;
@NotBlank(message = "名字為必填項")
private String name;
@Email(message = "請?zhí)顚懻_的郵箱地址")
private String email;
private String sex;
@NotEmpty(message = "級別不能為空")
private String level;
}
在實際開發(fā)中對于需要校驗的字段都需要設(shè)置對應(yīng)的業(yè)務(wù)提示，即message屬性。
常見的約束注解如下：
| 注解 | 功能 |
|---|---|
| @AssertFalse | 可以為null,如果不為null的話必須為false |
| @AssertTrue | 可以為null,如果不為null的話必須為true |
| @DecimalMax | 設(shè)置不能超過最大值 |
| @DecimalMin | 設(shè)置不能超過最小值 |
| @Digits | 設(shè)置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi) |
| @Future | 日期必須在當(dāng)前日期的未來 |
| @Past | 日期必須在當(dāng)前日期的過去 |
| @Max | 最大不得超過此最大值 |
| @Min | 最大不得小于此最小值 |
| @NotNull | 不能為null，可以是空 |
| @Null | 必須為null |
| @Pattern | 必須滿足指定的正則表達式 |
| @Size | 集合、數(shù)組、map等的size()值必須在指定范圍內(nèi) |
| 必須是email格式 | |
| @Length | 長度必須在指定范圍內(nèi) |
| @NotBlank | 字符串不能為null,字符串trim()后也不能等于“” |
| @NotEmpty | 不能為null，集合、數(shù)組、map等size()不能為0；字符串trim()后可以等于“” |
| @Range | 值必須在指定范圍內(nèi) |
| @URL | 必須是一個URL |
注：此表格只是簡單的對注解功能的說明，并沒有對每一個注解的屬性進行說明；可詳見源碼。
第三步，定義校驗類進行測試
@RestController
@Slf4j
@Validated
public class ValidController {
@ApiOperation("RequestBody校驗")
@PostMapping("/valid/test1")
public String test1(@Validated @RequestBody ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test1 valid success";
}
@ApiOperation("Form校驗")
@PostMapping(value = "/valid/test2")
public String test2(@Validated ValidVO validVO){
log.info("validEntity is {}", validVO);
return "test2 valid success";
}
@ApiOperation("單參數(shù)校驗")
@PostMapping(value = "/valid/test3")
public String test3(@Email String email){
log.info("email is {}", email);
return "email valid success";
}
}
這里我們先定義三個方法test1，test2，test3，test1使用了 @RequestBody注解，用于接受前端發(fā)送的json數(shù)據(jù)，test2模擬表單提交，test3模擬單參數(shù)提交。注意，當(dāng)使用單參數(shù)校驗時需要在Controller上加上@Validated注解，否則不生效。
第四步，體驗效果
調(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 [不是一個合法的電子郵件地址]]...",
"data": null,
"timestamp": 1628239624332
}
調(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 [名字為必填項]...",
"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: 不是一個合法的電子郵件地址",
"data": null,
"timestamp": 1628239281022
}
通過加入 Validator校驗框架可以幫助我們自動實現(xiàn)參數(shù)的校驗。
參數(shù)異常加入全局異常處理器
雖然我們之前定義了全局異常攔截器，也看到了攔截器確實生效了，但是 Validator校驗框架返回的錯誤提示太臃腫了，不便于閱讀，為了方便前端提示，我們需要將其簡化一下。
直接修改之前定義的 RestExceptionHandler，單獨攔截參數(shù)校驗的三個異常：
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);
}
體驗效果
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
"id": 1,
"level": "12",
"email": "47693899",
"appId": "ab1c"
}
{
"status": 400,
"message": "名字為必填項; 不是一個合法的電子郵件地址; appId長度必須位于6到12之間",
"data": null,
"timestamp": 1628435116680
}
是不是感覺清爽多了？
自定義參數(shù)校驗
雖然Spring Validation 提供的注解基本上夠用，但是面對復(fù)雜的定義，我們還是需要自己定義相關(guān)注解來實現(xiàn)自動校驗。
比如上面實體類中的sex性別屬性，只允許前端傳遞傳 M，F(xiàn) 這2個枚舉值，如何實現(xiàn)呢？
第一步，創(chuàng)建自定義注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//標(biāo)明由哪個類執(zhí)行校驗邏輯
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();
}
}
第二步，自定義校驗邏輯
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);
}
}
第三步，在字段上增加注解
@ApiModelProperty(value = "性別")
@EnumString(value = {"F","M"}, message="性別只允許為F或M")
private String sex;
第四步，體驗效果
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
}
分組校驗
一個VO對象在新增的時候某些字段為必填，在更新的時候又非必填。如上面的 ValidVO中 id 和 appId 屬性在新增操作時都是非必填，而在編輯操作時都為必填，name在新增操作時為必填，面對這種場景你會怎么處理呢？
在實際開發(fā)中我見到很多同學(xué)都是建立兩個VO對象，ValidCreateVO，ValidEditVO來處理這種場景，這樣確實也能實現(xiàn)效果，但是會造成類膨脹，而且極其容易被開發(fā)老鳥們嘲笑。
其實 Validator校驗框架已經(jīng)考慮到了這種場景并且提供了解決方案，就是分組校驗，只不過很多同學(xué)不知道而已。要使用分組校驗，只需要三個步驟：
第一步：定義分組接口
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{
}
}
}
這里我們定義一個分組接口ValidGroup讓其繼承 javax.validation.groups.Default，再在分組接口中定義出多個不同的操作類型，Create，Update，Query，Delete。至于為什么需要繼承Default我們稍后再說。
第二步，在模型中給參數(shù)分配分組
@Data
@ApiModel(value = "參數(shù)校驗類")
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 = "名字為必填項")
private String name;
@ApiModelProperty(value = "郵箱")
@Email(message = "請?zhí)顚懻〉泥]箱地址")
privte String email;
...
}
給參數(shù)指定分組，對于未指定分組的則使用的是默認分組。
第三步，給需要參數(shù)校驗的方法指定分組
@RestController
@Api("參數(shù)校驗")
@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";
}
}
這里我們通過 value屬性給 add()和 update()方法分別指定Create和Update分組。
第四步，體驗效果
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded name=javadaily&level=12&email=476938977@qq.com&sex=F
在Create時我們沒有傳遞id和appId參數(shù)，校驗通過。
當(dāng)我們使用同樣的參數(shù)調(diào)用update方法時則提示參數(shù)校驗錯誤。
{
"status": 400,
"message": "ID不能為空; 應(yīng)用ID不能為空",
"data": null,
"timestamp": 1628492514313
}
由于email屬于默認分組，而我們的分組接口 ValidGroup已經(jīng)繼承了 Default分組，所以也是可以對email字段作參數(shù)校驗的。如：
POST http://localhost:8080/valid/add Content-Type: application/x-www-form-urlencoded name=javadaily&level=12&email=476938977&sex=F
{
"status": 400,
"message": "請?zhí)顚懻〉泥]箱地址",
"data": null,
"timestamp": 1628492637305
}
當(dāng)然如果你的ValidGroup沒有繼承Default分組，那在代碼屬性上就需要加上
@Validated(value = {ValidGroup.Crud.Create.class, Default.class}
才能讓 email字段的校驗生效。
小結(jié)
參數(shù)校驗在實際開發(fā)中使用頻率非常高，但是很多同學(xué)還只是停留在簡單的使用上，像分組校驗，自定義參數(shù)校驗這2個高階技巧基本沒怎么用過，經(jīng)常出現(xiàn)譬如建立多個VO用于接受Create，Update場景的情況，很容易被老鳥被所鄙視嘲笑，希望大家好好掌握。
github地址：https://github.com/jianzh5/cloud-blog/
以上就是SpringBoot參數(shù)校驗過程示例教程的詳細內(nèi)容，更多關(guān)于SpringBoot參數(shù)校驗的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Java使用connectTo方法提高代碼可續(xù)性詳解
這篇文章主要介紹了Java使用connectTo方法提高代碼可續(xù)性，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-08-08
在本篇文章中小編給各位分享了關(guān)于如何提高java代碼的重用性的相關(guān)知識點內(nèi)容，有需要的朋友們參考下。2019-07-07
使用SpringMVC在redirect重定向的時候攜帶參數(shù)的問題
這篇文章主要介紹了使用SpringMVC在redirect重定向的時候攜帶參數(shù)的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
這篇文章主要介紹了Application.yml的自定義屬性的讀取方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08
這篇文章主要介紹了Spring注解配置實現(xiàn)過程詳解,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-08-08
這篇文章主要為大家介紹了關(guān)于j2Cache線上異常排查的問題解決記錄分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步2022-02-02
這篇文章主要介紹了解決springboot 啟動找不到主類的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
使用Java實現(xiàn)HTTP和HTTPS代理服務(wù)詳解
這篇文章主要為大家詳細介紹了如何使用Java實現(xiàn)HTTP和HTTPS代理服務(wù),文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-04-04
Java 8 是迄今為止在語義上改動上最大的一個平臺。下面這篇文章主要給大家介紹了關(guān)于Java8如何構(gòu)建一個Stream的相關(guān)資料，文中通過示例代碼介紹的非常詳細，需要的朋友可以參考借鑒，下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧。2018-04-04
這篇文章主要為大家介紹了DoytoQuery中的查詢映射方案詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-12-12