Maven Checkstyle插件未读取自定义配置，检查结果不符预期

一、Maven插件列表不出现的原因及修复 #

你之前在公共基础模块配置maven-checkstyle-plugin但服务模块看不到插件，大概率是这两个核心原因：

• 插件配置位置错误：如果只在<reporting>节点下配置插件，这部分仅用于生成Maven站点报告，不会被子模块继承到构建生命周期，自然不会在Maven插件列表显示。需要把插件配置移到<build><plugins>节点下，同时确保服务模块正确继承公共基础模块。
• 依赖传递未生效：如果服务模块没有直接或间接继承公共基础模块的插件配置，也看不到插件。可以在服务模块的<build><pluginManagement>中引入公共模块的插件配置，或者直接在服务模块的<plugins>节点下配置插件。

二、自定义配置不生效的核心问题 #

注释my_checkstyle.xml所有规则仍触发相同检查，说明插件根本没加载你的自定义配置，而是使用了默认的Sun规则，问题出在这几点：

1. Checkstyle模块资源打包错误：你说在Checkstyle模块加了资源配置，需确保my_checkstyle.xml被正确打包到JAR的resources目录。检查资源配置是否正确：

   <build>
     <resources>
       <resource>
         <directory>${project.basedir}</directory>
         <includes>
           <include>my_checkstyle.xml</include>
         </includes>
       </resource>
     </resources>
   </build>
   

   打包后打开Checkstyle模块的JAR文件，确认根目录或resources目录下存在该配置文件。
2. 插件未指定自定义配置路径：在maven-checkstyle-plugin配置中，必须明确指定配置文件位置，否则会默认使用Sun规则。示例配置如下：

   <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-checkstyle-plugin</artifactId>
     <version>3.3.0</version>
     <configuration>
       <!-- 配置文件在依赖的JAR中，需加classpath:前缀 -->
       <configLocation>classpath:my_checkstyle.xml</configLocation>
       <encoding>UTF-8</encoding>
     </configuration>
     <executions>
       <execution>
         <id>checkstyle-check</id>
         <phase>verify</phase> <!-- 绑定到verify阶段，构建时自动执行 -->
         <goals>
           <goal>check</goal>
         </goals>
       </execution>
     </executions>
   </plugin>
   

3. Maven缓存干扰：旧配置可能被Maven缓存，执行mvn clean install -U强制更新快照依赖，同时删除本地仓库中Checkstyle模块的旧JAR包，重新打包安装。

三、命令执行的区别 #

• checkstyle:checkstyle是旧版插件的废弃目标，仅用于生成报告文件但不执行检查逻辑，所以会显示成功但无实际操作。
• checkstyle:check是当前有效目标，会执行检查并在不符合规则时终止构建；checkstyle:verify会执行检查并生成详细报告，推荐使用这两个命令。

正确操作步骤总结 #

1. 修复Checkstyle模块的资源配置，确保my_checkstyle.xml被打包进JAR的resources目录。
2. 在公共基础模块的<build><plugins>节点下配置maven-checkstyle-plugin，绑定到verify生命周期，指定configLocation为classpath:my_checkstyle.xml。
3. 确保服务模块的pom.xml通过<parent>节点继承公共基础模块，或通过<pluginManagement>引入插件配置。
4. 执行mvn clean install -U清理缓存并重新构建，之后在服务模块执行mvn checkstyle:check或mvn verify触发检查。

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