JaCoCo：排除生成的方法（与 Lombok 一起使用）

Question

我正在使用 JaCoCo，它正在考虑由 Lombok 生成的方法（在字节码中生成，而不是在源代码中跟踪它们）。我如何配置 JaCoCo 以忽略它们？

Answer 1

使用 jacoco 提供的排除标签。

            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.7.4.201502262128</version>
            <configuration>
                <excludes>
                    <exclude>**/config/**</exclude>
                    <exclude>**/model/**</exclude>
                    <exclude>**/item/**</exclude>
                </excludes>
            </configuration>

Answer 2

另一种排除 lombok 生成的方法类自 jacoco 0.8.0 和 lombok 1.16.14 以来。

幸运的是，从 0.8.0 版本开始，Jacoco 可以检测、识别和忽略 Lombok 生成的代码。作为开发人员，您唯一需要做的就是在目录的根目录中创建一个名为 lombok.config 的文件并设置以下标志：

lombok.addLombokGeneratedAnnotation = true

这会将注释lombok.@Generated 添加到相关方法、类和字段。 Jacoco 知道此注释并将忽略该注释代码。

请记住，您至少需要 Jacoco 版本 0.8.0 和 Lombok 版本 v1.16.14。

Answer 3

正如已经回答的那样，在项目的根目录中添加 lombok.config 可以解决问题，但是 如果您使用 Maven 并且希望避免添加 lombok.config到您的存储库，您可以使用 Apache Maven AntRun Plugin 以便在构建时自动生成它：

<plugins>
   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-antrun-plugin</artifactId>
      <version>3.0.0</version>
      <executions>
         <execution>
            <id>lombok-config</id>
            <phase>initialize</phase>
            <goals>
               <goal>run</goal>
            </goals>
            <configuration>
               <target>
                  <propertyfile file="lombok.config">
                     <entry key="config.stopBubbling" value="true" />
                     <entry key="lombok.addLombokGeneratedAnnotation" value="true" />
                  </propertyfile>
               </target>
            </configuration>
            <?m2e execute?> <!-- Optional: enable this execution in Eclipse -->
         </execution>
      </executions>
   </plugin>
</plugins>

不要忘记指示您的 SCM 忽略这个自动生成的文件。

JaCoCo：排除生成的方法（与 Lombok 一起使用）

JaCoCo: exclude generated methods (using it with Lombok)

lombok

jacoco

jacoco-maven-plugin