SpringBoot分組校驗及自定義校驗註解

時間  2020-09-28
標籤 springboot 分組 校驗 自定義 註解 欄目 Spring 简体版
原文   原文鏈接

前言

  在平常的開發中，參數校驗是很是重要的一個環節，嚴格參數校驗會減小不少出bug的機率，增長接口的安全性。在此以前寫過一篇SpringBoot統一參數校驗主要介紹了一些簡單的校驗方法。而這篇則是介紹一些進階的校驗方式。好比說：在某個接口編寫的過程當中確定會遇到，當xxType值爲A，paramA值必傳。xxType值爲B，paramB值必須傳。對於這樣的，一般的作法就是在controller加上各類if判斷。顯然這樣的代碼是不夠優雅的，而分組校驗及自定義參數校驗，就是來解決這個問題的。前端

PathVariable參數校驗

  Restful的接口，在如今來說應該是比較常見的了，經常使用的地址欄的參數，咱們都是這樣校驗的。java

/**
 * 獲取電話號碼信息
 */
@GetMapping("/phoneInfo/{phone}")
public ResultVo phoneInfo(@PathVariable("phone") String phone){
    // 驗證電話號碼是否有效
    String pattern = "^[1][3,4,5,7,8][0-9]{9}$";
    boolean isValid =  Pattern.matches(pattern, phone);
    if(isValid){
        // 執行相應邏輯
        return ResultVoUtil.success(phone);
    } else {
        // 返回錯誤信息
        return ResultVoUtil.error("手機號碼無效");
    }
}

很顯然上面的代碼不夠優雅，因此咱們能夠在參數後面，添加對應的正則表達式phone:正則表達式來進行驗證。這樣就省去了在controller編寫校驗代碼了。正則表達式

/**
 * 獲取電話號碼信息
 */
@GetMapping("/phoneInfo/{phone:^[1][3,4,5,7,8][0-9]{9}$}")
public ResultVo phoneInfo(@PathVariable("phone") String phone){
    return ResultVoUtil.success(phone);
}

雖然這樣處理後代碼更精簡了。可是若是傳入的手機號碼，不符合規則會直接返回404。而不是提示手機號碼錯誤。錯誤信息以下：spring

自定義校驗註解

  咱們以校驗手機號碼爲例，雖然validation提供了@Pattern這個註解來使用正則表達式進行校驗。若是被使用在多處，一旦正則表達式發生更改，則須要一個一個的進行修改。很顯然爲了不作這樣的無用功，自定義校驗註解就是你的好幫手。數據庫

@Data
public class PhoneForm {

    /**
     * 電話號碼
     */
    @Pattern(regexp = "^[1][3,4,5,7,8][0-9]{9}$" , message = "電話號碼有誤")
    private String phone;

}

  要實現一個自定義校驗註解，主要是有兩步。一是註解自己，二是校驗邏輯實現類。segmentfault

PhoneVerify 校驗註解

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface Phone {
 
    String message() default "手機號碼格式有誤";

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

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

}

PhoneValidator 校驗實現類

public class PhoneValidator implements ConstraintValidator<Phone, Object> {

    @Override
    public boolean isValid(Object telephone, ConstraintValidatorContext constraintValidatorContext) {
        String pattern = "^1[3|4|5|7|8]\\d{9}$";
        return Pattern.matches(pattern, telephone.toString());
    }
}

CustomForm 表單數據

@Data
public class CustomForm {

    /**
     * 電話號碼
     */
    @Phone
    private String phone;

}

測試接口

@PostMapping("/customTest")
public ResultVo customTest(@RequestBody @Validated CustomForm form){
    return ResultVoUtil.success(form.getPhone());
}

註解的含義

@Target({ElementType.FIELD})

  註解是指定當前自定義註解可使用在哪些地方，這裏僅僅讓他可使用屬性上。但還可使用在更多的地方，好比說方法上、構造器上等等。安全

  • TYPE - 類，接口（包括註解類型）或枚舉
  • FIELD - 字段（包括枚舉常量）
  • METHOD - 方法
  • PARAMETER - 參數
  • CONSTRUCTOR - 構造函數
  • LOCAL_VARIABLE - 局部變量
  • ANNOTATION_TYPE -註解類型
  • PACKAGE - 包
  • TYPE_PARAMETER - 類型參數
  • TYPE_USE - 使用類型
@Retention(RetentionPolicy.RUNTIME)

  指定當前註解保留到運行時。保留策略有下面三種：app

  • SOURCE - 註解只保留在源文件，當Java文件編譯成class文件的時候，註解被遺棄。
  • CLASS - 註解被保留到class文件，但jvm加載class文件時候被遺棄，這是默認的生命週期。
  • RUNTIME - 註解不只被保存到class文件中，jvm加載class文件以後，仍然存在。
@Constraint(validatedBy = PhoneValidator.class)

  指定了當前註解使用哪一個校驗類來進行校驗。jvm

分組校驗

UserForm

@Data
public class UserForm {

    /**
     * id
     */
    @Null(message = "新增時id必須爲空", groups = {Insert.class})
    @NotNull(message = "更新時id不能爲空", groups = {Update.class})
    private String id;

    /**
     * 類型
     */
    @NotEmpty(message = "姓名不能爲空" , groups = {Insert.class})
    private String name;

    /**
     * 年齡
     */
    @NotEmpty(message = "年齡不能爲空" , groups = {Insert.class})
    private String age;
    
}

Insert分組

public interface Insert {
}

Update分組

public interface Update {
}

測試接口

