SpringBoot参数校验,消除if else方式_Java

1、参数校验简介

在实际工作中，得到数据得到的第一步就是校验数据的正确性，如果存在录入上的问题，一般会通过注解校验，发现错误后返回给用户，但是对于一些逻辑上的错误，比如购买金额 = 购买数量 × 单价购买金额=购买数量\times 单价购买金额=购买数量×单价，这样的规则就很难使用注解方式验证了，此时可以使用spring提供的验证器(validator)规则去验证。

由于validator框架通过硬编码完成数据校验，在实际开发中会显得比较麻烦，因此现在开发更加推荐使用jsr 303完成服务端的数据校验。

spring3开始支持jsr 303验证框架，jsr 303是java为bean数据合法性校验所提供的标准框架。

jsr 303支持xml风格的和注解风格的验证，通过在bean属性上标注类似于@notnull、@max等的标准注解指定校验规则，并通过标准的验证接口对bean进行验证。

访问http://jcp.org/en/jsr/detail?id=303可以查看详细内容并下载jsr 303 bean validation。jsr 303 不需要编写验证器，它定义了一套可标注在成员变量、属性方法上的校验注解，如下表所示：

约束	说明
@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)	被直接的元素必须符合指定的正则表达式

hibernate validator是jsr 303的一个参考实现,除了支持所有标准的校验注解之外，还扩展了如下表所示的注解。

约束	说明
@notblank	检查被注解的元素是不是null，以及被去掉前后空格的长度是否大于0
@email	被注解的元素必须是电子邮件格式
@url	被注解的元素必须是合法的url地址
@length	被注解的字符串的字符串的大小必须在指定的范围内
@notempty	校验集合元素或数组元素或者字符串是否非空。通常作用于集合字段或数组字段，此时需要集合或者数字的元素个数大于0。也可以作用于字符串，此时校验字符串不能为null或空串（可以是一个空格）。
@range	被注解的元素必须在合适的范围内

2、实战

spring-boot-starter-validation是spring boot 框架中的一个模块，它构建在hibernate validator的基础之上，并提供了对bean validation的集成支持。它可以通过springboot的自动配置机制轻松集成到spring应用程序中。使用 spring-boot-starter-validation，你可以在springboot应用程序中使用 hibernate validator的功能，而不需要显式地配置hibernate validator。

因此，hibernate validator是一个独立的验证框架，而 spring-boot-starter-validation 则是一个为 spring boot应用程序提供集成 hibernate validator 的模块。

在这里搭建一个简单的springboot项目，并引入如下依赖：

<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-validation</artifactid>
</dependency>
<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-web</artifactid>
</dependency>

2.1 全局异常处理

@slf4j
@controlleradvice
public class globalexceptionhandler {
    //参数校验异常
    @exceptionhandler(methodargumentnotvalidexception.class)
    @responsebody
    public result error(methodargumentnotvalidexception e){
        log.warn(e.getmessage());
        return result.fail()
                .code(resultcodeenum.argument_valid_error.getcode())
                .message(e.getbindingresult().getfielderror().getdefaultmessage());
    }
    //参数校验异常
    @exceptionhandler(bindexception.class)
    @responsebody
    public result error(bindexception e){
        log.warn(e.getmessage());
        stringbuilder sb = new stringbuilder();
        for (objecterror error : e.getbindingresult().getallerrors()) {
            sb.append(error.getdefaultmessage());
        }
        return result.fail()
                .code(resultcodeenum.argument_valid_error.getcode())
                .message(sb.tostring());
    }
    //参数校验异常
    @exceptionhandler(constraintviolationexception.class)
    @responsebody
    public result error(constraintviolationexception e){
        log.warn(e.getmessage());
        stringbuilder sb = new stringbuilder();
        for (constraintviolation<?> violation : e.getconstraintviolations()) {
            sb.append(violation.getmessage());
        }
        return result.fail()
                .code(resultcodeenum.argument_valid_error.getcode())
                .message(sb.tostring());
    }
    //全局异常
    @exceptionhandler(exception.class)
    @responsebody
    public result error(exception e){
        log.warn(e.getmessage());
        return result.fail().message("执行了全局异常处理");
    }
}

