快捷導(dǎo)航

詳解Springboot如何優(yōu)雅的進(jìn)行數(shù)據(jù)校驗(yàn)

更新時間：2023年06月06日 10:00:30 作者：Hypnosis

基于?Spring?Boot?，如何“優(yōu)雅”的進(jìn)行數(shù)據(jù)校驗(yàn)?zāi)?，本文將待大家詳?xì)介紹Springboot如何優(yōu)雅的進(jìn)行數(shù)據(jù)校驗(yàn)，文中有詳細(xì)的代碼示例和流程步驟,需要的朋友可以參考下

引入依賴

首先只需要給項(xiàng)目添加上 spring-boot-starter-web 依賴就夠了，它的子依賴包含了我們所需要的東西。

注意： Spring Boot 2.3 1 之后，spring-boot-starter-validation 已經(jīng)不包括在了 spring-boot-starter-web 中，需要我們手動加上！

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

驗(yàn)證 Controller 的輸入

一定一定不要忘記在類上加上 @ Validated 注解了，這個參數(shù)可以告訴 Spring 去校驗(yàn)方法參數(shù)。

驗(yàn)證請求體

驗(yàn)證請求體即使驗(yàn)證被 @RequestBody 注解標(biāo)記的方法參數(shù)。

PersonController

我們在需要驗(yàn)證的參數(shù)上加上了@Valid注解，如果驗(yàn)證失敗，它將拋出MethodArgumentNotValidException。默認(rèn)情況下，Spring 會將此異常轉(zhuǎn)換為 HTTP Status 400（錯誤請求）。

@RestController
@RequestMapping("/api/person")
@Validated
public class PersonController {
    @PostMapping
    public ResponseEntity<PersonRequest> save(@RequestBody @Valid PersonRequest personRequest) {
        return ResponseEntity.ok().body(personRequest);
    }
}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class PersonRequest {
    @NotNull(message = "classId 不能為空")
    private String classId;
    @Size(max = 33)
    @NotNull(message = "name 不能為空")
    private String name;
    @Pattern(regexp = "(^Man$|^Woman$|^UGM$)", message = "sex 值不在可選范圍")
    @NotNull(message = "sex 不能為空")
    private String sex;
}

使用 Postman 驗(yàn)證

驗(yàn)證請求參數(shù)

驗(yàn)證請求參數(shù)（Path Variables 和 Request Parameters）即是驗(yàn)證被 @PathVariable 以及 @RequestParam 標(biāo)記的方法參數(shù)。

PersonController

@RestController
@RequestMapping("/api/persons")
@Validated
public class PersonController {
    @GetMapping("/{id}")
    public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5, message = "超過 id 的范圍了") Integer id) {
        return ResponseEntity.ok().body(id);
    }
    @PutMapping
    public ResponseEntity<String> getPersonByName(@Valid @RequestParam("name") @Size(max = 6, message = "超過 name 的范圍了") String name) {
        return ResponseEntity.ok().body(name);
    }
}

使用 Postman 驗(yàn)證

嵌套校驗(yàn)

在一個校驗(yàn)A對象里另一個B對象里的參數(shù)

需要在B對象上加上@Valid注解

常用校驗(yàn)注解總結(jié)

JSR303 定義了 Bean Validation（校驗(yàn)）的標(biāo)準(zhǔn) validation-api，并沒有提供實(shí)現(xiàn)。Hibernate Validation是對這個規(guī)范/規(guī)范的實(shí)現(xiàn) hibernate-validator，并且增加了 @Email、@Length、@Range 等注解。Spring Validation 底層依賴的就是Hibernate Validation。

JSR 提供的校驗(yàn)注解:

@Null 被注釋的元素必須為 null
@NotNull 被注釋的元素必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Min(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Max(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Size(max=, min=) 被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
@Past 被注釋的元素必須是一個過去的日期
@Future 被注釋的元素必須是一個將來的日期
@Pattern(regex=,flag=) 被注釋的元素必須符合指定的正則表達(dá)式

Hibernate Validator 提供的校驗(yàn)注解：

@NotBlank(message =) 驗(yàn)證字符串非 null，且長度必須大于 0
@Email 被注釋的元素必須是電子郵箱地址
@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty 被注釋的字符串的必須非空
@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內(nèi)

@JsonFormat與@DateTimeFormat注解的使用

@JsonFormat用于后端傳給前端的時間格式轉(zhuǎn)換，@DateTimeFormat用于前端傳給后端的時間格式轉(zhuǎn)換

JsonFormat

1、使用maven引入@JsonFormat所需要的jar包

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.8.8</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.8.8</version>
        </dependency>
        <dependency>
            <groupId>org.codehaus.jackson</groupId>
            <artifactId>jackson-mapper-asl</artifactId>
            <version>1.9.13</version>
         </dependency>

2、在需要查詢時間的數(shù)據(jù)庫字段對應(yīng)的實(shí)體類的屬性上添加@JsonFormat

   @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
   private LocalDateTime updateDate;

注： timezone：是時間設(shè)置為東八區(qū)，避免時間在轉(zhuǎn)換中有誤差，pattern：是時間轉(zhuǎn)換格式

DataTimeFormat

1、添加依賴

       <dependency>
           <groupId>joda-time</groupId>
           <artifactId>joda-time</artifactId>
           <version>2.3</version>
      </dependency>

2、我們在對應(yīng)的接收前臺數(shù)據(jù)的對象的屬性上加@DateTimeFormat

@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime acquireDate;

3.這樣我們就可以將前端獲取的時間轉(zhuǎn)換為一個符合自定義格式的時間格式存儲到數(shù)據(jù)庫了全局異常統(tǒng)一處理：攔截并處理校驗(yàn)出錯的返回數(shù)據(jù) 寫一個全局異常處理類

@ControllerAdvice
public class GlobalExceptionHandler{
        /**
     *  處理參數(shù)校驗(yàn)異常
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseBody
    public ErrorResponseData validateException(MethodArgumentNotValidException e) {
        log.error("參數(shù)異常"+e.getBindingResult().getFieldError().getDefaultMessage(),e);
        return new ErrorResponseData(10001,e.getBindingResult().getFieldError().getDefaultMessage());
    }
    /**
     *  處理json轉(zhuǎn)換異常(比如 @DateTimeFormat注解轉(zhuǎn)換日期格式時)
     */
    @ExceptionHandler({HttpMessageNotReadableException.class})
    @ResponseBody
    public ErrorResponseData jsonParseException(HttpMessageNotReadableException e) {
        log.error("參數(shù)異常"+e.getLocalizedMessage(),e);
        return new ErrorResponseData(10001,e.getCause().getMessage());
    }
}

以上就是詳解Springboot如何優(yōu)雅的進(jìn)行數(shù)據(jù)校驗(yàn)的詳細(xì)內(nèi)容，更多關(guān)于Springboot 數(shù)據(jù)校驗(yàn)的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: