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框架就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。