SpringBoot如何校驗yue-library框架

這篇文章給大家介紹SpringBoot如何校驗yue-library框架，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

validator

• 輕量級服務端校驗框架

• 支持注解、功能齊全、使用簡便

一、功能簡介

主要提供便捷的后臺數據校驗功能，支持單個字段或參數校驗，也支持通過注解校驗對象，用法簡單。

提供基本的非空、長度、大小等校驗方法，也提供一些特殊的正則校驗、身份證、電話、郵箱、IP等校驗方法。

二、注解介紹

@Valid 被注解的元素是一個POJO對象，用于檢查此對象的所有被注解字段的值是否符合預期

Bean Validation 中內置的 constraint

Hibernate Validator 附加的 constraint

Yue Validator 附加的 constraint

三、參數驗證

單個參數驗證

單個參數驗證

// 參數
String name = validationIPO.getName();
String email = validationIPO.getEmail();
String cellphone = validationIPO.getCellphone();
int age = validationIPO.getAge();
DateTime birthday = validationIPO.getBirthday();

// 獲得參數校驗器-Bean注入
import ai.yue.library.base.validation.Validator;
@Autowired
private Validator validator;

// 獲得參數校驗器-靜態方法
Validator.getValidatorAndSetParam(email).email("email");

// 單個參數校驗
validator.param(email).email("email");
validator.param(cellphone).cellphone("cellphone");
validator.param(name).notNull("name").chinese("name").length(1, 30, "name");

單個參數校驗-通過param()連寫（連寫直接切換校驗對象）

validator.param(name).notNull("name").param(email).length(5, 25, "email").param(age).min(20, "age").max(60, "age");

POJO對象校驗（推薦）

在類的屬性上定義注解，同時支持自定義錯誤信息

@Data
public class ValidationIPO {

    @NotEmpty(message = "姓名不能為空")
    @Length(max = 20, message = "姓名不能超過20個字")
    private String name;
    
    private DateTime birthday;
    
    @IdCard
    private String idcard;
    
    @Max(30)
    @Min(12)
    private int age;
    
    @Email
    @Length(max = 50)
    private String email;
    
    @Cellphone
    private String cellphone;
    
    @Pattern(regexp = "[1-9]([0-9]{5,11})")
    private String qq;
    
}

方式一： Controller層，通過注解@Valid校驗 （推薦）

@PostMapping("/valid")
public Result<?> valid(@Valid ValidationIPO validationIPO) {

方式二： 通過調用validator.valid()方法

validator.valid(validationIPO);
// 同樣支持連寫
validator.valid(validationIPO).param(birthday).birthday("birthday");

方式三： 將@Valid注解添加到POJO類上

@Data
@Valid
public class ValidationIPO {
	// ...
}

并在Controller層接收此實體參數

@PostMapping("/valid")
public Result<?> valid(ValidationIPO validationIPO) {

校驗不通過時處理

校驗不通過會拋出ValidateException（運行時異常），ResultExceptionHandler類已默認處理。

錯誤響應示例：

{
    "code": 433,
    "msg": "參數校驗未通過，請參照API核對后重試",
    "flag": false,
    "count": null,
    "data": [
        {
            "errorkey": "cellphone",
            "errorValue": null,
            "errorHintMsg": "不是一個合法的手機號碼"
        },
        {
            "errorkey": "idcard",
            "errorValue": "500223199607125633",
            "errorHintMsg": "不是一個合法的身份證號碼"
        }
    ]
}

關于SpringBoot如何校驗yue-library框架就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。