API参数如何验证?别纠结,拿去用就是

关注“一猿小讲”公众号的小伙伴都清楚,在七夕虐狗的日子,我们结合以往的实战项目,重磅推出《七夕,带你生撸一个验证框架》,一起生撸了一个 API 参数验证的轮子。


打造的那款轮子可以使研发人员,不再纠结参数校验,通过简单的配置就可以完成校验;可以腾出更多时间,去完成业务代码的编写;充分达到验证与业务剥离。


好了,低调点,不吹捧啦。还是回归一下今天的主题,今天我们主要分享项目实战中,另一种常用的参数校验框架 Hibernate Validator,请准备好小板凳,我们的分享开始。


1.

是啥?

先抛一张图,锻炼一下你的观察力。



通过上图有没有发现,数据校验可谓是贯穿所有的应用程序层(从表示层到持久层),而通常在每一层要实现相同的验证逻辑,这样既耗时又容易出错。


那再抛一张图,欢迎大家一起来找茬(结合上幅图)。



我们会发现,为了避免每层进行重复的数据验证,可以将验证逻辑直接捆绑到域模型中,将域类与验证代码混淆。


有点意思,你可能会有点懵,莫急!你就简单认为在你的实体类属性上加点校验规则,但是这些校验规则到底该怎么加呢?


这不在 JSR380-Bean Validation 2.0 中为实体和方法验证定义元数据模型和API,是不是又茫然啦,啥是 JSR?啥是JSR380?


为了以后再见到内心不发虚,我们再解释一下。


JSR 是 Java 界的一个重要标准,是 Java Specification Requests 的缩写,意思是 Java 规范提案,任何人都可以提交 JSR ,以向 Java 平台增添新的 API 和服务。


JSR380-Bean Validation 2.0 是 Java 定义的一套最新的数据校验规范。


说了这么多,只有规范没有实现,一切都是扯淡。别急,该我们的大猪蹄子 Hibernate Validator 登场了。


那 Hibernate Validator 到底是啥?一句话说清楚:Hibernate Validator 是 JSR 380 数据校验规范的一种实现。


到这,你多多少少应该了解 JSR、JSR 380、Hibernate Validator。


好了,光耍嘴皮子,不干活那是码农中的流氓,也是时候真刀真枪的操练起来了。


2.

咋用?


第一步:引入依赖包。不用太纠结,用就完了。

<dependencies>    
    <dependency>        
        <groupId>org.hibernate</groupId>        
        <artifactId>hibernate-validator</artifactId>        
        <version>6.0.17.Final</version>    
    </dependency>    
    <dependency>        
        <groupId>org.glassfish</groupId>        
        <artifactId>javax.el</artifactId>        
        <version>3.0.1-b09</version>    
    </dependency>    
    <dependency>        
        <groupId>org.hibernate</groupId>        
        <artifactId>hibernate-validator-cdi</artifactId>        
        <version>6.0.17.Final</version>    
    </dependency>
</dependencies>复制代码


第二步:定义登录请求对象,添加校验规则。主要关注注解即可,So easy!!

import javax.validation.constraints.*;

public class UserLoginRequest {

    @NotNull(message = "[接口版本号]不能为空!")
    @Pattern(regexp = "^(\\d+)(\\.\\d+)?$", message = "[接口版本号]格式错误!")
    @Size(min = 0, max = 4, message = "[接口版本号]长度错误,最大长度为[{max}]!")
    private String versionNo;

    @NotNull(message = "[手机号]不能为空!")
    @Size(min = 0, max = 11, message = "[用户手机号码]长度错误,最大长度为[{max}]!")
    private String mobile;

    @NotNull(message = "[订单号]不能为空!")
    @Size(min = 0, max = 32, message = "[订单号]长度错误,最大长度为[{max}]!")
    private String orderId;

    @NotNull(message = "[验证码]不能为空!")
    @Size(min = 0, max = 6, message = "[验证码]长度错误,最大长度为[{max}]!")
    private String smsCode;

    //TODO 提供setter/getter ... ...
}复制代码


第三步:按照常规,应该写个测试类,跑跑看,这次咱们就一步到位,直接封装工具类。可以直接拿去真实项目去实践,绝对好用。

import javax.validation.*;
import java.util.*;

public class ValidateUtil {

    public static  void validate(T t) {
        if (null == t) {
            throw new ValidateException("E0001", "参数为空");
        }

        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Set> constraintViolations = validator.validate(t);

        List errorList = new ArrayList();
        for (ConstraintViolation constraintViolation : constraintViolations) {
            errorList.add(constraintViolation.getMessage());
        }
        if (!errorList.isEmpty()) {
            throw new ValidateException("E9999", errorList.toString());
        }
    }
}复制代码


第四步:自定义异常,这个根据实际情况而定,非必须。

public class ValidateException extends RuntimeException {

    private String code;

    private String msg;

    /**
     * @param code 异常码
     * @param msg  异常消息
     */
    public ValidateException(String code, String msg) {
        super(msg);
        this.setCode(code);
        this.setMsg(msg);
    }
    
    //TODO 提供setter/getter ... ...
}复制代码


第五步:跑起来,看一看是否经得起考验。

public class App {
    public static void main(String[] args) {
        UserLoginRequest request = new UserLoginRequest();
        request.setVersionNo("abc"); //版本号输入错误
        request.setMobile("138013800000"); //手机号长度有误
        try {
            ValidateUtil.validate(request);
        } catch (ValidateException e) {
            //TODO 在实际业务中直接获取异常码、异常信息进行包装返回给前端即可
            System.out.println(String.format("code: %s, msg:%s",e.getCode(),e.getMsg()));
        }
    }
}复制代码


第六步:结果分析,看到结果,果真达到预期:手机号码长度错误、接口版本号格式有误、其它参数值传入为空。


3.

技术无止境,剩下的还需要各位自行去耕耘,不过掌握上面这些,已经够你在项目中喝一壶的啦。


好了,通过这次正规军式的分享 + 上次野战军式的分享,相信你今后肯定能玩转 API 参数校验,也就可以专心去写业务代码啦,如果你之前尚未接触过这些,不妨拿去实践,大概率会大幅提升你的研发效率,腾出更多时间喝咖啡,幸福感陡然上升。

推荐阅读:

七夕,带你生撸一个验证框架

这部技术葵花宝典真的很硬核


猜你喜欢

转载自juejin.im/post/5d521647f265da03ca1160a5