如何自定义google_checks.xml模块严重级别并通过Maven Checkstyle运行？

可行性说明 #

完全可以通过单独的自定义配置文件，覆盖Google Checkstyle规则中的指定严重级别，无需修改原google_checks.xml，也不用逐个为规则添加severity属性。核心思路是先导入基础规则配置，再导入自定义覆盖配置，利用Checkstyle的配置优先级特性（后导入的同名规则会覆盖先导入的属性）。

具体配置步骤 #

1. 创建自定义严重级别配置文件 #

在项目资源目录（如src/main/resources）下创建custom_severity.xml，仅定义需要修改严重级别的规则，确保规则名称（name属性）与google_checks.xml中的完全一致：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <!-- 将缩进规则设为ERROR级别 -->
    <module name="Indentation">
        <property name="severity" value="ERROR"/>
    </module>
    <!-- 将行长度规则设为WARNING级别 -->
    <module name="LineLength">
        <property name="severity" value="WARNING"/>
    </module>
    <!-- 可添加更多需要修改的规则 -->
</module>

2. 创建主配置文件 #

同样在资源目录下创建main_checks.xml，先导入Google基础规则，再导入自定义覆盖规则（顺序不能颠倒）：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <!-- 导入Google官方基础规则 -->
    <import file="google_checks.xml"/>
    <!-- 导入自定义严重级别覆盖规则 -->
    <import file="custom_severity.xml"/>
</module>

3. 配置Maven Checkstyle插件 #

在项目pom.xml中配置插件，指定主配置文件路径：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.2.0</version> <!-- 建议使用最新稳定版本 -->
            <configuration>
                <!-- 指向主配置文件 -->
                <configLocation>src/main/resources/main_checks.xml</configLocation>
                <!-- 可选：设置ERROR级别规则违反时终止构建 -->
                <failOnError>true</failOnError>
            </configuration>
            <executions>
                <execution>
                    <id>checkstyle-verify</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

常见问题说明 #

• 之前使用import未生效：大概率是配置顺序错误（先导入了自定义规则再导入基础规则），或者自定义文件的结构不正确（未将规则包裹在Checker模块下）。
• 使用includes无效：includes是Checkstyle插件用来指定需要检查的代码文件，而非加载多个配置文件，属于用法混淆。

运行验证 #

执行Maven命令触发检查：

mvn checkstyle:check

此时指定规则的严重级别会按自定义配置生效，其余规则保持Google原配置的级别。

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