CN111125440A - 一种基于Monad的持久层复合条件查询方法与存储介质 - Google Patents

Abstract

本发明请求保护一种基于Monad的持久层复合条件查询方法与存储介质，当前大部分Java应用的持久层都会使用ORM框架来消除面向对象语言与关系型数据库之间的“阻抗不匹配”现象，提升开发的效率，但是，当前主流的ORM框架，如Mybatis、Hibernate等各自都存在问题影响开发效率，如SQL不可控、优化困难、依赖文件过多等等，为了克服这些缺点，本文提出了一种基于Mybatis的持久层框架，该框架在Mybatis功能基础之上结合Linq风格实现了一种SQL可控的快速查询功能，通过该功能可以减少查询所依赖的相关文件，同时，自动检测并生成SQL文件实现可控可优化，避免了过度封装API所导致的SQL优化难的问题，提升开发效率，缩短开发周期。

Description

一种基于Monad的持久层复合条件查询方法与存储介质

技术领域

本发明属于计算机领域，尤其涉及一种于Monad的持久层复合条件查询方法与存储介质。

背景技术

当前，随着互联网规模的急剧增长，越来越多的企业更看重软件应用的开发速率以争取在激烈的市场竞争中占得先机，在实际软件开发过程中，软件应用需要频繁的对数据库中的记录进行查询和更新操作，也就是说，实现数据库交互的代码的工作量所占据的比例不容小觑,软件开发人员会花费大量的时间去编写数据库交互的代码。

数据在应用系统中以对象的形式存在，而在数据库中表现为带有关系的元组，所以在应用中与数据库交互时需要将对象转换为关系型数据并结合数据库能识别的SQL语句进行操作，由于与数据库交互是非常频繁的操作，所以在开发过程中必然伴随大量重复的转换工作，而持久层框架作为关系型数据库与面向对象语言之间”阻抗不匹配”矛盾的一种解决方案被广泛使用，持久层在应用层与数据库之间建立表与对象之间的映射关系，通过持久层框架实现将对对象的操作转换为SQL与数据库交互，一定程度上降低重复繁琐的工作量、提升程序的可扩展性、移植性，目前，被广泛使用的持久层框架有Mybatis与Hibernate，本文将在Mybatis的基础之上结合两种持久层框架的优点设计一种更加灵活、有助于提升开发效率的持久层工具。

主流的持久层框架可以按照使用风格分为两种，一种是以Hibernate为代表的全自动持久层框架，Hibernate为开发人员提供通过使用JavaAPI构建SQL语句的方式与数据库交互，另一种是Mybatis为代表的半自动持久层框架，Mybtais需要开发人员手动记录需要的SQL语句，Mybatis提供参数与执行结果的自动封装、动态SQL与SQL集中管理等功能简化开发工作量和降低耦合性。

Hibernate是一个全自动的持久层框架，也是目前较为流行的持久层框架，它通过将数据库资源映射为对象模型，将面向数据库资源的各种业务操作以对象的属性和方法展示，使开发人员将更多的精力放在业务逻辑的实现上，不必在意直接与数据库交互的细节问题，如数据库SQL差异等，Hibernate目前是面向对象思想体现得最完善的一种持久层框架，同时也是最符合JPA规范的。

Mybatis是一个半自动化的持久层框架，它在持久层为数据库中的表与业务层中的对象建立映射关系，从而实现操作对象与数据库交互。其核心思想是通过XML文件集中式的记录管理SQL语句，每条SQL语句都存在id与对应接口中的方法绑定，同时，通过配置带入的参数类型与返回的参数类型，Mybatis为其自动封装实体类参数与结果，总的来说，MyBatis是一种半自动化的ORM框架，对于熟练使用面向对象编程的程序开发人员来说，通过MyBatis来操作对象就可以对关系数据库进行操作，这一点和Hibernate是一样的，但是最主要的不同之处在于Mybatis需要自己配置接口SQL接口文件与装载SQL的XML文件，并建立两个文件中方法与SQL的对应关系：

