爆操视频在线观看免费,操屄视频在线观看,91视频久久久久,三级成人AV在线电影,日本乱伦毛片,成人性生交A片免费看游戏 ,有码精品一区二区,人妻av电影

“
大家好，今天我們來聊聊在SprinBoot中如何集成參數(shù)校驗(yàn)Validator，以及參數(shù)校驗(yàn)的高階技巧（自定義校驗(yàn)，分組校驗(yàn)）。
”

首先我們來看看什么是Validator參數(shù)校驗(yàn)器，為什么需要參數(shù)校驗(yàn)？

為什么需要參數(shù)校驗(yàn)

在日常的接口開發(fā)中，為了防止非法參數(shù)對業(yè)務(wù)造成影響，經(jīng)常需要對接口的參數(shù)做校驗(yàn)，例如登錄的時(shí)候需要校驗(yàn)用戶名密碼是否為空，創(chuàng)建用戶的時(shí)候需要校驗(yàn)郵件、手機(jī)號碼格式是否準(zhǔn)確。靠代碼對接口參數(shù)一個(gè)個(gè)校驗(yàn)的話就太繁瑣了，代碼可讀性極差。

Validator框架就是為了解決開發(fā)人員在開發(fā)的時(shí)候少寫代碼，提升開發(fā)效率；Validator專門用來進(jìn)行接口參數(shù)校驗(yàn)，例如常見的必填校驗(yàn)，email格式校驗(yàn)，用戶名必須位于6到12之間等等...

“
Validator校驗(yàn)框架遵循了JSR-303驗(yàn)證規(guī)范（參數(shù)校驗(yàn)規(guī)范）, JSR是Java Specification Requests的縮寫。
”

接下來我們看看在SpringbBoot中如何集成參數(shù)校驗(yàn)框架。

SpringBoot中集成參數(shù)校驗(yàn)

第一步，引入依賴

<dependency>
??<groupId>org.springframework.bootgroupId>
??<artifactId>spring-boot-starter-webartifactId>
dependency>

<dependency>
??<groupId>org.springframework.bootgroupId>
??<artifactId>spring-boot-starter-validationartifactId>
dependency>

“
注：從springboot-2.3開始，校驗(yàn)包被獨(dú)立成了一個(gè)starter組件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依賴就可以了。
”

第二步，定義要參數(shù)校驗(yàn)的實(shí)體類

@Data
public?class?ValidVO?{
????private?String?id;

????@Length(min?=?6,max?=?12,message?=?"appId長度必須位于6到12之間")
????private?String?appId;

????@NotBlank(message?=?"名字為必填項(xiàng)")
????private?String?name;

????@Email(message?=?"請?zhí)顚懻_的郵箱地址")
????private?String?email;

????private?String?sex;

????@NotEmpty(message?=?"級別不能為空")
????private?String?level;
}

在實(shí)際開發(fā)中對于需要校驗(yàn)的字段都需要設(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	必須滿足指定的正則表達(dá)式
@Size	集合、數(shù)組、map等的size()值必須在指定范圍內(nèi)
@Email	必須是email格式
@Length	長度必須在指定范圍內(nèi)
@NotBlank	字符串不能為null,字符串trim()后也不能等于“”
@NotEmpty	不能為null，集合、數(shù)組、map等size()不能為0；字符串trim()后可以等于“”
@Range	值必須在指定范圍內(nèi)
@URL	必須是一個(gè)URL

注：此表格只是簡單的對注解功能的說明，并沒有對每一個(gè)注解的屬性進(jìn)行說明；可詳見源碼。

第三步，定義校驗(yàn)類進(jìn)行測試

@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注解，否則不生效。

第四步，體驗(yàn)效果

調(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
}

調(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
}

通過加入Validator校驗(yàn)框架可以幫助我們自動(dòng)實(shí)現(xiàn)參數(shù)的校驗(yàn)。

參數(shù)異常加入全局異常處理器

雖然我們之前定義了全局異常攔截器，也看到了攔截器確實(shí)生效了，但是Validator校驗(yàn)框架返回的錯(cuò)誤提示太臃腫了，不便于閱讀，為了方便前端提示，我們需要將其簡化一下。

直接修改之前定義的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?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長度必須位于6到12之間",
??"data":?null,
??"timestamp":?1628435116680
}

