SpringBoot利用validation實現優雅的校驗引數

2022-06-14 18:00:57

1、前言

資料的校驗是互動式網站一個不可或缺的功能，前端的js校驗可以涵蓋大部分的校驗職責，如使用者名稱唯一性，生日格式，郵箱格式校驗等等常用的校驗。但是為了避免使用者繞過瀏覽器，使用http工具直接向後端請求一些違法資料，伺服器端的資料校驗也是必要的，可以防止髒資料落到資料庫中，如果資料庫中出現一個非法的郵箱格式，也會讓運維人員頭疼不已。可以使用本文將要介紹的validation來對資料進行校驗。

2、常用校驗

1.JSR303/JSR-349: JSR303是一項標準,只提供規範不提供實現，規定一些校驗規範即校驗註解，如@Null，@NotNull，@Pattern，位於javax.validation.constraints包下。JSR-349是其的升級版本，新增了一些新特性。

@Null 被註釋的元素必須為null
@NotNull 被註釋的元素必須不為null
@AssertTrue 被註釋的元素必須為true
@AssertFalse 被註釋的元素必須為false
@Min(value) 被註釋的元素必須是一個數位，其值必須大於等於指定的最小值
@Max(value) 被註釋的元素必須是一個數位，其值必須小於等於指定的最大值
@DecimalMin(value) 被註釋的元素必須是一個數位，其值必須大於等於指定的最小值
@DecimalMax(value) 被註釋的元素必須是一個數位，其值必須小於等於指定的最大值
@Size(max, min) 被註釋的元素的大小必須在指定的範圍內
@Digits (integer, fraction) 被註釋的元素必須是一個數位，其值必須在可接受的範圍內
@Past 被註釋的元素必須是一個過去的日期
@Future 被註釋的元素必須是一個將來的日期
@Pattern(value) 被註釋的元素必須符合指定的正規表示式

2.hibernate validation：hibernate validation是對這個規範的實現，並增加了一些其他校驗註解，如@Email，@Length，@Range等等

@Email 被註釋的元素必須是電子郵箱地址
@Length 被註釋的字串的大小必須在指定的範圍內
@NotEmpty 被註釋的字串的必須非空
@Range 被註釋的元素必須在合適的範圍內

3.spring validation：spring validation對hibernate validation進行了二次封裝，在springmvc模組中新增了自動校驗，並將校驗資訊封裝進了特定的類中

3、spring boot的資料自動校驗功能

3.1 引入依賴

spring-web模組使用了hibernate-validation，並且databind模組也提供了相應的資料繫結功能。

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

我們只需要引入spring-boot-starter-web依賴即可，如果檢視其子依賴，可以發現如下的依賴：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>

3.2 構建啟動類

@SpringBootApplication
public class App {
   public static void main(String[] args) {
       SpringApplication.run(App.class, args);
       System.out.println("Start app success.");
   }
}

3.3 建立需要被校驗的實體類

public class Person {
    @NotEmpty(message = "name不能為空")
    private String name;
    @Range(min = 0, max = 100, message = "age不能大於100小於0")
    private int age;
    
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

3.4 在Controller中校驗資料

springmvc為我們提供了自動封裝表單引數的功能，一個新增了引數校驗的典型controller如下所示。

@RequestMapping("/test")
public String valid(@Validated Person person, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            System.out.println(fieldError);
        }
        return "fail";
    }
    return "success";
}

值得注意的地方：

引數Persison前需要加上@Validated註解，表明需要spring對其進行校驗，而校驗的資訊會存放到其後的BindingResult中。注意，必須相鄰，如果有多個引數需要校驗，形式可以如下。valid(@Validated Person person, BindingResult personBindingResult ，@Validated Person2 person2, BindingResult person2BindingResult);即一個校驗類對應一個校驗結果。
校驗結果會被自動填充，在controller中可以根據業務邏輯來決定具體的操作，如跳轉到錯誤頁面。

一個最基本的校驗就完成了.

啟動容器測試結果如下：

Field error in object 'person' on field 'age': rejected value [105]; codes [Range.person.age,Range.age,Range.int,Range]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [person.age,age]; arguments []; default message [age],100,0]; default message [age不能大於100小於0]

3.5 統一例外處理

前面那種方式處理校驗錯誤，略顯複雜，而且一般網站都會對請求錯誤做統一的404頁面封裝，如果資料校驗不通過，則Spring boot會丟擲BindException異常，我們可以捕獲這個異常並使用Result封裝返回結果。通過@RestControllerAdvice定義異常捕獲類。

Controller類：

@RequestMapping(value = "valid", method = RequestMethod.GET)
public String valid(@Validated Person person) {
    System.out.println(person);
    return "success";
}

統一例外處理類：

@RestControllerAdvice
public class BindExceptionHanlder {
    @ExceptionHandler(BindException.class)
    public String handleBindException(HttpServletRequest request, BindException exception) {
        List<FieldError> allErrors = exception.getFieldErrors();
        StringBuilder sb = new StringBuilder();
        for (FieldError errorMessage : allErrors) {
            sb.append(errorMessage.getField()).append(": ").append(errorMessage.getDefaultMessage()).append(", ");
        }
        System.out.println(sb.toString());
        return sb.toString();
    }
}

測試: http://localhost:8080/valid?age=105&name=steven

輸出：age: age不能大於100小於0,

4、自定義校驗註解

4.1 @NameValidation

@Documented
@Constraint(validatedBy = NameValidationValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RUNTIME)
public @interface NameValidation {
    String message() default "不是合法的名字";

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

    Class<? extends Payload>[] payload() default {};

    @Target({PARAMETER, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        NameValidation[] value();
    }
}

4.2 校驗類NameValidationValidator

public class NameValidationValidator implements ConstraintValidator<NameValidation, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if ("steven".equalsIgnoreCase(value)) {
            return true;
        }
        String defaultConstraintMessageTemplate = context.getDefaultConstraintMessageTemplate();
        System.out.println("default message :" + defaultConstraintMessageTemplate);
        //禁用預設提示資訊
		//context.disableDefaultConstraintViolation();
        //設定提示語
		//context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation();
        return false;
    }
}

4.3 在Person類增加新註解

@NotEmpty(message = "name不能為空")
@NameValidation
private String name;

測試: http://localhost:8080/valid?age=105&name=lxy

輸出：age: age不能大於100小於0, name: 不是合法的名字,

5、總結

通過上面的例子可以看出，其實使用很簡單，但是有沒有注意到一個問題，錯誤資訊沒有實現國際化。hibernate-validator國際化還是比較繁瑣的，包含：

SpringBoot場景國際化
SpringMvc場景國際化
Spring Jersey場景國際化
非Spring場景國際化

以上就是SpringBoot利用validation實現優雅的校驗引數的詳細內容，更多關於SpringBoot validation校驗引數的資料請關注it145.com其它相關文章！