tools-db-query：数据查询辅助工具

1、背景

在spring生态下，当前已经有很好的db查询工具了，即mybatisplus。对于单表查询，我们可以在不用写一行sql的情况下完成数据的各种条件查询，简单、方便且更符合程序员的习惯。
但在分布式情况下，我们每个功能模块都会以接口的方式给其他模块或外部服务提供接口，而不同的接口或业务，查询的表及字段等都不同，我们需要进行大量的模式化的定义及同质化的代码开发。这就导致，如果我们在接口设计的时候没有考虑到某个字段的查询，后续需要接口参数、mapper查询等等全部开发一遍。甚至类似的工作还会重复多次。但这些工作实际都是可以进行抽象出来的。如精确查询，在实际查询db的时候，需要的只是字段名称、字段值，其他如范围查询，in查询等等都是类似的。
基于以上想法，我们结合mybatisplus可以做两方面的辅助工具。一方面，微服务内部，可以基于此工具，实现类似mybatisplus的，基于代码的动态查询的能力；另一方面，对分布式服务，我们可以在接口层面支持类似本地的动态查询的能力。

2、这个工具能做什么？

这个工具主要是减少我们写模式化的动态sql，通过定义一些通用的查询模式，我们只需开发一次，后续如果需要查询表中其他字段，无需再次开发，只需加查询参数即可。

3、工具简介

3.1、工具maven依赖

<dependency>
    <groupId>io.github.zhaozhou1489</groupId>
    <artifactId>tools-db-query</artifactId>
    <version>0.0.4</version>
</dependency>

源码githug地址：https://github.com/zhaozhou1489/easy-tools/tree/master/tools-db-query

image.png

客户端功能模块说明：

• Query模块：封装基础查询及组合查询。基础查询：如equal查询、like查询、in查询等，及对应的not查询，同时支持排序及limit处理；组合查询：任何查询的AND/OR组合查询，类似ElasticSearch的布尔查询功能。
• QueryBuilder模块：对各种Query进行封装的模块，方便快捷创建查询。同时最终输出查询参数QueryParam。
• QueryParam模块：通过QueryBuilder构造出来的各种Query查询及排序规则等的组合，其主要用于跨服务的传输，将组合后的查询参数传给服务端。

服务端功能模块说明：

• QueryParser：查询参数解析器，将序列化的查询反序列化为对应的Query查询对象。
• QueryCond：查询条件，解析QueryParam后对应的查询条件。
• QueryTransUtil：参数转换工具，将传输参数QueryParam转换为服务端使用的QueryCond参数。其会利用QueryParser和QueryValidator处理QueryParam，并最终输出合法的QueryCond。
• QueryValidator：查询校验器，其主要是校验QueryCond中各种查询类型是否合法，如字段名是否必填，值是否必填等；
• QueryWrapperUtil：将QueryCond转换为mybatisplus的QueryWrapper查询，后续服务端可以直接使用mybatis-plus的动态查询能力进行db查询。
• QueryCondServiceImpl：一个简单的基于mybatisplus的ServiceImpl封装的用于QueryCond的实现类，您可以继承此类并基于QueryCond快速地实现selectOne、selectList及selectPage查询。

支持的查询类型：

查询类型	支持not查询	说明
EqualQuery	Y	精确查询
InQuery	Y	in查询
LikeQuery	Y	模糊查询
NullQuery	Y	null查询
RangeQuery	Y	范围查询
BooleanQuery	Y	组合（AND\OR）其他任何查询

4、使用指南

4.1、客户端使用

示例源码：https://github.com/zhaozhou1489/test-example.git中的TestController类

@RestController
@RequestMapping(value = "/test")
public class TestController {
    
    @GetMapping("/selectOne")
    public Object selectOne(){
        //通过QueryBuilder构造查询参数
        QueryBuilder builder = QueryBuilder.newBuilder();
        builder.addEqualQuery("code","111")
                .addLikeQuery("name","tom");
        //通过http请求调用对应接口
        Object obj=  this.postRequest("/user/selectOne", builder.getQueryParam());
        return obj;
    }
}

主要是通过QueryBuilder构造查询参数，并通过构造参数请求服务端接口。

4.2、服务端使用

示例源码：https://github.com/zhaozhou1489/test-example.git中的UserController类

使用示例：
service层代码：

@Service
public class UserService extends QueryCondServiceImpl<UserMapper, User> {
}

直接继承QueryCondServiceImpl即可实现基于QueryCond的查询。

controller层代码：

@RestController
@RequestMapping(value = "/user")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("/selectOne")
    public Object selectOne(@RequestBody QueryParam param){
        //解析及验证查询参数
        QueryCond cond = new QueryCond();
        String errMsg = QueryTransUtil.transQueryParam(param,cond,null,null);
        if (StringUtils.isNotBlank(errMsg)){
            return errMsg;
        }
        //查询db
        return userService.selectOne(cond);
    }


    @PostMapping("/selectList")
    public Object selectList(@RequestBody QueryParam param){
        //解析及验证查询参数
        QueryCond cond = new QueryCond();
        String errMsg = QueryTransUtil.transQueryParam(param,cond,null,null);
        if (StringUtils.isNotBlank(errMsg)){
            return errMsg;
        }
        //查询db
        return userService.selectList(cond);
    }

    @PostMapping("/selectPage")
    public Object selectPage(@RequestBody QueryParam param){
        //解析及验证查询参数
        QueryCond cond = new QueryCond();
        String errMsg = QueryTransUtil.transQueryParam(param,cond,null,null);
        if (StringUtils.isNotBlank(errMsg)){
            return errMsg;
        }
        //查询db
        return userService.selectPage(cond, 1, 10);
    }

核心逻辑为使用QueryTransUtil将QueryParam解析及转换为QueryCond，然后使用QueryCond进行查询。

5、规范及限制

5.1、QueryParam中字段名称

QueryParam中所有字段都遵循驼峰格式，在服务端进行db查询的时候，工具会自动把驼峰格式转换为下划线格式。所以需要字段名称和db中的名称对应。

5.2、QueryTransUtil.transQueryParam()使用

QueryTransUtil.transQueryParam()用于将QueryParam解析并转换为QueryCond
方法签名：String transQueryParam(QueryParam queryParam, QueryCond queryCond, Set<String> validFields, Set<String> requiredFields)
说明：

• QueryParam：客户端传入的查询参数。
• QueryCond：转换的查询条件结果；
• validFields：字段名称校验，如果为空，不做校验，否则所有字段的名字必须在此集合内；
• requiredFields：必填字段，如果为空，不做校验；否则查询中必须有这些字段；
• 返回值：类型String，如果为非空，则为错误message；否则表示处理成功；

5.3、QueryWrapperUtil.transQueryCond()的使用

QueryWrapperUtil.transQueryCond()用于将QueryCond转换为用于mybatisplus查询的QueryWrapper。
方法签名：QueryWrapper transQueryCond(QueryWrapper wrapper, QueryCond cond)
说明：

• QueryWrapper：关联的QueryWrapper；
• QueryCond：查询条件；

5.5、BooleanQuery查询的限制

BooleanQuery支持嵌套BooleanQuery及其他组合查询

5.6、查询数据量的限制

所有查询limit中count不能超过10000。如果超过或未设置，则自动设置为10000；