Mybatis需要多个映射文件并手动在XML文件中记录需要的SQL语句才可以实现关系对象映射的功能，这种实现方式较为灵活、实现的难度也较低，但是在数据库迁移的时候可能由于语法问题修改大量的配置文件。

Hibernate为业务层提供操作数据库的JavaAPI，但是由于对底层封装得过于彻底，并没有提供可以对生成SQL进行优化的接口，所以，对于后期可能存在的并发量提升所带来的性能瓶颈无能为力，只能通过更换持久层框架来解决，造成大量可以避免的资源消耗，增加维护与优化的成本。

Mybatis为开发人员提供灵活可配置的SQL定制功能，开发人员可以根据自己的需求修改、优化底层的SQL语句，但是在开发过程中，存在以下问题。

1)需要映射的文件较多，每个实体类都会对应相应的SQL接口与XML文件，同时，增加一个方法也需要同时修改SQL接口文件与XML文件，在开发阶段，频繁增加方法存在大量的工作量。

2)无法适应多条件组合的灵活查询需求，查询操作可能存在多个字段组合的情况，且字段可能存在不同的查询方式，比如范围查询、相等查询、模糊查询等，所以对于一个实体，查询的方式可能是极多的，对于n个字段的实体，如果以两个字段组合为一个方法的话，那么存在种可能，如果是任意数量的字段组合且考虑字段查询的方式的话，存在的可能更多。

发明内容

本发明旨在解决以上现有技术的问题。提出了一种基于Monad的持久层复合条件查询方法与存储介质。本发明的技术方案如下：

一种基于Monad的持久层复合条件查询方法，其所述持久层在Mybatis基础上增加Linq风格的查询模块；通过动态生成单表SQL的基础注解与SQL双向同步机制，通过链式API调用取代部分接口方法与XML文件的手动录入，查询方法包括以下步骤：

步骤1、将查询操作符大致分为单表与多表查询两种类型，分别进行单表操作和多表级联查询；

步骤2、将步骤1中的查询数据转换为持久层框架Mybatis底层能够识别的SQL资源对象，通过继承并重写Mybatis的注册器并在其中对获取到的SQL接口字节码对象判断，若其被基础数据操作注解修饰，则获取注解中单表对应实体类字节码，与基础操作方法结合Mybatis动态SQL组合生成Mybatis能够识别的SQL资源对象，并注册与保存在配置缓存中；

步骤3、通过对操作符生成的SQL与SQL管理模版的双向同步绑定提升SQL后期的可扩展性，在使用操作符生成查询语句时，对操作符操作与生成的SQL进行分析获取其唯一标识，判断其是否已经存在于配置对象的缓存中，若存在直接使用配置缓存中的SQL，反之则将根据操作符生成SQL资源对象并将其注册与记录与SQL模板文件中，在项目运行期间，检测SQL模板是否被改动，若被更新则进行热部署。

进一步的，步骤1中：对于单表操作，设计表示基础CRUD操作的四种基础注解对SQL接口进行标识，注解属性包括单表对应实体类与命名风格转换在内的信息，框架本身通过反射获取属性信息生成单表增删查改的基础方法对应的资源对象并进行注册，基础方法默认是根据主键或者字段键值对进行筛选。

对于多表级联查询或者是多条件单表查询，结合Monad模式设计出常用的操作符，为开发人员提供持久层框架内嵌的链式查询操作符，通过操作符避免由于查询参数的不同所导致频繁修改Mybatis映射文件所带来的无意义工作，在项目启动期间分析操作符获取对应的SQL与主键并将其记录在对应SQL模版文件与注册在Mybatis底层配置对象中，最大程度得复用Mybatis的原有功能模块，比如底层SQL执行、参数与结果实体类转换等。

进一步的，所述步骤2对于查询操作符实现的多条件或复杂SQL查询，框架生成对应的虚拟实体类、SQL对象与虚拟的方法名最后生成SQL资源对象，并完成注册。

