如何仅在Maven Site生命周期运行JaCoCo插件并禁用常规周期Agent？

这个问题我之前也碰到过——默认配置下JaCoCo的prepare-agent目标会绑定到测试阶段，导致mvn clean install这类常规构建命令也会启动Agent收集覆盖率数据，不仅拖慢构建速度，还可能生成不必要的执行文件。要实现只有执行mvn clean site时才启用JaCoCo，可以用下面两种方案来调整配置：

方案一：调整JaCoCo插件的生命周期绑定 #

核心思路是把JaCoCo的Agent准备和报告生成操作，从测试相关的阶段转移到Site生命周期的阶段，这样只有在生成站点时才会触发这些操作。同时给Surefire/Failsafe的参数配置兜底值，避免变量未定义时出错。

完整配置代码： #

<!-- Surefire和Failsafe插件保留原有并行配置，给ArgLine加默认空值 -->
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <configuration>
    <argLine>${surefireArgLine:}</argLine> <!-- 变量未定义时用空值，避免报错 -->
    <parallel>all</parallel>
    <threadCount>2</threadCount>
  </configuration>
</plugin>
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-failsafe-plugin</artifactId>
  <configuration>
    <argLine>${failsafeArgLine:}</argLine>
    <parallel>classes</parallel>
    <threadCount>2</threadCount>
  </configuration>
</plugin>

<!-- 修改JaCoCo插件的执行阶段，绑定到Site生命周期 -->
<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <executions>
    <!-- 单元测试Agent准备：移到pre-site阶段 -->
    <execution>
      <id>pre-unit-test</id>
      <phase>pre-site</phase>
      <goals>
        <goal>prepare-agent</goal>
      </goals>
      <configuration>
        <destFile>${project.build.directory}/jacoco-ut.exec</destFile>
        <propertyName>surefireArgLine</propertyName>
      </configuration>
    </execution>
    <!-- 单元测试报告：移到site阶段 -->
    <execution>
      <id>post-unit-test</id>
      <phase>site</phase>
      <goals>
        <goal>report</goal>
      </goals>
      <configuration>
        <dataFile>${project.build.directory}/jacoco-ut.exec</dataFile>
      </configuration>
    </execution>
    <!-- 集成测试Agent准备：移到pre-site阶段 -->
    <execution>
      <id>pre-integration-test</id>
      <phase>pre-site</phase>
      <goals>
        <goal>prepare-agent</goal>
      </goals>
      <configuration>
        <destFile>${project.build.directory}/jacoco-it.exec</destFile>
        <propertyName>failsafeArgLine</propertyName>
      </configuration>
    </execution>
    <!-- 集成测试报告：移到site阶段 -->
    <execution>
      <id>post-integration-test</id>
      <phase>site</phase>
      <goals>
        <goal>report</goal>
      </goals>
      <configuration>
        <dataFile>${project.build.directory}/jacoco-it.exec</dataFile>
      </configuration>
    </execution>
  </executions>
  <!-- 报告集配置保持不变 -->
  <reportSets>
    <reportSet>
      <id>JaCoCo-UnitTest</id>
      <reports>
        <report>report</report>
      </reports>
      <configuration>
        <dataFile>${project.build.directory}/jacoco-ut.exec</dataFile>
      </configuration>
    </reportSet>
    <reportSet>
      <id>JaCoCo-IntegrationTest</id>
      <reports>
        <report>report</report>
      </reports>
      <configuration>
        <dataFile>${project.build.directory}/jacoco-it.exec</dataFile>
      </configuration>
    </reportSet>
  </reportSets>
</plugin>

关键改动说明：

• 把JaCoCo的prepare-agent执行阶段从默认的test-compile改成pre-site，这样只有在执行site命令时才会准备Agent
• 把report执行阶段从test/post-integration-test改成site，确保报告和站点内容一起生成
• 给argLine配置添加:}后缀（${surefireArgLine:}），这是Maven的变量默认值语法，当变量未定义时就用空字符串，避免构建报错

