SpringBoot如何利用validation實現優雅的校驗參數

這篇“SpringBoot如何利用validation實現優雅的校驗參數”文章的知識點大部分人都不太理解，所以小編給大家總結了以下內容，內容詳細，步驟清晰，具有一定的借鑒價值，希望大家閱讀完這篇文章能有所收獲，下面我們一起來看看這篇“SpringBoot如何利用validation實現優雅的校驗參數”文章吧。

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: 不是合法的名字,

以上就是關于“SpringBoot如何利用validation實現優雅的校驗參數”這篇文章的內容，相信大家都有了一定的了解，希望小編分享的內容對大家有幫助，若想了解更多相關的知識內容，請關注億速云行業資訊頻道。