Spring Data JPA 项目配置与QueryDSL集成

news2024/10/6 14:32:57

一、说明

Spring Data JPA通过Spring Initializer创建时勾选相关依赖即可引入，QueryDSL需要单独引入。Spring JPA针对QueryDSL有比较好的兼容性，可以实现优雅的SQL构建。

二、设置JPA默认配置（yaml格式）

spring:
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
# 自行填写数据源

以上配置会打印hibernate的sql，同时启用自动建表。

ddl-auto有以下四种模式：

create, create-drop, update, validate, none

一般，我们生产环境使用validate或者none，开发环境选择create、update

create	每次启动清空数据且重建表，但是程序退出时不清空数据
create-drop	每次启动清空数据且重建表，但是程序退出时会自动清空数据
update	若无表，则建表，若有表，则alter
validate	仅与实体类校验，不符合就报错
none	不配置，不进行ddl

三、安装JPA Buddy

需要到插件市场安装JPA Buddy，原版该插件为收费插件，目前已被Jetbrains收购，改为免费官方插件，Ultimate用户不需要额外付费。

四、JPA Buddy（JPA Designer）创建实体类和DAO

右键单选、多选目标数据表后，点击JPA Entities from DB可以快速创建实体类：

可在此处进行配置修改

其中，ID generation也就是主键生成策略需要注意下，None代表需要用户自己从代码去实现、SEQUENCE代表由数据库管理、IDENTITY代表ORM来管理，比如说UUID类的主键，建议通过ORM来管理。

创建完成后会打开：

此时会发现页面上方有一些多出来的按钮：

其实就是比如说添加实体属性、快速创建方法、创建DTO等功能。此处不再讲解。使用非常简单，有兴趣的读者可以自行试用。

本章主要讲解Spring JPA的启用和集成QueryDSL。

五、（附）已有JPA相关工程文件时访问JPA Designer

如果已经有Repository之类的JPA工程文件，进入到工程文件后右侧工具栏会展示JPA Designer的快捷方式，下面以新增JPA Entity实体类为例：

在快捷工具栏选择JPA Designer，点击+符号，选择JPA Entities from DB或其他选项，该选项是用来逆向工程数据库字段设计，创建JPA实体类。

注意，需要通过IDEA自带的数据库管理工具添加数据源，几乎市面上常见的数据源都支持：

添加成功后，点击刷新：

六、安装QueyDSL相关依赖和APT处理插件

<dependency>
  <groupId>com.querydsl</groupId>
  <artifactId>querydsl-jpa</artifactId>
  <version>${querydsl.version}</version>
</dependency>
<dependency>
   <groupId>com.querydsl</groupId>
    <artifactId>querydsl-sql</artifactId>
    <version>${querydsl.version}</version>
</dependency>

querydsl-sql不是必选项，用于解除querydsl-jpa不支持的一些复杂查询的限制。

<project>
  <build>
    <plugins>
      ...
      <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>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>com.querydsl</groupId>
            <artifactId>querydsl-apt</artifactId>
            <version>${querydsl.version}</version>
          </dependency>
        </dependencies>
      </plugin>
      <!--这里填写其他项目插件-->
    </plugins>
  </build>
</project>

以上querydsl.version一般springboot-dependencies会自带，如果没有请自己去填写。

七、生成APT类

运行下compile把JPA类利用APT生成一下（后续如果表变动过，需要重clean再生成）

生成后的效果：

此时，由于生成后的代码在target目录下我们不能引用，需要IDEA修改下目录属性，把target/generated-sources设置为：

八、创建全局JPAQuery工厂

注意entityManager需要通过PersistenceContext注解管理，这是因为请求并非在一个线程中处理。

@Configuration
public class JPAQueryDSLConfiguration {

        @PersistenceContext
        private final EntityManager entityManager;

        public JPAQueryDSLConfiguration(EntityManager entityManager) {
            this.entityManager = entityManager;
        }

        @Bean
        public JPAQueryFactory jpaQueryFactory() {
            return new JPAQueryFactory(entityManager);
        }
}

九、测试

    @Autowired
    JPAQueryFactory QueryFactory;

    @GetMapping("/test")
    public RestResult<CenterEntity> testJPA() {
        CenterEntity ce1 = new CenterEntity();
        ce1.setCenterHost("10.10.10.7");
        ce1.setCenterVersion(CenterType.NEXT_A);
        ce1.setCenterPassword("password");
        cr.save(ce1);
        QCenterEntity qc = QCenterEntity.centerEntity;
        List<CenterEntity>  ce = QueryFactory.selectFrom(qc)
                .where(qc.centerHost.eq("10.10.10.7")
                        .and(qc.centerPassword.startsWith("pass")
                        )
                )
                .fetch();
        return RestResult.success(ce.get(0));
    }