方案二：用Maven Profile隔离JaCoCo配置 #

另一种思路是把所有JaCoCo相关的配置（包括Surefire/Failsafe的参数）放到一个专属Profile里，只有当执行site命令时才激活这个Profile，这样常规构建完全不会加载JaCoCo的配置。

配置代码示例： #

<profiles>
  <profile>
    <id>jacoco-for-site</id>
    <!-- 自动激活条件：当执行site目标时，maven.site.enabled会自动设为true -->
    <activation>
      <activeByDefault>false</activeByDefault>
      <property>
        <name>maven.site.enabled</name>
        <value>true</value>
      </property>
    </activation>
    <build>
      <plugins>
        <!-- Surefire和Failsafe插件：仅在Profile激活时使用JaCoCo的ArgLine -->
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-surefire-plugin</artifactId>
          <configuration>
            <argLine>${surefireArgLine}</argLine>
            <parallel>all</parallel>
            <threadCount>2</threadCount>
          </configuration>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-failsafe-plugin</artifactId>
          <configuration>
            <argLine>${failsafeArgLine}</argLine>
            <parallel>classes</parallel>
            <threadCount>2</threadCount>
          </configuration>
        </plugin>

        <!-- JaCoCo插件的完整配置，和你原来的一致 -->
        <plugin>
          <groupId>org.jacoco</groupId>
          <artifactId>jacoco-maven-plugin</artifactId>
          <executions>
            <execution>
              <id>pre-unit-test</id>
              <goals>
                <goal>prepare-agent</goal>
              </goals>
              <configuration>
                <destFile>${project.build.directory}/jacoco-ut.exec</destFile>
                <propertyName>surefireArgLine</propertyName>
              </configuration>
            </execution>
            <execution>
              <id>post-unit-test</id>
              <phase>test</phase>
              <goals>
                <goal>report</goal>
              </goals>
              <configuration>
                <dataFile>${project.build.directory}/jacoco-ut.exec</dataFile>
              </configuration>
            </execution>
            <execution>
              <id>pre-integration-test</id>
              <phase>pre-integration-test</phase>
              <goals>
                <goal>prepare-agent</goal>
              </goals>
              <configuration>
                <destFile>${project.build.directory}/jacoco-it.exec</destFile>
                <propertyName>failsafeArgLine</propertyName>
              </configuration>
            </execution>
            <execution>
              <id>post-integration-test</id>
              <phase>post-integration-test</phase>
              <goals>
                <goal>report</goal>
              </goals>
              <configuration>
                <dataFile>${project.build.directory}/jacoco-it.exec</dataFile>
              </configuration>
            </execution>
          </executions>
          <reportSets>
            <reportSet>
              <id>JaCoCo-UnitTest</id>
              <reports>
                <report>report</report>
              </reports>
              <configuration>
                <dataFile>${project.build.directory}/jacoco-ut.exec</dataFile>
              </configuration>
            </reportSet>
            <reportSet>
              <id>JaCoCo-IntegrationTest</id>
              <reports>
                <report>report</report>
              </reports>
              <configuration>
                <dataFile>${project.build.directory}/jacoco-it.exec</dataFile>
              </configuration>
            </reportSet>
          </reportSets>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>

使用方式：

• 常规构建命令（比如mvn clean install）：这个Profile不会激活，JaCoCo完全不参与，不会生成任何覆盖率文件
• 生成站点报告：直接执行mvn clean site即可，Maven会自动设置maven.site.enabled=true，激活Profile，JaCoCo正常生成覆盖率报告；也可以手动指定Profile：mvn clean site -Pjacoco-for-site

验证效果 #

改完配置后可以测试一下：

1. 执行mvn clean install：检查target目录，不会出现jacoco-ut.exec和jacoco-it.exec文件，说明Agent没启动
2. 执行mvn clean site：target目录会生成上述exec文件，同时site目录下会出现JaCoCo的覆盖率报告页面

内容的提问来源于stack exchange，提问作者Jonathan S. Fisher