2.2 快速开始

2.2.1 实体类

@data
public class usercreatevo {
    @notblank(message = "用户名不能为空")
    private string username;

    @notblank(message = "姓名不能为空")
    private string name;

    @size(min=11,max=11,message = "手机号长度不符合要求")
    private string phone;

    @notnull(message = "性别不能为空")
    private integer sex;
}

@data
public class userupdatevo {

    @notblank(message = "id不能为空")
    private string id;

    @notblank(message = "用户名不能为空")
    private string username;

    @notblank(message = "姓名不能为空")
    private string name;

    @size(min=11,max=11,message = "手机号长度不符合要求")
    private string phone;

    @notnull(message = "性别不能为空")
    private integer sex;
}

2.2.1 定义请求接口

@validated
@restcontroller
public class usercontroller {

    @postmapping("create")
    public result createuser(@validated @requestbody usercreatevo usercreatevo){
        return result.ok("参数校验成功");
    }

    @postmapping("update")
    public result updateuser(@validated @requestbody userupdatevo userupdatevo){
        return result.ok("参数校验成功");
    }
}

2.2.2 测试

新增接口测试：

这里故意不写用户名

更新接口测试：

2.3 路径传参校验

有时候我们是通过@pathvariable注解实现参数传递的，这个时候校验如下：

@getmapping("getuserbyid/{id}")
public result getuserbyid(@pathvariable @size(min=2,max=5,message = "id长度不符合要求") string id){
    return result.ok("参数校验成功");
}

可以看到，校验规则是生效的。

2.4 分组校验

我们前边写了两个vo类：usercreatevo和userupdatevo。如果每个请求都要定制vo类的话，那我们还不如直接用if else梭哈呢。

比如我们新增的时候一般不需要id，但是修改的时候需要传入id。

2.4.1 定义分组校验接口

//分组校验
public class usergroup {
    public interface creategroup extends default {
    }
    public interface updategroup extends default {
    }
}

2.4.2 统一vo校验类

@data
public class uservo {

    @notblank(message = "id不能为空",groups = usergroup.updategroup.class)
    private string id;

