QueryDSL是一个Java语言编写的通用查询框架,专注于通过JavaAPI方式构建安全的SQL查询。QueryDSL可以应用到NoSQL数据库上,QueryDSL查询框架可以在任何支持的ORM框架或者SQL平台上以一种通用的API方式来构建SQL。目前QueryDSL支持的平台包扣JPA、JDO、SQL、Java Collections、RDF、Lucene、Hibernate Serch、MongoDB等。
本章目标
学习使用SpringBoot项目下SpringDataJPA与QueryDSL框架整合,完成多表关系复杂查询。
构建项目
本章开发工具使用IntelliJ IDEA,我们创建一个SpringBoot项目,预先导入Web、SpringDataJPA、MySQL、Durid依赖,目录结构如下图1所示:
图1配置SpringDataJPA
本章就不做详细的介绍SpringDataJPA了,请复制第十三章:SpringBoot实战SpringDataJPA(源码地址:git.oschina.net/jnyqy/lessons),章节内的application.yml配置文件到本章resources目录下。如下图2所示:
图2创建测试表
本章使用两张表进行讲解,两张表之间存在关联外检关系,我们使用商品信息表、商品分类信息表来讲解本章内容。
商品信息表结构如下图3所示:
图3商品分类信息表结构如下图4所示:
图4配置QueryDSL
我们在SpringBoot项目内使用queryDSL需要导入maven依赖以及添加maven插件,修改pom.xml配置文件添加querydsl依赖以及插件如下图5所示:
图5上面我们导入的querydsl的maven依赖,下面的插件很重要,当我们执行maven compile命令的时候,queryDSL这个插件会自动在我们配置的目录下生成Qxxx结构化查询实体对象,querydsl完全采用面向对象的方式来创建查询。
生成Query查询对象
我们上面导入工作已经做完,接下来我们需要让maven执行querydsl的插件自动生成查询实体对象,我们需要先配置项目的maven命令,添加一条compile,点击:Run -> Edit Configurations -> "+" -> Maven,配置如下图6所示:
图6配置完成后点击“Apply”后就已经配置好了,接下来我们运行maven compile命令,点击IntelliJ IDEA工具右上角选择maven compile执行,如下图7所示:
图7点击绿色三角运行compile命令,控制台日志输出内容如下图8所示:
图8maven输出的提示执行maven compile命令成功了,那么我们去target下查看是否已经创建了generated-sources/java目录,如下图9所示:
图9文件内现在是没有内容的,因为我们还没有添加实体在项目中,下面我们根据数据库内的表结构创建对应实体。
商品信息实体内容如下图10所示:
图10商品分类信息实体如下图11所示:
图11上面两个实体内自行添加getter/setter方法,可以看到我们在商品信息实体内配置分类实体的关联而且是@OneToOne(一对一)的关联。
实体已经创建完成,下面我们再次执行maven compile命令,再次查看target下的querydsl目录内容变化,如下图12所示:
图12目录内有两个querydsl插件自动生成的实体,命名规则就是原实体名称前+Q前缀。可以查看类内的代码,都是由querydsl插件自动构建的。
使用QueryDSL
准备工作已经做好,下面我们创建测试程序使用我们引入的querydsl完成查询功能,我们先来创建一个QueryController,作为访问入口,代码如下图13所示:
图13使用QueryDslPredicateExecutor
我们创建一个GoodJPA接口,让其继承QueryDslPredicateExecutor接口,该接口是SpringDataJPA提供的querydsl查询接口。GoodJPA代码如下图14所示:
图14这样GoodJPA就拥有了SpringDataJPA整合QueryDSL的方法实现,我们再来修改QueryController添加GoodJPA的Spring注入Bean,然后添加根据商品分类查询商品列表的方法。如下图15所示:
图15上图5我们注入了EntityManager对象,因为我们构建JAPQuery对象需要它作为参数传入,使用QueryDSL查询的形式完全就是我们平时使用对象的形式那么简答,没有多余的内容!上面我完全使用的QueryDSL进行的查询操作,我们先像数据库表信息添加几条测试数据,然后访问测试下,下面接着说SpringDataJPA下怎么使用JPA。
独立QueryDSL查询测试
运行项目,访问地址:127.0.0.1:8080/query,界面输出内容如下图16所示:
图16我查询的是分类为1的商品列表,可以看到数据完全正确的给我们返回了,这个仅仅是QueryDSL自己完成的操作,接下来我们使用SpringDataJPA整合QueryDSL完成相同的查询效果。
SpringDataJPA整合QueryDSL
我们打开QueryController添加join方法,代码如下图17所示:
图17相对于单独的QueryDSL查询而言,整合的方式会更复杂一点,所以可以封装简单的查询对象来简化代码。
Inquirer
自定义查询实体类,该类可以完成查询添加封装,查询结果处理操作,具体代码如下图18、19所示:
图18 图19简单的对查询条件,返回结果做出了封装,下面我们再来修改join方法的实现,如下图20所示:
图20重启下项目访问地址测试,界面输出内容如下图21所示:
图21总结
综上所述本章的内容已经讲解完成,本章主要讲解了SpringBoot项目下SpringDataJPA如果整合QueryDSL完成查询操作,单独QueryDSL查询如何完成查询,简单封装了查询对象Inquirer。
本章内容已上传到码云:
SpringBoot配套源码地址:https://gitee.com/hengboy/spring-boot-chapter
SpringCloud配套源码地址:https://gitee.com/hengboy/spring-cloud-chapter
SpringBoot相关系列文章请访问:目录:SpringBoot学习目录
QueryDSL相关系列文章请访问:QueryDSL通用查询框架学习目录
SpringDataJPA相关系列文章请访问:目录:SpringDataJPA学习目录
SpringBoot相关文章请访问:目录:SpringBoot学习目录,感谢阅读!
欢迎加入QQ技术交流群,共同进步。
QQ技术交流群
网友评论
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
version要改成 1.5.2.RELEASE 才有QueryDslPredicateExecutor 这货
改回@Column就正常了,请问这是为什么?
Execution default of goal com.mysema.maven:apt-maven-plugin:1.1.3:process failed: Plugin com.mysema.maven:apt-maven-plugin:1.1.3 or one of its dependencies could not be resolved: Failed to collect dependencies at com.mysema.maven:apt-maven-plugin:jar:1.1.3 -> org.apache.maven:maven-plugin-api:jar:2.2.0 (com.mysema.maven:apt-maven-plugin:1.1.3:process:default:generate-sources)