如何在Maven中不修改编译器配置，于verify阶段使用Error-prone？

嘿，这个需求太合理了——不想动现有的maven-compiler-plugin配置，就想在verify阶段像FindBugs/Checkstyle那样加个Error-prone的静态检查对吧？我之前也这么干过，用exec-maven-plugin就能实现完全独立的Error-prone检查流程，完全不干扰常规编译。

第一步：引入Error-prone依赖 #

先把Error-prone的核心库和注解包加到项目里，用provided scope就行，不会影响你的生产依赖：

<dependencies>
  <!-- Error-prone核心检查库 -->
  <dependency>
    <groupId>com.google.errorprone</groupId>
    <artifactId>error_prone_core</artifactId>
    <version>2.24.0</version>
    <scope>provided</scope>
  </dependency>
  <!-- 可选但推荐：Error-prone注解库，部分检查需要它 -->
  <dependency>
    <groupId>com.google.errorprone</groupId>
    <artifactId>error_prone_annotations</artifactId>
    <version>2.24.0</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

第二步：配置exec-maven-plugin绑定到Verify阶段 #

接下来配置exec-maven-plugin，让它在verify阶段单独执行带Error-prone参数的javac命令。这里的关键是复用Maven的变量来获取类路径和源码路径，不用硬编码：

<build>
  <!-- 保留你原有的maven-compiler-plugin配置，完全不动它 -->
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.11.0</version>
    <configuration>
      <!-- 你的常规配置，比如JDK版本、编码等 -->
      <source>17</source>
      <target>17</target>
      <encoding>UTF-8</encoding>
    </configuration>
  </plugin>

  <!-- 新增的Error-prone检查任务 -->
  <plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <version>3.1.0</version>
    <executions>
      <execution>
        <id>run-error-prone</id>
        <phase>verify</phase> <!-- 绑定到verify阶段 -->
        <goals>
          <goal>exec</goal>
        </goals>
        <configuration>
          <executable>javac</executable> <!-- 执行javac命令 -->
          <arguments>
            <!-- 启用Error-prone插件 -->
            <argument>-Xplugin:ErrorProne</argument>
            <!-- 指定临时输出目录，避免覆盖常规编译的class文件 -->
            <argument>-d</argument>
            <argument>${project.build.directory}/error-prone-tmp</argument>
            <!-- 复用Maven的编译类路径，不用手动写依赖 -->
            <argument>-cp</argument>
            <argument>${project.compileClasspathElements}</argument>
            <!-- 扫描主源码目录下所有Java文件 -->
            <argument>${project.build.sourceDirectory}/**/*.java</argument>
            <!-- 可选：定制检查规则，比如把UnusedVariable设为错误级别 -->
            <!-- <argument>-Xep:UnusedVariable:ERROR</argument> -->
            <!-- 可选：排除某些文件，比如测试代码 -->
            <!-- <argument>-XepExcludedPaths:.*src/test/java.*</argument> -->
            <!-- 可选：关闭某个规则 -->
            <!-- <argument>-Xep:MissingOverride:OFF</argument> -->
          </arguments>
          <!-- 只要javac返回非0（比如有ERROR级别的问题），就让构建失败 -->
          <successCodes>0</successCodes>
        </configuration>
      </execution>
    </executions>
    <!-- 确保插件能拿到Error-prone的依赖 -->
    <dependencies>
      <dependency>
        <groupId>com.google.errorprone</groupId>
        <artifactId>error_prone_core</artifactId>
        <version>2.24.0</version>
      </dependency>
    </dependencies>
  </plugin>
</build>

几个关键细节要注意 #

• 完全独立的流程：这个配置不会碰你原来的编译流程，常规编译还是用你熟悉的maven-compiler-plugin，Error-prone只是在verify阶段做一次额外的静态扫描。
• 临时目录：我们用了error-prone-tmp作为临时输出目录，不会和常规编译的classes目录冲突，构建完可以直接删掉，也可以在.gitignore里忽略它。
• 规则灵活定制：通过-Xep:RuleName:Level参数可以精准控制每个检查的级别，ERROR会让构建失败，WARN只是输出警告，OFF直接禁用规则。如果要排除特定文件，用-XepExcludedPaths加正则表达式就行。

测试一下 #

配置好之后，跑mvn verify试试：Maven会先完成常规的编译、测试，然后自动进入verify阶段执行Error-prone检查。如果代码里有不符合规则的问题，控制台会清晰输出错误/警告，要是你设了ERROR级别，构建会直接终止，和FindBugs/Checkstyle的行为完全一致。

内容的提问来源于stack exchange，提问作者Martin Monperrus