    @notblank(message = "用户名不能为空",groups = 
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string username;

    @notblank(message = "姓名不能为空",groups = 
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string name;

    @size(min=11,max=11,message = "手机号长度不符合要求",groups = 
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string phone;

    @notnull(message = "性别不能为空",groups = 
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private integer sex;
}

2.4.3 修改接口

参数上边添加@validated接口，并指定分组名称,并统一使用uservo类接收参数。

@validated
@requestmapping("/user")
@restcontroller
public class usercontroller {

    @postmapping("create")
    public result createuser(@validated(usergroup.creategroup.class) @requestbody uservo uservo){
        return result.ok("参数校验成功");
    }

    @putmapping("update")
    public result updateuser(@validated(usergroup.updategroup.class) @requestbody uservo uservo){
        return result.ok("参数校验成功");
    }

    @getmapping("getuserbyid/{id}")
    public result getuserbyid(@pathvariable @size(min=2,max=5,message = "id长度不符合要求") string id){
        return result.ok("参数校验成功");
    }

}

2.4.4 测试

新增接口：

修改接口：

2.5 嵌套对象校验

存在嵌套对象校验的时候，使用@valid注解解决。

2.5.1 添加一个角色实体

@data
public class role {
    @notblank(message = "角色名称不能为空")
    private string rolename;
}

2.5.2 修改vo类

在user类中引入角色实体，并加入@valid注解。

@data
public class uservo {

    @notblank(message = "id不能为空",groups = usergroup.updategroup.class)
    private string id;

    @notblank(message = "用户名不能为空",groups =
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string username;

    @notblank(message = "姓名不能为空",groups =
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string name;

    @size(min=11,max=11,message = "手机号长度不符合要求",groups =
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private string phone;

    @notnull(message = "性别不能为空",groups =
            {usergroup.creategroup.class,usergroup.updategroup.class})
    private integer sex;

    @valid
    @notnull(message = "角色信息不能为空")
    private role role;
}

2.5.3 测试

测试新增接口，故意不传角色信息：

测试修改接口，故意不传角色信息：

2.6 快速失败配置

默认validation的校验规则默认会检查所有属性的校验规则，在每一条规则都校验完成后才抛出异常，这样子难免效率会很低，我们希望在发现错误后就不再向后检查，可以通过“快速失败”配置解决，参考代码如下：

/**
 * 参数校验相关配置
 */
@configuration
public class validconfig {
    /**
     * 快速返回校验器
     * @return
     */
    @bean
    public validator validator(){
        validatorfactory validatorfactory = validation.byprovider(hibernatevalidator.class)
                .configure()
                //快速失败模式
                .failfast(true)
                .buildvalidatorfactory();
        return validatorfactory.getvalidator();
    }

    /**
     * 设置快速校验，返回方法校验处理器
     * 使用methodvalidationpostprocessor注入后，会启动自定义校验器
     * @return
     */
    @bean
    public methodvalidationpostprocessor methodvalidationpostprocessor(){
        methodvalidationpostprocessor methodvalidationpostprocessor = new methodvalidationpostprocessor();
        methodvalidationpostprocessor.setvalidator(validator());
        return methodvalidationpostprocessor;
    }
}

2.7 自定义校验规则

有时候框架自带的校验无法满足我们业务的需求，这个时候可以根据自己的需求定制校验规则。

这里我们自定义一个手机号校验的注解，仅作示例使用，因为官方已经提供了手机号的校验注解。

2.7.1 定义注解

@documented
@retention(retentionpolicy.runtime)
@target({elementtype.method, elementtype.field, elementtype.annotation_type, elementtype.constructor, elementtype.parameter, elementtype.type_use})
@constraint(validatedby = phonevalidator.class)
public @interface phonevalid {
    string message() default "请填写正确的手机号";
    class<?>[] groups() default {};
    class<? extends payload>[] payload() default {};
}

@constraint注解是hibernate validator的注解，用于实现自定义校验规则，通过validatedby参数指定进行参数校验的实现类。

2.7.2 校验实现类

实现constraintvalidator接口。

在constraintvalidator<a extends annotation, t>中，第一个参数为注解，即annotation，第二个参数是泛型。

public class phonevalidator implements constraintvalidator<phonevalid,object> {
    /**
     * 11位手机号的正则表达式,以13、14、15、17、18头
     * ^：匹配字符串的开头
     * 13\d：匹配以13开头的手机号码
     * 14[579]:匹配以145、147、149开头的手机号
     * 15[^4\d]：匹配以15开头且第3位数字不为4的手机号码
     * 17[^49\d]:匹配以17开头且第3位数字部位4或9的手机号码
     * 18\d :匹配以18开头的手机号码
     * \d{8}：匹配手机号码的后8位，即剩余的8个数字
     * $：匹配字符串的结尾
     */
    public static final string regex_phone="^(13\\d|14[579]|15[^4\\d]|17[^49\\d]|18\\d)\\d{8}$";


    //初始化注解
    @override
    public void initialize(phonevalid constraintannotation) {
        constraintvalidator.super.initialize(constraintannotation);
    }

    //校验参数，true表示校验通过，false表示校验失败
    @override
    public boolean isvalid(object o, constraintvalidatorcontext constraintvalidatorcontext) {
        string phone = string.valueof(o);
        if(phone.length()!=11){
            return false;
        }
        //正则校验
        return phone.matches(regex_phone);
    }
}