Maven Checkstyle运行自定义规则时类初始化失败求助

我正尝试将Checkstyle集成到多个服务的流水线中，目标是实现集中式配置，让所有服务依赖同一规则集。目前在本地PowerShell中运行命令，暂不考虑GitLab流水线步骤。

我创建了标准Maven模块仓库NCS，结构如下：

|-- NCS
|   |-- src
|       |-- main
|           |-- java
|               |-- com
|                   |-- example
|                       |-- check
|                           |-- CustomCheck.java
|   |-- src
|       |-- main
|           |-- resources
|               |-- checkstyle.xml
|   |-- .gitlab-ci.yml
|   |-- pom.xml

CustomCheck逻辑简单，仅用于测试。pom.xml配置已简化，可成功执行mvn clean install，本地.m2中生成了ncs-1.0.0-SNAPSHOT.jar，但运行mvn checkstyle:check时出现错误：

[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.047 s
[INFO] Finished at: 2023-12-22T10:21:29Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.3.1:check (default-cli) on project ncs: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module com.example.check.CustomCheck - Unable to instantiate 'com.example.check.CustomCheck' class, it is also not possible to instantiate it as null. Please recheck that class name is specified as canonical name or read how to configure short name usage https://checkstyle.org/config.html#Packages. Please also recheck that provided ClassLoader to Checker is configured correctly. -> [Help 1]

注释掉checkstyle.xml中的自定义规则后命令可正常执行，我尝试过拆分模块、调整依赖版本均无效，请求帮助解决该问题。

核心原因 #

Maven Checkstyle插件默认使用独立的类加载器，不会自动包含当前项目的编译产物，即便执行了mvn clean install，插件也无法找到CustomCheck类。

具体修复步骤 #

1. 给Checkstyle插件添加项目依赖 #

在pom.xml的maven-checkstyle-plugin配置中，显式添加对当前项目的依赖，让插件能加载到自定义检查类：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.3.1</version>
            <dependencies>
                <!-- 引入当前项目作为插件依赖 -->
                <dependency>
                    <groupId>你的项目实际groupId</groupId>
                    <artifactId>ncs</artifactId>
                    <version>1.0.0-SNAPSHOT</version>
                </dependency>
            </dependencies>
            <configuration>
                <configLocation>src/main/resources/checkstyle.xml</configLocation>
            </configuration>
        </plugin>
    </plugins>
</build>

注意替换你的项目实际groupId为pom.xml中定义的真实groupId。

2. 确保自定义检查类符合Checkstyle规范 #

CustomCheck必须继承Checkstyle的AbstractCheck类，并实现必要的方法，示例结构：

package com.example.check;

import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public class CustomCheck extends AbstractCheck {

    @Override
    public int[] getDefaultTokens() {
        return new int[]{TokenTypes.CLASS_DEF};
    }

    @Override
    public int[] getAcceptableTokens() {
        return getDefaultTokens();
    }

    @Override
    public int[] getRequiredTokens() {
        return getDefaultTokens();
    }

    @Override
    public void visitToken(DetailAST ast) {
        // 自定义检查逻辑示例
        log(ast.getLineNo(), "触发自定义检查规则");
    }
}

3. 调整命令执行顺序 #

先执行mvn clean install将项目编译并安装到本地Maven仓库，再执行mvn checkstyle:check，确保插件能从本地仓库获取到包含自定义类的jar包。

4. 验证checkstyle.xml配置正确性 #

确认自定义模块的全类名拼写无误，示例配置：

<module name="TreeWalker">
    <module name="com.example.check.CustomCheck"/>
</module>

验证操作 #

完成上述配置后，执行以下命令验证：

mvn clean install
mvn checkstyle:check

若配置正确，插件将正常加载自定义检查类并执行规则检查。

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