Java的业务逻辑验证框架fluent-validator

最新推荐文章于 2024-06-12 09:38:05 发布

草莓味儿的小米佳

最新推荐文章于 2024-06-12 09:38:05 发布

阅读量907

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/weixin_44026997/article/details/108146006

版权

java 专栏收录该内容

43 篇文章

订阅专栏

FluentValidator简介

FluentValidator是百度的一个开源验证插件，简单的说，它就是为了校验数据简单并且复用而存在的。
通过这个插件，你可以对接收到的数据进行你所需要的校验，并且返回对应的错误信息，同时它还提供一些比较不错的显示错误的功能。
在我们编写项目的时候，在controller中往往离不开对一些数据的校验。这里并不是说对于这些数据业务上面的校验，而是对这些数据进行空校验或者是长度校验等。有些时候校验可以省略，根据业务的需要进行调整，而多数情况下，服务端对客户端一直采用的是不信任的策略，所以对很多参数都需要进行校验。而校验的目的就是为了安全有序的执行之后的业务逻辑。从而一定程度的上的减轻数据库的压力了，不要让数据库成为你校验数据的工具。

为何要使用FluentValidator

原因很简单，第一为了优雅，出色的程序员都有点洁癖，都希望让验证看起来很舒服；第二，为了尽最大可能符合这些优秀的原则，做clean code。
FluentValidator就是这么一个工具类库，适用于以Java语言开发的程序，让开发人员回归focus到业务逻辑上，使用流式（Fluent Interface）调用风格让验证跑起来很优雅，同时验证器（Validator）可以做到开闭原则，实现最大程度的复用。

使用

1.引入maven依赖

<dependency>
    <groupId>com.baidu.unbiz</groupId>
    <artifactId>fluent-validator</artifactId>
    <version>1.0.5</version></dependency>

注：最新release请及时参考官网。

2.开发业务领域模型

从广义角度来说DTO（Data Transfer Object）、VO（Value Object）、BO（Business Object）、POJO等都可以看做是业务表达模型。

我们这里创建一个汽车类（Car）的POJO，里面定义了牌照（license plate）、座椅数（seat count）、生产商（manufacturer）。

public class Car {
    private String manufacturer;
    private String licensePlate;
    private int seatCount;     // getter and setter...}

3 开发一个专职的Validator

实际这里需要开发三个Validator，分别对Car的3个属性进行校验，这里以座椅数为例展示如何开发一个Validator，其他两个省略。

public class CarSeatCountValidator extends ValidatorHandler<Integer> implements Validator<Integer> { 
    @Override    
    public boolean validate(ValidatorContext context, Integer t) {
        if (t < 2) {
            context.addErrorMsg(String.format("Seat count is not valid, invalid value=%s", t));
            return false;
        }
        return true;
    }}

实现Validator接口，泛型T规范这个校验器待验证的对象的类型，继承ValidatorHandler可以避免实现一些默认的方法，例如accept()，后面会提到，validate()方法第一个参数是整个校验过程的上下文，第二个参数是待验证对象，也就是座椅数。

验证逻辑很简单，座椅数必须大于1，否则通过context放入错误消息并且返回false，成功返回true。

4 开始验证吧

Car car = getCar(); 
Result ret = FluentValidator.checkAll()
                            .on(car.getLicensePlate(), new CarLicensePlateValidator())
                            .on(car.getManufacturer(), new CarManufacturerValidator())
                            .on(car.getSeatCount(), new CarSeatCountValidator())
                            .doValidate()
                            .result(toSimple()); 
System.out.println(ret);

首先我们通过FluentValidator.checkAll()获取了一个FluentValidator实例，紧接着调用了failFast()表示有错了立即返回，它的反义词是failOver，然后，一连串on()操作表示在Car的3个属性上依次使用3个校验器进行校验（这个过程叫做applying constraints），截止到此，真正的校验还并没有做，这就是所谓的“惰性求值（Lazy valuation）”，有点像Java8 Stream API中的filter()、map()方法，直到doValidate()验证才真正执行了，最后我们需要收殓出来一个结果供caller获取打印，直接使用默认提供的静态方法toSimple()来做一个回调函数传入result()方法，最终返回Result类，如果座椅数不合法，那么控制台打印结果如下：

Result{isSuccess=false, errors=[Seat count is not valid, invalid value=99]}