Google Java 风格的 Checkstyle 规则

Question

是否有带有 Google Java 风格的 Checkstyle 规则文件？

Answer 1

checkstyle 团队几天前添加了它。这里是 ： https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml

Answer 2

如果你有一个maven项目，你可以轻松集成google_checks（你必须至少使用

maven-checkstyle-plugin

版本2.17）

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>2.17</version>
  <configuration>
    <configLocation>google_checks.xml</configLocation>
  </configuration>
</plugin>

执行 checkstyle 将使用 google_checks，例如做

mvn checkstyle:checkstyle

版本背景

Checkstyle-project 从 version 6.9 开始集成了 google_checks。 Maven-checkstyle-plugin 版本 2.17。是第一个，在checkstyle6.9之后发布的（实际上它使用了checkstyle6.11.2）。因此，maven-checkstyle-plugin2.17 是该插件的第一个版本，它实际上随 google_checks 一起提供，并且在没有任何其他依赖的情况下提供它。

Answer 3

创建此类文件的 Google Summer of Code 项目意味着它尚不存在。

Answer 4

google_checks.xml 附带 Checkstyle 和 maven 插件。 请参阅 Google 的 Java 风格 Checkstyle 覆盖范围， 另请参阅 Maven Checkstyle 插件的配置

请注意，如果您要根据 google_checks.xml 自定义配置，则需要下载匹配的 checkstyle 版本的 xml（在 github 上），并在其之上进行修改。

Answer 5

首先，尝试检查

build.gradle

中checkstyle的版本：

println checkstyle.toolVersion

我相信你已经添加了：

plugins {
    id 'checkstyle'
}

之后尝试在 checkstylereleases 中找到合适的 checkstyle 版本。

下载版本并仅解压文件

/src/main/resources/google_check.xml

将

google_check.xml

放入您的项目中

./config/checkstyle/

（默认文件夹）

在

build.gradle

中配置checkstyle：

checkstyle {
    configFile file("config/checkstyle/google_checks.xml")
}
checkstyleMain {
    source = 'src/main/java'
}
checkstyleTest {
    source = 'src/test/java'
}

享受吧！ :)