排除 Maven Checkstyle 插件报告中的类

Question

我有一个 Maven 2 项目，我想配置我的 Checkstyle 报告插件，以便只分析我的一些类。我找到了 maven.checkstyle.excludes 属性，但尽管将其作为命令行参数传递（使用 -D=maven.checkstyle.excludes=... ）我无法让它工作。我在插件文档页面上找不到任何内容。理想情况下，我希望能够在 POM 的 部分中进行设置。

Answer 1

如果像我一样，您来到这里寻找一种从 checkstyle 中排除生成的源的方法，请执行以下操作：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>2.15</version>
  <configuration>
    <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
  </configuration>
</plugin>

默认情况下，checkstyle:checkstyle checkstyle 插件的目标使用 ${project.compileSourceRoots}，显然包括生成的源目录。

如果将其更改为 ${project.build.sourceDirectory}，它将仅使用源目录，而不使用任何生成的源目录。

请注意，虽然 已弃用，但替代方案 似乎不起作用。

编辑：在评论中，@Cyrusmith、@Ben 和 @Olivier Callioux 报告说，截至 2017 年， 有效；我无法确认。

Answer 2

如果这个问题是关于 Maven 2，那么属性是 < code>excludes 并采用逗号分隔的 Ant 模式列表。因此，要么在命令行上传递它：

-Dexcludes=**/generated/**/*

要么在插件配置中设置它：

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-checkstyle-plugin</artifactId>
   <configuration>
       <excludes>**/generated/**/*</excludes>
   </configuration>
</plugin>

另一个选择是使用 抑制过滤器。

例如，您可以使用 SuppressionCommentFilter 来抑制包含 CHECKSTYLE:OFF 的注释和包含 CHECKSTYLE:ON 的注释之间的审核事件 /em> （然后只需将这些注释添加到您不想检查的类或代码部分）。

Answer 3

此外，如果您想排除多个独立文件夹，您可以添加多个独立路径，以逗号分隔，如下所示

<excludes>org/log4j/*,com/acme/**/*,com/companyb/*</excludes>

Answer 4

上面的答案对我不起作用，因为我在 Maven 中运行代码生成，它还将目标/生成添加为源目录。

以下解决方案有效：
您必须使用显式的 checkstyle-suppressions.xml 配置文件并从配置中激活它：

<plugins>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.1.1</version>
    <configuration>
      <configLocation>checkstyle.xml</configLocation>
      <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
   [...]

用于排除目标文件夹的抑制文件如下所示：

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
  "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
  "https://checkstyle.org/dtds/suppressions_1_2.dtd">

<suppressions>
  <suppress files="[/\\]target[/\\]" checks=".*" />
</suppressions>

Answer 5

我正在使用 maven 3 并且排除似乎不起作用。有效的是 sourceDirectories 技巧：

            <configuration>
                <sourceDirectories>
                    <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
                </sourceDirectories>
            </configuration>

Answer 6

我正在使用 maven 3，但由于某种原因，排除和 sourceDirectory 都不起作用。为面临同样问题的任何人添加替代方案。

设置自定义检查样式抑制，如下所示。

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>${checkstyle.maven.plugin.version}</version>
                <dependencies>
                    <dependency>
                        <groupId>com.puppycrawl.tools</groupId>
                        <artifactId>checkstyle</artifactId>
                        <version>${com.puppycrawl.tools.version}</version>
                    </dependency>
                </dependencies>
                <executions>
                    <execution>
                        <id>validate</id>
                        <phase>validate</phase>
                        <configuration>
                            <configLocation>
                                src/main/resources/customized_google_checks.xml
                            </configLocation>
                            <suppressionsLocation>
                                src/main/resources/customized_suppressions.xml
                            </suppressionsLocation>
                            <consoleOutput>true</consoleOutput>
                            <failsOnError>true</failsOnError>
                            <failOnViolation>false</failOnViolation>
                            <violationSeverity>warning</violationSeverity>
                            <includeTestSourceDirectory>false</includeTestSourceDirectory>
                        </configuration>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

在抑制文件中使用以下内容来排除特定文件。

<!DOCTYPE suppressions PUBLIC
        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

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

<suppressions>
    <suppress checks=".*" files=".ESAPI.properties" />

</suppressions>