checkstyle-checker.xml被默认文件覆盖，如何自定义Checkstyle配置？

我之前也碰到过一模一样的情况——明明在pom里配置了自定义的checkstyle规则，结果跑mvn checkstyle:check时还是被默认的sun-checks.xml覆盖，折腾了好一会儿才搞定。下面是我总结的解决方法：

核心问题原因 #

Checkstyle Maven插件默认会加载内置的sun-checks.xml配置，除非你明确指定自定义配置并禁用默认配置的加载。

正确的Pom配置示例 #

你需要在pom.xml的build/plugins块里，给Checkstyle插件加上明确的配置，指定你的自定义文件并跳过默认配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <!-- 建议使用最新稳定版，避免旧版本的兼容问题 -->
            <version>3.3.0</version>
            <configuration>
                <!-- 指定你的自定义配置文件路径，这里是根目录的my-checks.xml -->
                <configLocation>my-checks.xml</configLocation>
                <!-- 关键：禁用默认的sun-checks.xml加载 -->
                <skipDefaultConfig>true</skipDefaultConfig>
                <!-- 可选：设置编码，避免中文规则或注释出现乱码 -->
                <encoding>UTF-8</encoding>
                <!-- 可选：如果需要严格检查失败就终止构建，开启下面的配置 -->
                <failOnError>true</failOnError>
            </configuration>
            <!-- 可选：绑定插件到verify阶段，这样执行mvn clean install时也会自动检查 -->
            <executions>
                <execution>
                    <id>run-checkstyle</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

额外验证步骤 #

• 确认配置文件路径：确保my-checks.xml确实在项目根目录，如果放在子目录（比如config/checkstyle/my-checks.xml），要把configLocation改成对应的相对路径。
• 查看执行日志：执行mvn clean checkstyle:check时，观察控制台输出，如果你看到类似Using config file: /path/to/your/project/my-checks.xml的日志，说明自定义配置已经被正确加载了。
• 更新插件版本：旧版本的Checkstyle插件可能存在配置优先级的问题，建议升级到最新的稳定版本。

多模块项目注意事项 #

如果是多模块Maven项目，建议把Checkstyle配置放在父pom.xml的pluginManagement块里，这样所有子模块都会继承这个配置，避免重复配置。

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