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

Question

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

Answer 1

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

幸运的是，从 0.8.0 版本开始，Jacoco 可以检测、识别和忽略 Lombok 生成的代码。作为开发人员，您唯一要做的就是在目录的根目录中创建一个名为

lombok.config

的文件并设置以下标志：

lombok.addLombokGeneratedAnnotation = true

这会将注释

lombok.@Generated

添加到相关方法、类和字段。 Jacoco 知道这个注释并将忽略该注释代码。

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

Answer 2

使用 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 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.1.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 忽略此自动生成的文件。

Answer 4

为了解决这个问题，我们需要一种方法来告诉 JaCoCo 忽略 lombok 生成的代码。这可以通过指示 lombok 用 @lombok. generated 注释所有生成的方法来实现，JaCoCo 将自动忽略它。

使用以下内容创建 lombok.config 文件：

# This tells lombok this directory is the root,
# no need to look somewhere else for java code.
config.stopBubbling = true
# This will add the @lombok.Generated annotation
# to all the code generated by Lombok,
# so it can be excluded from coverage by jacoco.
lombok.addLombokGeneratedAnnotation = true

并将其放在存储库的根目录下，或放在 src/ 文件夹中。唯一的要求是所有带有 lombok 注释的代码都可以在该文件下方或旁边找到。