/**
 * 添加用戶
 */
@PostMapping("/addUser")
public ResultVo addUser(@RequestBody @Validated({Insert.class}) UserForm form){
      // 選擇對應的分組進行校驗
    return ResultVoUtil.success(form);
}

/**
 * 更新用戶
 */
@PostMapping("/updateUser")
public ResultVo updateUser(@RequestBody @Validated({Update.class}) UserForm form){
    // 選擇對應的分組進行校驗
    return ResultVoUtil.success(form);
}

測試結果

添加測試

更新測試

順序校驗@GroupSequence

  在@GroupSequence內能夠指定，分組校驗的順序。好比說@GroupSequence({Insert.class, Update.class, UserForm.class})先執行Insert校驗，而後執行Update校驗。若是Insert分組，校驗失敗了，則不會進行Update分組的校驗。ide

@Data
@GroupSequence({Insert.class, Update.class, UserForm.class})
public class UserForm {

    /**
     * id
     */
    @Null(message = "新增時id必須爲空", groups = {Insert.class})
    @NotNull(message = "更新時id不能爲空", groups = {Update.class})
    private String id;

    /**
     * 類型
     */
    @NotEmpty(message = "姓名不能爲空" , groups = {Insert.class})
    private String name;

    /**
     * 年齡
     */
    @NotEmpty(message = "年齡不能爲空" , groups = {Insert.class})
    private String age;

}
測試接口
/**
* 編輯用戶
*/
@PostMapping("/editUser")
public ResultVo editUser(@RequestBody @Validated UserForm form){
    return ResultVoUtil.success(form);
}
測試結果

  哈哈哈，測試結果實際上是個死循環，無論你咋輸入都會報錯，小夥伴能夠嘗試一下哦。上面的例子只是個演示，在實際中仍是別這樣作了，須要根據具體邏輯進行校驗。

自定義分組校驗

  對於以前提到了當xxType值爲A，paramA值必傳。xxType值爲B，paramB值必須傳這樣的場景。單獨使用分組校驗和分組序列是沒法實現的。須要使用@GroupSequenceProvider才行。

自定義分組表單

@Data
@GroupSequenceProvider(value = CustomSequenceProvider.class)
public class CustomGroupForm {

    /**
     * 類型
     */
    @Pattern(regexp = "[A|B]" , message = "類型沒必要須爲 A|B")
    private String type;

    /**
     * 參數A
     */
    @NotEmpty(message = "參數A不能爲空" , groups = {WhenTypeIsA.class})
    private String paramA;

    /**
     * 參數B
     */
    @NotEmpty(message = "參數B不能爲空", groups = {WhenTypeIsB.class})
    private String paramB;

    /**
     * 分組A
     */
    public interface WhenTypeIsA {

    }

    /**
     * 分組B
     */
    public interface WhenTypeIsB {

    }

}

CustomSequenceProvider

public class CustomSequenceProvider implements DefaultGroupSequenceProvider<CustomGroupForm> {

    @Override
    public List<Class<?>> getValidationGroups(CustomGroupForm form) {
        List<Class<?>> defaultGroupSequence = new ArrayList<>();

        defaultGroupSequence.add(CustomGroupForm.class);

        if (form != null && "A".equals(form.getType())) {
            defaultGroupSequence.add(CustomGroupForm.WhenTypeIsA.class);
        }

        if (form != null && "B".equals(form.getType())) {
            defaultGroupSequence.add(CustomGroupForm.WhenTypeIsB.class);
        }

        return defaultGroupSequence;
    }
}

測試接口

/**
 * 自定義分組
 */
@PostMapping("/customGroup")
public ResultVo customGroup(@RequestBody @Validated CustomGroupForm form){
    return ResultVoUtil.success(form);
}

測試結果

Type類型爲A

Type類型爲B

小結一下

  GroupSequence註解是一個標準的Bean認證註解。正如以前，它可以讓你靜態的從新定義一個類的，默認校驗組順序。然而GroupSequenceProvider它可以讓你動態的定義一個校驗組的順序。

注意的一個點

SpringBoot 2.3.x 移除了validation依賴須要手動引入依賴。

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

總結

  我的的一些小經驗，參數的非空判斷，這個應該是校驗的第一步了，除了非空校驗，咱們還須要作到下面這幾點：

  • 普通參數 - 須要限定字段的長度。若是會將數據存入數據庫，長度以數據庫爲準，反之根據業務肯定。
  • 類型參數 - 最好使用正則對可能出現的類型作到嚴格校驗。好比type的值是【0|1|2】這樣的。
  • 列表(list)參數 - 不只須要對list內的參數是否合格進行校驗，還須要對list的size進行限制。好比說 100。
  • 日期，郵件，金額，URL這類參數都須要使用對於的正則進行校驗。
  • 參數真實性 - 這個主要針對於 各類Id 好比說 userId、merchantId，對於這樣的參數，都須要進行真實性校驗，判斷系統內是有含有，而且對應的狀態是否正常。

  參數校驗越嚴格越好，嚴格的校驗規則不只能減小接口出錯的機率，同時還能避免出現髒數據，從而來保證系統的安全性和穩定性。

錯誤的提醒信息須要友好一點哦，防止等下被前端大哥吐槽哦。

上期回顧

結尾

  若是以爲對你有幫助，能夠多多評論，多多點贊哦，也能夠到個人主頁看看，說不定有你喜歡的文章，也能夠隨手點個關注哦，謝謝。

  我是不同的科技宅，天天進步一點點，體驗不同的生活。咱們下期見！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程