如何让 QueryDSL 和 Lombok 协同工作

Posted 2023-02-26

【中文标题】如何让 QueryDSL 和 Lombok 协同工作

【英文标题】：How to make QueryDSL and Lombok work together

【发布时间】：2017-11-15 06:58:47

【问题描述】：

当一个方法或变量使用 Lombok 注解进行注解时，maven 插件将通过处理 JPA 的源代码生成来抱怨。

我在控制台日志中遇到这种故障：

symbol:   class __
location: class ServiceBaseMessage
C:\workspaces\[...]\service\ServiceBaseMessage.java:44: error: cannot find symbol
@Getter(onMethod = @__( @JsonProperty("TYPE") ))

如何使 JPA 注释的 apt-maven-plugin 和 queryDSL 处理器与 lombok 注释一起工作？

【参考方案1】：

这个解决方案对我有用。 在您的 apt-maven-plugin 配置中添加 lombok.launch.AnnotationProcessorHider$AnnotationProcessor。

<plugin>
    <groupId>com.mysema.maven</groupId>
    <artifactId>apt-maven-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>process</goal>
            </goals>
            <configuration>
                <outputDirectory>target/generated-sources/java</outputDirectory>
                <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor,lombok.launch.AnnotationProcessorHider$AnnotationProcessor</processor>
            </configuration>
        </execution>
    </executions>
</plugin>

它似乎也与 gradle 以相同的方式工作： 见https://github.com/ewerk/gradle-plugins/issues/59#issuecomment-247047011

【讨论】：

我想使用QueryDSL Sql 项目querydsl.com/static/querydsl/latest/reference/html/ch02s03.html 有没有办法在里面也添加annotationProcessor？

【参考方案2】：

这是 GRADLE 用户的语法（maven 用户请查看其他答案）

// 这会将 lombok 正确添加到您的项目中，然后您配置 jpa 处理器

plugins 
 ...
  id 'io.franzbecker.gradle-lombok' version '1.7'

project.afterEvaluate 

  project.tasks.compileQuerydsl.options.compilerArgs = [
          "-proc:only",
          "-processor", project.querydsl.processors() +
                  ',lombok.launch.AnnotationProcessorHider$AnnotationProcessor'
  ]

这里是 QueryDSL 和 Lombok 的工作版本。依赖是由插件导入的，因此不需要声明依赖：

buildscript 
    repositories 
        mavenCentral()
    


plugins 
    id 'io.franzbecker.gradle-lombok' version '1.7'
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.9"


querydsl 
    jpa = true


// plugin needed so that the
project.afterEvaluate 
    project.tasks.compileQuerydsl.options.compilerArgs = [
            "-proc:only",
            "-processor", project.querydsl.processors() +
                    ',lombok.launch.AnnotationProcessorHider$AnnotationProcessor'
    ]

dependencies 
    compile group: 'com.querydsl', name: 'querydsl-jpa', version: '4.1.3'

【参考方案3】：

下面的 pom sn-p 通过 maven-compiler-plugin 与 Querydsl、Lombok、Mapstruct 一起为我工作

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                    <annotationProcessors>
                        <annotationProcessor>lombok.launch.AnnotationProcessorHider$AnnotationProcessor</annotationProcessor>
                        <annotationProcessor>com.querydsl.apt.jpa.JPAAnnotationProcessor</annotationProcessor>
                        <annotationProcessor>org.mapstruct.ap.MappingProcessor</annotationProcessor>
                    </annotationProcessors>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>com.querydsl</groupId>
                            <artifactId>querydsl-apt</artifactId>
                            <version>$querydsl.version</version>
                        </path>
                        <path>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                            <version>$lombok.version</version>
                        </path>
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>$org.mapstruct.version</version>
                        </path>
                        <path>
                            <groupId>javax.annotation</groupId>
                            <artifactId>javax.annotation-api</artifactId>
                            <version>1.3.1</version>
                        </path>
                        <path>
                            <groupId>org.eclipse.persistence</groupId>
                            <artifactId>javax.persistence</artifactId>
                            <version>2.0.0</version>
                        </path>

                    </annotationProcessorPaths>
                </configuration>
            </plugin>

【讨论】：

谢谢，Mapstruct 将成为我接下来要弄清楚的事情。仅供参考，您仍然希望像平常一样声明您的 querydsl 依赖项，否则在运行 Maven 时会看到无用的 NullPointerError。

【参考方案4】：

对于 gradle，遵循完全相同的顺序

sourceSets 
  generated 
    java 
      srcDirs = ['build/generated/sources/annotationProcessor/java/main']
    
  



dependencies 
    api 'com.querydsl:querydsl-jpa:4.4.0'
    annotationProcessor 'org.projectlombok:lombok'
    annotationProcessor('com.querydsl:querydsl-apt:4.4.0:jpa')
    annotationProcessor('javax.annotation:javax.annotation-api')