欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot使用Validator進行參數(shù)校驗實戰(zhàn)教程(自定義校驗，分組校驗)

 更新時間：2023年07月24日 10:18:12   作者：楊業(yè)壯的專欄  
這篇文章主要介紹了SpringBoot使用Validator進行參數(shù)校驗（自定義校驗，分組校驗）的實戰(zhàn)教程，本文通過示例代碼給大家介紹的非常詳細，需要的朋友參考下吧

在日常的接口開發(fā)中，為了防止非法參數(shù)對業(yè)務造成影響，經(jīng)常需要對接口的參數(shù)做校驗，例如登錄的時候需要校驗用戶名密碼是否為空，創(chuàng)建用戶的時候需要校驗郵件、手機號碼格式是否準確?？看a對接口參數(shù)一個個校驗的話就太繁瑣了，代碼可讀性極差。因為網(wǎng)絡傳輸?shù)牟豢煽啃?，以及前端?shù)據(jù)控制的可篡改性，后端的參數(shù)校驗是必須的，應用程序必須通過某種手段來確保輸入進來的數(shù)據(jù)從語義上來講是正確的。

Validator校驗框架遵循了JSR-303驗證規(guī)范（參數(shù)校驗規(guī)范）, JSR是Java Specification Requests的縮寫。Validator專門用來進行接口參數(shù)校驗，例如常見的必填校驗，email格式校驗，用戶名必須位于6到12之間等，就是為了解決開發(fā)人員在開發(fā)的時候少寫代碼，提升開發(fā)效率。

一、SpringBoot集成參數(shù)校驗

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開始，校驗包被獨立成了一個starter組件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依賴就可以了。

2. 定義實體類

在實際開發(fā)中對于需要校驗的字段都需要設置對應的業(yè)務提示，即message屬性。

@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;
}

常見約束注解如下：

注解功能
@AssertFalse可以為null,如果不為null的話必須為false
@AssertTrue可以為null,如果不為null的話必須為true
@DecimalMax設置不能超過最大值
@DecimalMin設置不能超過最小值
@Digits設置必須是數(shù)字且數(shù)字整數(shù)的位數(shù)和小數(shù)的位數(shù)必須在指定范圍內(nèi)
@Future日期必須在當前日期的未來
@Past日期必須在當前日期的過去
@Max最大不得超過此最大值
@Min最大不得小于此最小值
@NotNull不能為null，可以是空
@Null必須為null
@Pattern必須滿足指定的正則表達式
@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必須是一個URL

3. 校驗測試

@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ù)提交。注意，當使用單參數(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 [不是一個合法的電子郵件地址]]...",
  "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 [名字為必填項]...",
  "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"
}
{
  "status": 400,
  "message": "名字為必填項; 不是一個合法的電子郵件地址; appId長度必須位于6到12之間",
  "data": null,
  "timestamp": 1628435116680
}

是不是感覺清爽多了？

三、自定義參數(shù)校驗

雖然Spring Validation 提供的注解基本上夠用，但是面對復雜的定義，還是需要自己定義相關(guān)注解來實現(xiàn)自動校驗。比如sex性別屬性，只允許前端傳遞傳 M，F(xiàn) 這2個枚舉值，如何實現(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)//標明由哪個類執(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();
    }
}

2. 自定義校驗邏輯

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
}

四、分組校驗

一個VO對象在新增的時候某些字段為必填，在更新的時候又非必填。如上面的ValidVO中 id 和 appId 屬性在新增操作時都是非必填，而在編輯操作時都為必填，name在新增操作時為必填，面對這種場景你會怎么處理呢？

在實際開發(fā)中可能會建立兩個VO對象，ValidCreateVO，ValidEditVO來處理這種場景，這樣確實也能實現(xiàn)效果，但是會造成類膨脹。

其實Validator校驗框架已經(jīng)考慮到了這種場景并且提供了解決方案，就是分組校驗。要使用分組校驗，只需要三個步驟：

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{
        }
    }
}

這里我們定義一個分組接口ValidGroup讓其繼承javax.validation.groups.Default，再在分組接口中定義出多個不同的操作類型，Create，Update，Query，Delete。至于為什么需要繼承Default我們稍后再說。

2. 在模型中給參數(shù)分配分組