进一步的，在使用查询API构建查询并执行时，持久层根据链式调用的函数与调用函数的顺序结合生成一个SQL编号，并在资源配置对象存储的SQL编号集合中进行查找，如果其中存在，则调用其对应的SQL语句并向其中填充参数，否则，说明当前查询在存储SQL的XML文件中并不存在映射的SQL记录，则结合JAXP中的SAX向其中写入相应的SQL记录，生成的SQL格式按照Mybatis的方式，持久层会判断在XML对应的配置缓存中是否已经链式查询映射的SQL记录，如果不存在的话会在XML中写入查询SQL并存入资源配置对象中，链式查询在XML文件中的映射SQL记录的编号为查询调用方法按照顺序组合而成。

一种存储介质，该存储介质内部存储计算机程序，其所述计算机程序被处理器读取时，执行上述任一项的方法。

本发明的优点及有益效果如下：

1、本发明有助于在Mybatis的基础之上构建一种更简便、快捷的灵活查询SQL构建方式，使用这种查询方式构建SQL在最大程度复用Mybatis底层基础功能的同时，在构建多条件查询时可以避免大量的繁杂配置文件与为开发人员提供更有效的编译期错误检测，提升了开发的效率与降低了错误的概率。

2、相比较于传统Hibernate对于多条件查询的解决方案，本发明中提出的SQL双向同步机制可以有效的避免由于通过Java动态生成SQL所导致的后期扩展困难、SQL管理过于分散等问题，通过该机制可以将传统的ORM框架的优势结合起来，即避免了Hibernate后期SQL优化与扩展困难的问题，同时，也解决了Mybatis在构建多条件查询时配置繁琐的问题。

本发明主要创新点为：实现了一种灵活、方便的查询SQL构建方法，弥补了传统Mybatis多条件查询构建需要大量配置的问题，能够提升项目开发的效率，同时，每个通过内置查询方法构建的SQL都与存在对应的SQL模版文件，并且通过双向同步机制保证SQL可以实现双向同步更新，使用这种方式不会导致后期SQL分散与优化困难等问题。

附图说明

图1是本发明提供优选实施例的结构示意图；

图2是本发明的主要功能流程图；

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、详细地描述。所描述的实施例仅仅是本发明的一部分实施例。

本发明解决上述技术问题的技术方案是：

通过构建灵活的内置SQL查询工具与基础注解避免繁杂配置文件，本发明所述的持久层工具是在持久层框架Mybatis的基础之上进行功能扩展实现的，为了更好的继承框架原有的SQL管理模式、数据库连接管理等，以及考虑到第三方插件对原框架的功能扩展与优化等，它将最大程度得复用框架的原有功能模块，比如底层SQL执行、参数与结果实体类转换等。

Mybatis分为执行器、类型转换、SQL节点、SQL生成器等模块，Mybatis会读取XML中的SQL语句并存入SQL资源配置对象中，再根据调用的方法生成编号匹配对应的SQL语句，同时，对传入的参数进行类型转换填充具体的SQL语句等，最后执行SQL并将结果进行实体类参数转换。

而本发明中提出的持久层工具在Mybatis基础上增加了Linq风格的查询模块、支持动态生成单表SQL的基础注解与SQL双向同步机制，通过链式API调用取代部分接口方法与XML文件的手动录入，简化流程、降低工作量实现提升开发效率，同时，通过SQL双向同步机制避免后期SQL优化困难的问题。

本发明中的查询功能的主要目的是为了让开发人员避免由于查询参数的不同所导致频繁修改Mybatis映射文件所带来的无意义工作，查询功能借鉴Monad模式设计并实现了一种类似Linq风格的链式调用达到针对任意数量字段的多条件查询功能，Mybatis主要组件包括结果实体处理器ResultSetHandler、执行器Executor、类型转换器TypeHandler与资源配置对象均为Mybatis自身提供的组件，通过继承和组合的方式复用并扩展其功能，使其扩展部分可以满足问本发明中查询功能的使用，具体的使用如下：

QueryConfig.getQuery(User.class).andEq("name","zhangsan").andLike("address","CQ").getResult()，其中QueryConfig作为查询配置类，主要为指定的实体类或者联合多表查询对象生成对应的查询对象，再调用相关条件构建函数，如上所示，结合Monad模式实现链式调用并生成相应的SQL，在获取相关信息生成SQL资源对象注册在Mybatis中，最后，通过ResultSetHandler的实现类QueryResultHandler实现数据与实体类数据之间的类型转换，由Mybatis执行底层与数据库交互等相关功能，另外，实现单表的多条件快速查询，针对多表查询也有相应的查询API可供调用，主功能流程设计如图2所示，其中操作符操作如下所示:

QueryConfig.leftJoinQuery(QueryConfig.getQuery(User.class).getQuery(),QueryConfig.getQuery(Unit.class).getQuery(),).andOn(“unit”,”unit”).andLeftEq(“name”,”zhangsan”).getResult()；

通过getQuery()获取单表查询的查询对象并将其作为参数带入leftJoinQuery()中实现量表联合查询，联合查询的实现使用了Monad模式对细粒度的操作符进行组合，对于多表联合查询只需要将表查询对象两两之间进行组合并获取查询对象作为leftJoinQuery()的参数执行即可，但是对于过于复杂的SQL通过API链式调用虽然可以实现其功能，过于复杂繁琐的API调用从程序代码的可读性上并不令人满意，所以，还是需要与Mybatis的原生SQL模版功能互补使用才能更快更好得完成开发。

通过双向SQL同步机制可以避免类似Hibernate通过API生成的SQL无法优化所导致的后期性能瓶颈，通过这种机制可以有效地将查询API的便捷性与SQL模版的灵活性结合在一起，将Hibernate与Mybatis优势互补实现高效、灵活的查询。

在使用查询API构建查询并执行时，持久层会根据链式调用的函数与调用函数的顺序结合生成一个SQL编号，并在资源配置对象存储的SQL编号集合中进行查找，如果其中存在，则调用其对应的SQL语句并向其中填充参数，否则，说明当前查询在存储SQL的XML文件中并不存在映射的SQL记录，则结合JAXP中的SAX向其中写入相应的SQL记录，生成的SQL格式按照Mybatis的方式，便于开发人员理解，持久层会判断在XML对应的配置缓存中是否已经链式查询映射的SQL记录，如果不存在的话会在XML中写入查询SQL并存入资源配置对象中，这样就可以在避免繁琐更改配置文件的工作量的同时，使生成的查询SQL具备可优化的潜力，避免其成为在后期用户访问量剧增后的性能瓶颈，同时，链式查询在XML文件中的映射SQL记录的编号为查询调用方法按照顺序组合而成，这样便于开发人员在对SQL进行优化时可以快速根据链式查询找到对应的SQL记录，同时，本文中提出的持久层也为开发人员提供自定义SQL编号的功能，开发人员可以根据开发团队的命名规范对查询进行自定义定制，如下所示：

QueryConfig.getQuery(User.class,”queryUserByNameAndAddress”).andEq("name","zhangsan").andLike("address","CQ").getResult()，如上所示，在获取查询对象时为其设置编号”queryUserByNameAndAddress”，使其生成的SQL记录的编号与Mybatis中接口方法中命名风格类似，从整体上，向Mybatis风格靠拢，便于同团队内其他成员理解，也有利于后期维护人员对应的快速适应与熟悉。

另外，由于复用了Mybatis中配置对象、配置XML文件的读取，所以，再减少了部分工作量的同时，也使查询映射XML文件具备了热部署的功能，在程序运行期间根据编辑了的XML文件动态得更新资源配置对象中的SQL数据，实现动态优化SQL。

本领域普通技术人员可以理解上述实施例的各种方法中的全部或部分步骤是可以通过程序来完成，该程序可以存储于计算机可读存储介质中，存储介质可以包括：ROM、RAM、磁盘或光盘等。

