QueryDSL 5.1.0 生成代码时使用Jakarta注解的解决方案

在使用QueryDSL 5.1.0版本时，开发者可能会遇到一个关于代码生成注解的问题。当项目从Javax迁移到Jakarta EE后，QueryDSL生成的Q类仍然使用了javax.annotation.Generated或javax.annotation.processing.Generated注解，而不是预期的jakarta.annotation.Generated注解。

问题背景

QueryDSL是一个流行的Java查询框架，它通过APT(Annotation Processing Tool)在编译时生成查询相关的元模型类(Q类)。在Java EE向Jakarta EE迁移的过程中，许多注解的包名从javax变更为jakarta，这包括常用的@Generated注解。

问题分析

默认情况下，QueryDSL的代码生成器会优先使用javax.annotation.processing.Generated，其次是javax.annotation.Generated。即使在项目中使用了带有jakarta分类器的QueryDSL依赖(querydsl-jpa和querydsl-apt)，这个默认行为也不会自动改变。

解决方案

要强制QueryDSL使用jakarta.annotation.Generated注解生成代码，可以通过以下配置实现：

1. 在Maven项目的pom.xml中，配置maven-compiler-plugin插件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <compilerArgs>
            <arg>-Aquerydsl.generatedAnnotationClass=jakarta.annotation.Generated</arg>
        </compilerArgs>
    </configuration>
</plugin>

2. 对于Gradle项目，可以在build.gradle中配置：

tasks.withType(JavaCompile) {
    options.compilerArgs << "-Aquerydsl.generatedAnnotationClass=jakarta.annotation.Generated"
}

技术原理

这个解决方案利用了Java注解处理器(Annotation Processor)的选项传递机制。QueryDSL的APT处理器会读取名为"querydsl.generatedAnnotationClass"的处理器选项，开发者可以通过编译器参数来设置这个选项值。

在QueryDSL内部，GeneratedAnnotationResolver类负责解析应该使用的Generated注解类。虽然当前版本中javax注解的优先级高于jakarta，但通过显式配置可以绕过这个默认行为。

最佳实践建议

1. 对于新项目，建议从一开始就配置使用jakarta.annotation.Generated
2. 迁移项目时，除了配置QueryDSL外，还应确保项目中移除了所有javax.annotation的依赖
3. 考虑在团队内部文档中记录这个配置，方便新成员快速上手
4. 如果使用IDE进行开发，确保IDE的编译配置也包含了相同的参数

未来展望

随着Jakarta EE的普及，未来版本的QueryDSL很可能会调整默认行为，优先使用jakarta.annotation.Generated。但在当前版本中，显式配置仍然是最可靠的解决方案。