@Data
@ApiModel(value = "參數(shù)校驗類")
public class ValidVO {
    @ApiModelProperty("ID")
    @Null(groups = ValidGroup.Crud.Create.class)
    @NotNull(groups = ValidGroup.Crud.Update.class, message = "應用ID不能為空")
    private String id;
    @Null(groups = ValidGroup.Crud.Create.class)
    @NotNull(groups = ValidGroup.Crud.Update.class, message = "應用ID不能為空")
    @ApiModelProperty(value = "應用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ù)指定分組，對于未指定分組的則使用的是默認分組。

3. 給需要參數(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分組。

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

當我們使用同樣的參數(shù)調(diào)用update方法時則提示參數(shù)校驗錯誤。

{
  "status": 400,
  "message": "ID不能為空; 應用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
}

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

到此這篇關(guān)于SpringBoot使用Validator進行參數(shù)校驗（自定義校驗，分組校驗）的文章就介紹到這了,更多相關(guān)SpringBoot Validator校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

相關(guān)文章

  • Java刷題之最小k個數(shù)的思路及具體實現(xiàn)

    Java刷題之最小k個數(shù)的思路及具體實現(xiàn)

    這篇文章主要介紹了Java刷題之最小k個數(shù)的思路及具體實現(xiàn),最小K個數(shù)是一個經(jīng)典的top-K問題,可以通過整體排序、建立小根堆或大根堆的方式解決,排序方式時間復雜度較高,適合數(shù)據(jù)量小的場景,小根堆適合k較小的情況,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
    2024-10-10
  • Spring實戰(zhàn)之Qualifier注解用法示例

    Spring實戰(zhàn)之Qualifier注解用法示例

    這篇文章主要介紹了Spring實戰(zhàn)之Qualifier注解用法,結(jié)合實例形式詳細分析了spring Qualifier注解相關(guān)配置、定義與使用方法,需要的朋友可以參考下
    2019-12-12
  • Netty分布式高性能工具類recycler的使用及創(chuàng)建

    Netty分布式高性能工具類recycler的使用及創(chuàng)建

    這篇文章主要為大家介紹了Netty分布式高性能工具類recycler的使用和創(chuàng)建，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步
    2022-03-03
  • java實現(xiàn)登錄之后抓取數(shù)據(jù)

    java實現(xiàn)登錄之后抓取數(shù)據(jù)

    這篇文章給大家分享了用JAVA實現(xiàn)在登陸以后抓取網(wǎng)站的數(shù)據(jù)的相關(guān)知識，有興趣的朋友可以測試參考下。
    2018-07-07
  • java中String的常見用法總結(jié)

    java中String的常見用法總結(jié)

    以下是關(guān)于string的七種用法，注意哦，記得要時常去查看java的API文檔，那個里面也有很詳細的介紹
    2013-10-10
  • SpringData JPA實現(xiàn)查詢分頁demo

    SpringData JPA實現(xiàn)查詢分頁demo

    本篇文章主要介紹了SpringData JPA實現(xiàn)查詢分頁demo，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
    2017-03-03
  • JAVA實現(xiàn)按時間段查詢數(shù)據(jù)操作

    JAVA實現(xiàn)按時間段查詢數(shù)據(jù)操作

    這篇文章主要介紹了JAVA實現(xiàn)按時間段查詢數(shù)據(jù)操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
    2020-08-08
  • Java 多線程Synchronized和Lock的區(qū)別

    Java 多線程Synchronized和Lock的區(qū)別

    這篇文章主要介紹了Java 多線程Synchronized和Lock的區(qū)別，幫助大家更好的理解和使用Java，感興趣的朋友可以了解下
    2021-01-01
  • 詳解Java中二叉樹的基礎概念(遞歸&迭代)

    詳解Java中二叉樹的基礎概念(遞歸&迭代)

    二叉樹（Binary?tree）是樹形結(jié)構(gòu)的一個重要類型。本文將通過圖片和示例代碼詳細為大家講解一下Java中的二叉樹的基礎概念，需要的可以參考一下
    2022-03-03
  • Java實現(xiàn)多文件壓縮加密并重命名壓縮文件對象的方法

    Java實現(xiàn)多文件壓縮加密并重命名壓縮文件對象的方法

    這篇文章主要介紹了Java實現(xiàn)多文件壓縮加密并重命名壓縮文件對象的方法,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
    2021-01-01

最新評論