使用自定义 Checkstyle Checker 配置

可以定义自定义Checker 配置 xml 文件,然后通过 URL、文件或构建类路径资源引用进行引用。

要引用自定义 Checkstyle Checker 配置,请使用configLocation参数。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.1.2</version>
        <configuration>
          <configLocation>checkstyle.xml</configLocation>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

此示例导致 Checkstyle 插件在依赖项或构建扩展类路径的编译范围内检查名为checkstyle.xml的文件或名为checkstyle.xml的资源。

Checkstyle 插件附带了 2 个预定义的 Checkstyle 配置定义,默认选择 Sun Microsystems 定义。

  • sun_checks.xml - Sun 微系统定义(默认)。
  • google_checks.xml - 谷歌定义。