以上这些实施例应理解为仅用于说明本发明而不用于限制本发明的保护范围。在阅读了本发明的记载的内容之后，技术人员可以对本发明作各种改动或修改，这些等效变化和修饰同样落入本发明权利要求所限定的范围。

Claims (5)

1.一种基于Monad的持久层复合条件查询方法，其特征在于，所述持久层在Mybatis基础上增加Linq风格的查询模块；通过动态生成单表SQL的基础注解与SQL双向同步机制，通过链式API调用取代部分接口方法与XML文件的手动录入，查询方法包括以下步骤：

步骤1、将查询操作符大致分为单表与多表查询两种类型，分别进行单表操作和多表级联查询，针对不同的查询设计不同的实现方案；

步骤2、将步骤1中的查询数据转换为持久层框架Mybatis底层能够识别的SQL资源对象SQL资源对象，通过继承并重写Mybatis的注册器并在其中对获取到的SQL接口字节码对象判断，若其被基础数据操作注解修饰，则获取注解中单表对应实体类字节码，与基础操作方法结合Mybatis动态SQL组合生成Mybatis能够识别的SQL资源对象，并注册与保存在配置缓存中；

步骤3、通过对操作符生成的SQL与SQL管理模版的双向同步绑定提升SQL后期的可扩展性，在使用操作符生成查询语句时，对操作符操作与生成的SQL进行分析获取其唯一标识，判断其是否已经存在于配置对象的缓存中，若存在直接使用配置缓存中的SQL，反之则将根据操作符生成SQL资源对象并将其注册与记录与SQL模板文件中，在项目运行期间，检测SQL模板是否被改动，若被更新则进行热部署。

2.根据权利要求1所述的一种基于Monad的持久层复合条件查询方法，其特征在于，步骤1中：对于单表操作，设计表示基础CRUD操作的四种基础注解对SQL接口进行标识，注解属性包括单表对应实体类与命名风格转换在内的信息，框架本身可通过反射获取注解信息生成对单表增删查改的基础方法对应的资源对象并进行注册，基础方法默认是根据主键或者字段键值对进行筛选。

对于多表级联查询或者是多条件单表查询，结合Monad模式设计出常用的操作符，为开发人员提供持久层框架内嵌的链式查询操作符，通过操作符避免由于查询参数的不同所导致频繁修改Mybatis映射文件所带来的无意义工作，在项目启动期间分析操作符获取对应的SQL与主键并将其记录在对应SQL模版文件与注册在Mybatis底层配置对象中，最大程度得复用Mybatis的原有功能模块，比如底层SQL执行、参数与结果实体类转换等。

3.根据权利要求1所述的一种基于Monad的持久层复合条件查询方法，其特征在于，所述步骤2对于查询操作符实现的多条件或复杂SQL查询，框架生成对应的虚拟实体类、SQL对象与虚拟的方法名最后生成SQL资源对象，完成注册。

4.根据权利要求3所述的一种基于Monad的持久层复合条件查询方法，其特征在于，在使用查询API构建查询并执行时，持久层根据链式调用的函数与调用函数的顺序结合生成一个SQL编号，并在持久层资源配置对象Configuration存储的SQL编号集合中进行查找，如果其中存在，则调用其对应的SQL语句并向其中填充参数，否则，说明当前查询在存储SQL的XML文件中并不存在映射的SQL记录，则结合JAXP中的SAX向底层注册SQL资源，生成的资源格式按照Mybatis的方式，持久层会判断在XML对应的配置缓存中是否已经链式查询映射的SQL记录，如果不存在的话会在XML中写入查询SQL并存入资源配置对象中，链式查询在XML文件中的映射SQL记录的编号为查询调用方法按照顺序组合而成。

5.一种存储介质，该存储介质内部存储计算机程序，其特征在于，所述计算机程序被处理器读取时，执行上述权利要求1～4任一项的方法。

Images