时间戳

首页 > 解决方案 > Checkstyle 插件不关心外部配置文件中的内容

java - Checkstyle 插件不关心外部配置文件中的内容

问题描述

我正在尝试将 Maven Checkstyle 插件与外部配置文件一起使用。该插件在指定或不指定外部配置文件的情况下都可以使用，并且 checksytle 警告会根据是否设置了 configLocation 而有所不同。所以看起来它应该可以正常工作，但事实并非如此。无论我在外部配置文件中输入什么，似乎都会生成相同的警告。事实上，我可以完全清除文件并且似乎没有任何改变。

在 pom 中：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.0.0</version>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <configuration>
                <configLocation>google_checks.xml</configLocation>
                <encoding>UTF-8</encoding>
                <consoleOutput>true</consoleOutput>
                <failsOnError>true</failsOnError>
            </configuration>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>

尝试使用此文件：

https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml

在 pom 中，如果我将名称更改为“does_not_exist.xml”，它将报告找不到带有以下消息的文件：

无法在以下位置找到配置文件：dos_not_exist.xml

由于它没有以正确的文件名打印此消息，它告诉我它可以找到具有正确名称的文件 (google_checks.xml)。

在文件中：

<module name="LineLength">
    <property name="max" value="100"/>
    <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>

如果我将值更改为 10，我仍然会收到警告：

行超过 100 个字符...

我在跑：

mvn clean verify

我尝试将 google_checks.xml 文件放在项目的根目录和src/main/resources目录中。任一位置的结果相同。

我最终想更改行长和缩进的规则，但由于它不关心我在文件中输入的内容，我不知道该怎么做。关于如何使其尊重外部文件中的内容的任何想法？

标签： javacheckstyle

解决方案

相当深入，但是：configLocation您在问题中设置的 XML 被注入到maven-checkstyle-plugin 的CheckstyleViolationCheckMojo#configLocation中，因为这个变量是私有的，它没有出现在他们的 Javadoc 上，但它记录在源代码中。

该描述指出：

此参数被解析为资源、URL 和文件。如果成功解析，配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中，然后作为配置传递给 Checkstyle。

有 2 个预定义的规则集。

  • sun_checks.xml：太阳检查。
  • google_checks.xml：谷歌支票。

我认为正在发生的是它没有以正常方式解析参数，因为google_checks.xml它是预定义的规则集，因此将加载默认值。 google_checks.xml

如果您想使用自己的自定义配置器，您应该将其命名为google_checks.xmlandsun_checks.xml

推荐阅读