构建与依赖 / 系统课时

将质量检查接入 verify

将质量检查接入 verify

质量检查如果依赖开发者“记得执行”,很容易在本地和 CI 之间出现漏检。更可靠的做法是让 mvn verify 成为统一验收入口:单元测试在 test 阶段执行,覆盖率采集提前挂载,覆盖率阈值和代码规则在 verify 阶段作为硬门禁。

学习目标

  • 理解 mvn verify 为什么会连带执行前面的测试与打包阶段。
  • 把 Surefire、JaCoCo 和 Checkstyle 组成一条可复用的质量检查链。
  • 用明确阈值和失败条件避免“命令成功,但实际上没有执行有效验收”。

让 verify 成为唯一验收入口

Maven 执行某个生命周期阶段时,会先执行该阶段之前的所有阶段。因此调用 mvn verify 不需要把单元测试强行改绑到 verify:Surefire 仍在 test 阶段运行,随后 package 产出制品,最后才进入 verify 运行覆盖率和规则门禁。这样失败位置更早,也更符合生命周期语义。

verify 生命周期中的质量门禁

配置测试、覆盖率与规则门禁

下面是片段示例,放入现有 Java 项目的 <build><plugins> 中。示例要求:没有测试时 Surefire 直接失败;JaCoCo 的行覆盖率至少 80%;Checkstyle 在 verify 阶段使用 google_checks.xml 检查源码。若项目已有自定义 Checkstyle 规则文件,应把 configLocation 换成仓库内固定路径。

xml
<plugins>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.5.4</version>
    <configuration>
      <failIfNoTests>true</failIfNoTests>
    </configuration>
  </plugin>

  <plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.13</version>
    <executions>
      <execution>
        <id>prepare-agent</id>
        <goals>
          <goal>prepare-agent</goal>
        </goals>
      </execution>
      <execution>
        <id>coverage-gate</id>
        <phase>verify</phase>
        <goals>
          <goal>report</goal>
          <goal>check</goal>
        </goals>
        <configuration>
          <rules>
            <rule>
              <element>BUNDLE</element>
              <limits>
                <limit>
                  <counter>LINE</counter>
                  <value>COVEREDRATIO</value>
                  <minimum>0.80</minimum>
                </limit>
              </limits>
            </rule>
          </rules>
        </configuration>
      </execution>
    </executions>
  </plugin>

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.6.0</version>
    <executions>
      <execution>
        <id>style-gate</id>
        <phase>verify</phase>
        <goals>
          <goal>check</goal>
        </goals>
        <configuration>
          <configLocation>google_checks.xml</configLocation>
          <includeTestSourceDirectory>true</includeTestSourceDirectory>
          <failOnViolation>true</failOnViolation>
        </configuration>
      </execution>
    </executions>
  </plugin>
</plugins>

这套配置的可检查结果很明确:单元测试失败会在 test 阶段终止;覆盖率低于 0.80 会在 verify 失败;Checkstyle 有违规同样返回失败。JaCoCo HTML 报告生成后可在 target/site/jacoco/index.html 查看具体未覆盖行。

用一条命令统一本地与 CI

本地提交前和 CI 都运行同一条命令,避免流水线额外拼接一组开发者平时从不执行的命令。CI 建议增加 -B 使用批处理模式,减少交互式输出差异。

bash
mvn -B verify

预期输出:测试全部通过、行覆盖率达到 80% 且 Checkstyle 无违规时,命令最终以成功状态结束。插件日志和耗时会随项目规模不同而变化。

text
[INFO] BUILD SUCCESS

如果任一门禁失败,mvn verify 会返回非零退出码,CI 应直接把该步骤判为失败,不要在后面追加 || true、忽略退出码或把质量检查标成允许失败,否则门禁只剩日志提示而没有约束力。

防止 verify 变成假检查

最常见的错误是为了“加快 CI”给质量任务传 -DskipTests 或 -Dmaven.test.skip=true。前者跳过测试执行,后者连测试编译也跳过,都不应该用于正式质量门禁;覆盖率报告也可能因此没有有效执行数据。需要加速时,应通过测试分层、并行或缓存优化,而不是绕过测试。

另一个常见问题是把覆盖率阈值只写在文档里,却没有配置 jacoco:check。report 只负责生成报告,不会因为 42% 覆盖率自动让构建失败;真正形成门禁的是 check 中的 <minimum>0.80</minimum>。同理,Checkstyle 要使用 check 目标并保持 failOnViolation=true,只生成报告不能替代验收。

当项目是多模块工程时,不要机械地给所有模块设置 failIfNoTests=true:纯 BOM、聚合 POM 或只放资源的模块本来就可能没有测试。更合理的做法是只在需要产出可执行代码的模块启用该限制,而让父 POM 统一管理插件版本和质量阈值。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

将质量检查接入 verify

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通