checkstyle 配置期间失败：无法解析配置流

Question

我目前正在致力于为 maven/java 项目实现 checkstyle。由于我公司的项目非常复杂且太大，因此我从一个较小的项目开始，只是为了测试它是否有效。到目前为止，实施情况良好。checkstyle.xml我将其连接到pom.xml，所有设置都已完成。同样在报告部分，因为我想要一些输出。问题是，它想以某种方式解析某些内容，但我什至无权访问这些文件。

检查样式.xml：

<!DOCTYPE module PUBLIC
  "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
  "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <module name="AvoidStaticImport">
            <property name="excludes" 
value="java.lang.System.out,java.lang.Math.*" />
        </module>
    </module>
</module>
 <module name="ImportOrder">
   <property name="groups" value="*,javax,java"/>
   <property name="ordered" value="true"/>
   <property name="separated" value="false"/>
   <property name="option" value="top"/>
   <property name="sortStaticImportsAlphabetically" value="true"/>
</module>
<module name="SuppressionXpathSingleFilter">
    <property name="checks" value="ImportOrder"/>
    <property name="message" value="^'java\..*'.*"/>
</module>

pom.xml：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <configLocation>checkstyle.xml</configLocation>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
    </build>
    <reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <configLocation>checkstyle.xml</configLocation>
                </configuration>
            </plugin>
        </plugins>
    </reporting><!---->
<dependencies>
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <version>3.9</version>
    </dependency>
</dependencies>

堆栈跟踪：

[INFO] --- maven-checkstyle-plugin:3.1.0:check (default) @ testHelloWorld ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.464 s
[INFO] Finished at: 2019-07-17T11:34:20+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (default) on project testHelloWorld: Failed during checkstyle execution: Failed during checkstyle configuration: unable to parse configuration stream - The markup in the document following the root element must be well-formed.:11:3 -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (default) on project testHelloWorld: Failed during checkstyle execution

导致：org.apache.maven.plugin.MojoExecutionException：checkstyle执行期间失败

导致：org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException：checkstyle配置期间失败

原因: com.puppycrawl.tools.checkstyle.api.CheckstyleException: 无法解析配置流 - 根元素后面的文档中的标记必须格式正确。:11:3

以及： 由以下原因引起：org.xml.sax.SAXParseException：根元素后面的文档中的标记必须格式正确。

我明白了checkstyle-result.xml，但它是空的。在我拿回一个空的 XML 模板之前，它可以正常工作，没有任何待办事项。我仍然期待一份checkstyle.html报告文件。

Answer 1

你的checkstyle.xml格式不正确。格式良好的 XML 文档具有单个根元素。您应该将您的模块放置ImportOrder在SuppressionXpathSingleFilter如下所示的位置TreeWalker：

<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
  <module name="TreeWalker">
    <module name="AvoidStaticImport">
      <property name="excludes" value="java.lang.System.out,java.lang.Math.*"/>
    </module>
    <module name="ImportOrder">
      <property name="groups" value="*,javax,java"/>
      <property name="ordered" value="true"/>
      <property name="separated" value="false"/>
      <property name="option" value="top"/>
      <property name="sortStaticImportsAlphabetically" value="true"/>
    </module>
    <module name="SuppressionXpathSingleFilter">
      <property name="checks" value="ImportOrder"/>
      <property name="message" value="^'java\..*'.*"/>
    </module>
  </module>
</module>