理解JaCoCo与Maven集成 | AI生成和翻译

Home 2025.09 English 中文

---

明白了——以下是您当前POM文件中JaCoCo各组件协同工作的步骤及原理说明。

---

该POM文件创建的两类覆盖率数据流

1. 单元测试覆盖率（Surefire路径）

• 您未配置特殊参数就绑定了JaCoCo的prepare-agent：

  <execution>
    <id>prepare-agent</id>
    <goals><goal>prepare-agent</goal></goals>
  </execution>
  

  这会通过argLine参数将-javaagent:...org.jacoco.agent-<ver>-runtime.jar注入Surefire测试JVM。 • 默认destfile为${project.build.directory}/jacoco.exec。 • 默认append为true（当文件已存在时，JaCoCo代理会追加数据）。 • 效果：在test阶段运行单元测试（如有）时，覆盖率数据会写入target/jacoco.exec。

1. 集成测试覆盖率（Jetty路径）

• 您为集成测试覆盖率定义了独立文件：

  <properties>
    <jacoco.it.exec>${project.build.directory}/jacoco-it.exec</jacoco.it.exec>
  </properties>
  

• 您启动Jetty时使用独立的JaCoCo代理指向该文件：

  <plugin>
    <artifactId>jetty-maven-plugin</artifactId>
    ...
    <execution>
      <id>start-jetty</id>
      <phase>pre-integration-test</phase>
      <goals><goal>start</goal></goals>
      <configuration>
        <daemon>true</daemon>
        <jvmArgs>
          -javaagent:${settings.localRepository}/org/jacoco/org.jacoco.agent/${jacoco.version}/org.jacoco.agent-${jacoco.version}-runtime.jar=destfile=${jacoco.it.exec}
        </jvmArgs>
        ...
      </configuration>
    </execution>
  </plugin>
  

  • Jetty在独立JVM中运行；其代理将数据写入target/jacoco-it.exec。 • 由于未指定append参数，JaCoCo默认append=true生效——因此除非执行清理或设置append=false，多次启动Jetty会向同一文件追加数据。

---

生命周期流程（执行mvn verify时的过程）

1. compile

   • Spotless格式化（spotless-maven-plugin）和Checkstyle检查（maven-checkstyle-plugin）。
   • 准备WAR包（maven-war-plugin）。

2. test (Surefire)

   • 如有单元测试，它们会在prepare-agent注入的argLine参数下运行 → 覆盖率数据写入target/jacoco.exec。

3. pre-integration-test

   • Jetty以守护模式启动：

     <daemon>true</daemon>
     

     Maven立即恢复控制权；Jetty持续运行并附带JaCoCo代理，将数据写入jacoco-it.exec。

4. integration-test

   • 您的Python测试访问运行中的应用程序：

     <plugin>
       <artifactId>exec-maven-plugin</artifactId>
       <execution>
         <id>python-integration-tests</id>
         <phase>integration-test</phase>
         <goals><goal>exec</goal></goals>
         <configuration>
           <executable>python3</executable>
           <workingDirectory>${project.parent.basedir}</workingDirectory>
           <arguments>
             <argument>-m</argument><argument>unittest</argument>
             <argument>discover</argument><argument>tests/</argument>
             <argument>-v</argument>
           </arguments>
         </configuration>
       </execution>
     </plugin>
     

     这些测试会调用Jetty，因此覆盖率通过Jetty JVM的代理累积到target/jacoco-it.exec。

5. post-integration-test

   • 干净地停止Jetty：

     <execution>
       <id>stop-jetty</id>
       <phase>post-integration-test</phase>
       <goals><goal>stop</goal></goals>
       ...
     </execution>
     

6. verify

   • 您使用IT数据文件和自定义输出目录生成独立的IT报告：

     <execution>
       <id>report-it</id>
       <phase>verify</phase>
       <goals><goal>report</goal></goals>
       <configuration>
         <dataFile>${jacoco.it.exec}</dataFile>
         <outputDirectory>${project.reporting.outputDirectory}/jacoco-it
         </outputDirectory>
       </configuration>
     </execution>
     

   • 结果：HTML报告生成于target/site/jacoco-it/index.html，仅汇总集成测试覆盖率（来自Jetty）。

