Querydsl 与 Freemarker 共存：解决 Q 类生成问题

Querydsl 与 Freemarker 共存：解决 Q 类生成问题

本文旨在解决在同时使用 Querydsl 和 Freemarker 时，可能出现的 Querydsl 无法正确生成 Q 类的问题。通过分析依赖冲突和版本兼容性，提供清晰的解决方案，确保项目顺利构建和运行。核心在于正确配置 Querydsl 的依赖，特别是当项目迁移到 Jakarta Persistence API 时，需要使用 Querydsl 5.0.0 或更高版本，并指定正确的 classifier。

在使用 Querydsl 和 Freemarker 构建项目时，可能会遇到 Querydsl 无法正常生成 Q 类的状况，这通常与依赖冲突或版本不兼容有关。虽然表面上看起来是 Freemarker 的引入导致了问题，但实际根源往往在于 Querydsl 的配置。特别是在迁移到 Jakarta Persistence API 后，旧的配置方式会导致 Q 类生成失败。

问题分析

当项目中使用 jakarta.persistence-api 时，意味着项目已经迁移到 Jakarta EE 平台。此时，需要特别注意 Querydsl 的版本和 classifier 的选择。如果仍然使用旧的 JPA classifier，并且 Querydsl 版本过低，则无法正确处理 Jakarta Persistence API 的相关注解，导致 Q 类生成失败。

解决方案

解决此问题的关键在于升级 Querydsl 版本，并使用正确的 classifier。

1. 升级 Querydsl 版本: 确保 Querydsl 版本至少为 5.0.0 或更高。

   ext {
       queryDslVersion = "5.0.0" // 或者更高版本
   }

2. 使用 Jakarta Classifier: 将 querydsl-apt 和 querydsl-jpa 的 classifier 从 jpa 更改为 jakarta。

   dependencies {
       implementation("com.querydsl:querydsl-core:${queryDslVersion}")
       implementation("com.querydsl:querydsl-jpa:${queryDslVersion}:jakarta")
       annotationProcessor("com.querydsl:querydsl-apt:${queryDslVersion}:jakarta")
       testImplementation("com.querydsl:querydsl-jpa:${queryDslVersion}:jakarta")
       testAnnotationProcessor("com.querydsl:querydsl-apt:${queryDslVersion}:jakarta")
       annotationProcessor("jakarta.persistence:jakarta.persistence-api")
       annotationProcessor("jakarta.annotation:jakarta.annotation-api")
   }

示例代码

下面是一个完整的 build.gradle 文件示例，展示了如何正确配置 Querydsl 和 Freemarker 依赖：

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.0'
    id 'io.spring.dependency-management' version '1.1.0'
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10" // 如果使用 querydsl plugin
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'

java {
    sourceCompatibility = '17'
}

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

ext {
    queryDslVersion = "5.0.0"
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    // QueryDSL
    implementation("com.querydsl:querydsl-core:${queryDslVersion}")
    implementation("com.querydsl:querydsl-jpa:${queryDslVersion}:jakarta")
    annotationProcessor("com.querydsl:querydsl-apt:${queryDslVersion}:jakarta")
    testImplementation("com.querydsl:querydsl-jpa:${queryDslVersion}:jakarta")
    testAnnotationProcessor("com.querydsl:querydsl-apt:${queryDslVersion}:jakarta")
    annotationProcessor("jakarta.persistence:jakarta.persistence-api")
    annotationProcessor("jakarta.annotation:jakarta.annotation-api")

    // Freemarker
    implementation group: 'org.freemarker', name: 'freemarker', version: '2.3.28'
}

// QueryDSL configuration (if using querydsl plugin)
querydsl {
    jpa = true
    querydslSourcesDir = 'src/main/generated'
}

sourceSets {
    main.java.srcDir 'src/main/generated'
}

tasks.withType(JavaCompile) {
    options.annotationProcessorPath = configurations.annotationProcessor
}

注意事项

• 在修改 build.gradle 文件后，务必刷新 Gradle 项目，以确保依赖关系正确更新。
• 如果项目使用了 Querydsl Gradle 插件，请确保插件版本与 Querydsl 版本兼容。
• 如果仍然遇到问题，可以尝试清理项目并重新构建。

总结

当同时使用 Querydsl 和 Freemarker 时，遇到 Q 类生成问题，通常是由于 Querydsl 的版本和 classifier 配置不正确导致的。通过升级 Querydsl 版本到 5.0.0 或更高版本，并使用 jakarta classifier，可以有效解决此问题。 确保依赖配置正确，可以避免不必要的构建错误，提高开发效率。