是不是感覺清爽多了？

自定義參數(shù)校驗(yàn)

雖然Spring Validation 提供的注解基本上夠用，但是面對復(fù)雜的定義，我們還是需要自己定義相關(guān)注解來實(shí)現(xiàn)自動(dòng)校驗(yàn)。

比如上面實(shí)體類中的sex性別屬性，只允許前端傳遞傳 M，F(xiàn) 這2個(gè)枚舉值，如何實(shí)現(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)明由哪個(gè)類執(zhí)行校驗(yàn)邏輯
public?@interface?EnumString?{
????String?message()?default?"value?not?in?enum?values.";

????Class[]?groups()?default?{};

????Class[]?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();
????}
}

第二步，自定義校驗(yàn)邏輯

public?class?EnumStringValidator?implements?ConstraintValidator<EnumString,?String>?{
????private?List?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;

第四步，體驗(yàn)效果

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對象在新增的時(shí)候某些字段為必填，在更新的時(shí)候又非必填。如上面的ValidVO中 id 和 appId 屬性在新增操作時(shí)都是非必填，而在編輯操作時(shí)都為必填，name在新增操作時(shí)為必填，面對這種場景你會(huì)怎么處理呢？

在實(shí)際開發(fā)中我見到很多同學(xué)都是建立兩個(gè)VO對象，ValidCreateVO，ValidEditVO來處理這種場景，這樣確實(shí)也能實(shí)現(xiàn)效果，但是會(huì)造成類膨脹，而且極其容易被開發(fā)老鳥們嘲笑。

其實(shí)Validator校驗(yàn)框架已經(jīng)考慮到了這種場景并且提供了解決方案，就是分組校驗(yàn)，只不過很多同學(xué)不知道而已。要使用分組校驗(yàn)，只需要三個(gè)步驟：

第一步：定義分組接口

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è)不同的操作類型，Create，Update，Query，Delete。至于為什么需要繼承Default我們稍后再說。

第二步，在模型中給參數(shù)分配分組

@Data
@ApiModel(value?=?"參數(shù)校驗(yàn)類")
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?=?"請?zhí)顚懻〉泥]箱地址")
????privte?String?email;

????...

}

給參數(shù)指定分組，對于未指定分組的則使用的是默認(rèn)分組。

第三步，給需要參數(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";
????}
}

這里我們通過value屬性給add()和update()方法分別指定Create和Update分組。

第四步，體驗(yàn)效果

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í)我們沒有傳遞id和appId參數(shù)，校驗(yàn)通過。

當(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分組，所以也是可以對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":?"請?zhí)顚懻〉泥]箱地址",
??"data":?null,
??"timestamp":?1628492637305
}

當(dāng)然如果你的ValidGroup沒有繼承Default分組，那在代碼屬性上就需要加上@Validated(value = {ValidGroup.Crud.Create.class, Default.class}才能讓email字段的校驗(yàn)生效。

小結(jié)

參數(shù)校驗(yàn)在實(shí)際開發(fā)中使用頻率非常高，但是很多同學(xué)還只是停留在簡單的使用上，像分組校驗(yàn)，自定義參數(shù)校驗(yàn)這2個(gè)高階技巧基本沒怎么用過，經(jīng)常出現(xiàn)譬如建立多個(gè)VO用于接受Create，Update場景的情況，很容易被老鳥被所鄙視嘲笑，希望大家好好掌握。

SpringBoot 如何進(jìn)行參數(shù)校驗(yàn)？老鳥們都是這么玩的！

為什么需要參數(shù)校驗(yàn)

SpringBoot中集成參數(shù)校驗(yàn)

第一步，引入依賴

第二步，定義要參數(shù)校驗(yàn)的實(shí)體類

第三步，定義校驗(yàn)類進(jìn)行測試

第四步，體驗(yàn)效果

參數(shù)異常加入全局異常處理器

體驗(yàn)效果

自定義參數(shù)校驗(yàn)

第一步，創(chuàng)建自定義注解

第二步，自定義校驗(yàn)邏輯

第三步，在字段上增加注解

第四步，體驗(yàn)效果

分組校驗(yàn)

第一步：定義分組接口

第二步，在模型中給參數(shù)分配分組

第三步，給需要參數(shù)校驗(yàn)的方法指定分組

第四步，體驗(yàn)效果

小結(jié)