Spring Boot （六）：为 JPA 插上翅膀的 QueryDSL

最新推荐文章于 2021-11-15 16:41:42 发布

17860391570

最新推荐文章于 2021-11-15 16:41:42 发布

阅读量103

点赞数 3

本文链接：https://blog.csdn.net/m0_46413279/article/details/106408017

版权

引言
不可否认的是 JPA 使用是非常方便的，极简化的配置，只需要使用注解，无需任何 xml 的配置文件，语义简单易懂，但是，以上的一切都建立在单表查询的前提下的，我们可以使用 JPA 默认提供的方法，简单加轻松的完成 CRUD 操作。

但是如果涉及到多表动态查询， JPA 的功能就显得有些捉襟见肘了，虽然我们可以使用注解 @Query ，在这个注解中写 SQL 或者 HQL 都是在拼接字符串，并且拼接后的字符串可读性非常的差，当然 JPA 还为我们提供了 Specification 来做这件事情，从我个人使用体验上来讲，可读性虽然还不错，但是在初学者上手的时候， Predicate 和 CriteriaBuilder 使用方式估计能劝退不少人，而且如果直接执行 SQL 连表查询，获得是一个 Object[] ，类型是什么？字段名是什么？这些都无法直观的获得，还需我们手动将 Object[] 映射到我们需要的 Model 类里面去，这种使用体验无疑是极其糟糕的。

这一切都在 QueryDSL 出世以后终结了， QueryDSL 语法与 SQL 非常相似，代码可读性非常强，异常简介优美，，并且与 JPA 高度集成，无需多余的配置，从笔者个人使用体验上来讲是非常棒的。可以这么说，只要会写 SQL ，基本上只需要看一下示例代码完全可以达到入门的级别。

QueryDSL 简介
QueryDSL 是一个非常活跃的开源项目，目前在 Github 上的发布的 Release 版本已经多达 251 个版本，目前最新版是 4.2.1 ，并且由 Querydsl Google组和 StackOverflow 两个团队提供支持。

QueryDSL 是一个框架，可用于构造静态类型的类似SQL的查询。可以通过诸如 QueryDSL 之类的 API 构造查询，而不是将查询编写为内联字符串或将其外部化为XML文件。

例如，与简单字符串相比，使用 API 的好处是

IDE中的代码完成

几乎没有语法无效的查询

可以安全地引用域类型和属性

更好地重构域类型的更改

QueryDSL 使用实战
3.1 引入 Maven 依赖
代码清单：spring-boot-jpa-querydsl/pom.xml

<!--QueryDSL支持-->
<dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-apt</artifactId>
    <scope>provided</scope>
</dependency>
<!--QueryDSL支持-->
<dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-jpa</artifactId>
</dependency>

这里无需指定版本号，已在 spring-boot-dependencies 工程中定义。
3.2 添加 Maven 插件
添加这个插件是为了让程序自动生成 query type (查询实体，命名方式为：“Q”+对应实体名)。
上文引入的依赖中 querydsl-apt 即是为此插件服务的。

注：在使用过程中,如果遇到 query type 无法自动生成的情况，用maven更新一下项目即可解决(右键项目 -> Maven -> Update Folders)。

代码清单：spring-boot-jpa-querydsl/pom.xml

<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
    <plugin>
        <groupId>com.mysema.maven</groupId>
        <artifactId>apt-maven-plugin</artifactId>
        <version>1.1.3</version>
        <executions>
            <execution>
                <goals>
                    <goal>process</goal>
                </goals>
                <configuration>
                    <outputDirectory>target/generated-sources/java</outputDirectory>
                    <processor