注意：如需单元测试报告，可添加另一个指向默认target/jacoco.exec并输出至target/site/jacoco的jacoco:report执行配置——保持单元测试与集成测试报告分离。

---

关于.exec文件的“新建或替换？”问题

• JaCoCo代理默认append=true。

  • 对于单元测试，文件是target/jacoco.exec。当重复执行mvn verify且不执行clean时，数据可能在不同运行间追加。
  • 对于Jetty集成测试，您的jvmArgs未覆盖append设置，因此target/jacoco-it.exec也默认追加数据。

最佳实践（避免混合旧数据）：

• 运行mvn clean verify，或在Jetty代理配置中添加append=false：

  -javaagent:...org.jacoco.agent-...-runtime.jar=destfile=${jacoco.it.exec},append=false
  

• 如需有意合并多个.exec文件，可在jacoco:report前使用jacoco:merge。

---

原始XML中各相关模块的功能说明（按引用关系）

• 集成测试文件位置

  <properties>
    <jacoco.it.exec>${project.build.directory}/jacoco-it.exec</jacoco.it.exec>
    <it.report.skip>false</it.report.skip>
  </properties>
  

  定义集成测试覆盖率数据的存储位置。it.report.skip已声明但尚未接入报告执行配置（参见下文提示）。

• 单元测试代理（Surefire路径）

  <plugin>
    <artifactId>jacoco-maven-plugin</artifactId>
    <executions>
      <execution>
        <id>prepare-agent</id>
        <goals><goal>prepare-agent</goal></goals>
      </execution>
      ...
    </executions>
  </plugin>
  

• 带JaCoCo的Jetty集成测试

  <plugin>
    <artifactId>jetty-maven-plugin</artifactId>
    ...
    <jvmArgs>
      -javaagent:${settings.localRepository}/org/jacoco/org.jacoco.agent/${jacoco.version}/org.jacoco.agent-${jacoco.version}-runtime.jar=destfile=${jacoco.it.exec}
    </jvmArgs>
    ...
  </plugin>
  

• Jetty运行时执行Python集成测试

  <plugin>
    <artifactId>exec-maven-plugin</artifactId>
    <execution>
      <id>python-integration-tests</id>
      <phase>integration-test</phase>
      <goals><goal>exec</goal></goals>
      ...
    </execution>
  </plugin>
  

• 在verify阶段生成集成测试覆盖率报告

  <execution>
    <id>report-it</id>
    <phase>verify</phase>
    <goals><goal>report</goal></goals>
    <configuration>
      <dataFile>${jacoco.it.exec}</dataFile>
      <outputDirectory>${project.reporting.outputDirectory}/jacoco-it</outputDirectory>
    </configuration>
  </execution>
  

---

实用技巧 / 小幅改进

• 避免陈旧的集成测试数据 在Jetty代理配置中添加append=false（如上所示），或始终运行mvn clean verify。

• 接入it.report.skip开关 如需通过属性控制是否跳过IT报告生成：

  <execution>
    <id>report-it</id>
    <phase>verify</phase>
    <goals><goal>report</goal></goals>
    <configuration>
      <skip>${it.report.skip}</skip>
      <dataFile>${jacoco.it.exec}</dataFile>
      <outputDirectory>${project.reporting.outputDirectory}/jacoco-it</outputDirectory>
    </configuration>
  </execution>
  

• 保持单元测试与集成测试报告分离 您已成功将IT报告分离至site/jacoco-it。如需单元测试报告，可添加另一个不覆盖dataFile的jacoco:report配置，输出至site/jacoco。

• 多模块注意事项 当前模块级配置仅报告PlaygroundWeb的覆盖率。如需合并视图，可在父POM（packaging=pom）中使用jacoco:merge（合并.exec文件）和/或report-aggregate（JaCoCo 0.8.8+）。

---

总结

• 单元测试 → prepare-agent将JaCoCo注入Surefire JVM → target/jacoco.exec。
• 集成测试 → Jetty启动时附带独立JaCoCo代理 → target/jacoco-it.exec。
• 报告生成 → 在verify阶段，jacoco:report仅将集成测试覆盖率渲染至target/site/jacoco-it。
• 文件行为 → JaCoCo默认追加数据；建议使用mvn clean verify或设置append=false避免不同运行批次的数据混合。

---

Back

openai/gpt-5

Donate