现有项目添加maven-checkstyle-plugin后未检测出代码违规的解决方法

问题场景 #

已在项目中配置maven-checkstyle-plugin：

<project>
....
    <build>
        <plugins>
            <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-checkstyle-plugin</artifactId>
               <version>3.2.0</version>
                <configuration>
                    <configLocation>google_checks.xml</configLocation>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

执行mvn checkstyle:checkstyle或mvn checkstyle:check后，控制台输出[INFO] You have 0 Checkstyle violations.，但代码中已故意添加违规内容，怀疑插件未扫描/src/main/resources目录。

解决方案 #

1. 配置插件扫描资源目录 #

默认情况下，maven-checkstyle-plugin仅扫描Java源文件（**/*.java），不会处理src/main/resources下的资源文件。需要在插件配置中添加<includes>节点，指定要扫描的资源文件类型：

<project>
....
    <build>
        <plugins>
            <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-checkstyle-plugin</artifactId>
               <version>3.2.0</version>
                <configuration>
                    <configLocation>google_checks.xml</configLocation>
                    <!-- 新增扫描规则，包含资源目录下的文件 -->
                    <includes>
                        <include>**/*.java</include>
                        <include>**/*.xml</include>
                        <include>**/*.properties</include>
                        <!-- 根据项目需求添加其他资源类型，如.yml/.yaml等 -->
                    </includes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2. 关于google_checks.xml的加载 #

不需要将google_checks.xml显式添加到类路径。该配置是Checkstyle官方自带的规则集，maven-checkstyle-plugin会自动从依赖的Checkstyle库中加载，只要<configLocation>配置为google_checks.xml即可生效。如果想验证配置是否加载成功，可以故意写错路径（比如写成google_checks1.xml），执行命令会抛出找不到配置文件的错误，以此确认插件是否正确读取配置。

3. 验证违规内容的合规性 #

确保添加的违规内容确实违反了google_checks.xml中的规则。比如资源文件中的：

• XML文件标签缩进不符合规范
• properties文件键名未使用小写+下划线命名
• 资源文件存在多余空行或空格

若不确定规则细节，可以通过调试模式查看插件扫描的文件和规则执行情况：

mvn checkstyle:check -X

该命令会输出详细日志，可确认插件是否扫描到目标资源文件，以及规则是否正确应用。

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