Spring 校驗器(Validator)

Spring校驗器，參數校驗從此簡單。

image.png

應用在執行業務邏輯之前，必須通過校驗保證接受到的輸入資料是合法正确的，但很多時候同樣的校驗出現了多次，在不同的層，不同的方法上，導緻代碼備援，浪費時間，違反DRY原則。

1. 每一個控制器都要校驗
2. 過多的校驗參數會導緻代碼太長
3. 代碼的複用率太差，同樣的代碼如果出現多次，在業務越來越複雜的情況下，維護成本呈指數上升。

可以考慮把校驗的代碼封裝起來，來解決出現的這些問題。

JSR-303

JSR-303是Java為Bean資料合法性校驗提供的标準架構，它定義了一套可标注在成員變量，屬性方法上的校驗注解。

Hibernate Validation提供了這套标準的實作，在我們引入Spring Boot web starter或者Spring boot starter validation的時候，預設會引入Hibernate Validation。

用法執行個體

說了這麼多廢話，上代碼。

1. 引入SpringBoot項目

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
       <!-- 引入lomhok --> 
       <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>        
        
           

1. 編寫校驗對象

@Data
public class User {
    // 名字不允許為空，并且名字的長度在2位到30位之間
    // 如果名字的長度校驗不通過，那麼提示錯誤資訊
    @NotNull
    @Size(min=2, max=30,message = "請檢查名字的長度是否有問題")
    private String name;

    // 不允許為空，并且年齡的最小值為18
    @NotNull
    @Min(18)
    private Integer age;
}

           

1. 建立控制器

@SpringBootApplication
@RestController
public class UserApplication{
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class,args);
    }
    
    // 1. 要校驗的參數前，加上@Valid注解
    // 2. 緊随其後的，跟上一個BindingResult來存儲校驗資訊
    @RequestMapping("/test1")
    public Object test1(
            @Valid User user,
            BindingResult bindingResult
    ) {
        //如果檢驗出了問題，就傳回錯誤資訊
        // 這裡我們傳回的是全部的錯誤資訊，實際中可根據bindingResult的方法根據需要傳回自定義的資訊。
        // 通常的解決方案為：JSR-303 + 全局ExceptionHandler
        if (bindingResult.hasErrors()){
            return bindingResult.getAllErrors();
        }
        return "OK";
    }
    
}

           

1. 運作應用

稍作示範下運作的結果，可以看出校驗架構已經生效了。

校驗年齡

校驗名稱

校驗通過

常見的校驗注解

@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(regex=,flag=) 被注釋的元素必須符合指定的正規表達式

Hibernate Validator提供的校驗注解：

@NotBlank(message =) 驗證字元串非null，且長度必須大于0

@Email 被注釋的元素必須是電子郵箱位址

@Length(min=,max=) 被注釋的字元串的大小必須在指定的範圍内

@NotEmpty 被注釋的字元串的必須非空

@Range(min=,max=,message=) 被注釋的元素必須在合适的範圍内

自定義校驗注解

有時候，第三方庫中并沒有我們想要的校驗類型，好在系統提供了很好的擴充能力，我們可以自定義檢驗。

比如，我們想校驗使用者的手機格式，寫手機号碼校驗器

1. 編寫校驗注解

// 我們可以直接拷貝系統内的注解如@Min，複制到我們新的注解中，然後根據需要修改。
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
//注解的實作類。
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {
    //校驗錯誤的預設資訊
    String message() default "手機号碼格式有問題";

    //是否強制校驗
    boolean isRequired() default false;
    
    Class<?>[] groups() default {};

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

           

1. 編寫具體的實作類

   我們知道注解隻是一個标記，真正的邏輯還要在特定的類中實作，上一步的注解指定了實作校驗功能的類為IsMobileValidator。

// 自定義注解一定要實作ConstraintValidator接口奧，裡面的兩個參數
// 第一個為 具體要校驗的注解
// 第二個為 校驗的參數類型
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {

    private boolean required = false;

    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
    //工具方法，判斷是否是手機号
    public static boolean isMobile(String src) {
        if (StringUtils.isEmpty(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }

    @Override
    public void initialize(IsMobile constraintAnnotation) {
        required = constraintAnnotation.isRequired();
    }

    @Override
    public boolean isValid(String phone, ConstraintValidatorContext constraintValidatorContext) {
        //是否為手機号的實作
        if (required) {
            return isMobile(phone);
        } else {
            if (StringUtils.isEmpty(phone)) {
                return true;
            } else {
                return isMobile(phone);
            }
        }
    }
    
}
           

1. 測試自定義注解的功能

@Data
public class User {
    @NotNull
    @Size(min=2, max=30,message = "請檢查名字的長度是否有問題")
    private String name;

    @NotNull
    @Min(18)
    private Integer age;

    //這裡是新添加的注解奧
    @IsMobile
    private String phone;
}
           

1. 測試

   

   通過

手機号有問題

可以看出自定義的注解已經生效了。

我們還可以繼續優化的地方，建立一個全局的異常，如果校驗失敗的話，抛出全局的業務異常，捕獲業務異常，然後傳回使用者友好的提示資訊。

額外

也可以通過方法的校驗。

1. 控制器上添加@Validated注解
2. 在控制器的方法上添加校驗注解，@Min，@Max等。

@Validated
@RestController
@SpringBootApplication
public class UserApplication{
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class,args);
    }

    @RequestMapping("/test2")
    public String test2(
            @IsMobile String phone

    ){
        return phone + "ok";
    }

    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public Object handleConstraintViolationException(ConstraintViolationException cve){

        HashSet<String> messageSet = new HashSet();
        for (ConstraintViolation constraintViolation : cve.getConstraintViolations()) {
            messageSet.add(constraintViolation.getMessage());
        }
        return messageSet;
    }

}

           

類的校驗規則

最後

通過使用校驗器，所有的控制器，我們都不用再去做校驗啦，代碼再回看是不是清爽很多。我們寫代碼很簡答，但是一定要想到如何把代碼寫的更簡單，更清晰，更利于維護，寫重複的代碼是在浪費自己的時間奧。

以後再碰到參數校驗的情況，首先想到的不是直接就去校驗，可以查找自己是否寫過某一類的驗證器，可以直接拿來即用。

希望能幫助大家。

另外

我在知識星球開通了一個交流群，免費的。希望能和大家一起交流學習，進群的可以獲得500G Java學習資料奧，多年的收藏，除了Java之外，還收藏了IOS，Linux，Android相關資料。想要的也可以找我拿。

猩球圖檔