代码拉取完成，页面将自动刷新
Checkstyle 重点在于代码格式的检查，保持团队内部的编码风格统一。随着版本的不断发展，也会涉及到一些代码分析规则检查，与 PMD、Findbugs、SonarQube 等代码分析工具有稍微重叠，但专业性相差甚远。这里应用 Checkstyle 主要注重于代码格式的检查。
Checkstyle 内置了 sun_checks 和 google_checks 检查规则，默认使用 sun_checks 规则。这里制定的规则基于 google_checks 进行修改，基于以下两个思考：
Checkstyle 版本和可用规则密切相关。随着版本的不断升级，会带来新的可用规则。在后续应用新规则时将会努力保持向后兼容。
Checkstyle 提供的标准检查可从这里查看：https://checkstyle.org/checks.html
Fork google_checks 文件做变更后，得到 99cloud-java-checks.xml 配置文件，见外部文件。相比于 google_checks 的变更总结如下。
修改检查错误级别 severity 从 warning 到 error，即如果检查不过，则默认构建失败。
缩进规则 Indentation module，默认基于 2 个空格做调整。修改为基于 4 个空格做调整。
文件行长度规则 LineLength module，默认一行最多为 100 个字符。修改为 120 个字符。
命名缩写规则 AbbreviationAsWordInName module 变更 allowedAbbreviationLength property 从 0 到 2，也就是最多允许 3 个单词的缩写，主要是为了兼容 DO / PO / DTO / BO / VO / UID 这些常用缩写，保持与 alibaba Java 开发手册一致。
这里也可通过 allowedAbbreviations property 来精确指定，这里通过数量的好处是适用性更广，缺点是会引入不可控的缩写。也可同时指定，效果为取并集。
空行规则 EmptyLineSeparator module 变更为文件中最多出现一个连续空行。
变量定义距使用距离规则 VariableDeclarationUsageDistance module，默认为 3。修改为 99，以忽略这条规则。
JavaDoc 注释规则 SummaryJavadoc module，默认必须以英文点号（“.”）作为结尾。修改为空，不做结尾符号限定。但在实际编写时，建议如果英文注释则用英文点号（“.”）结尾，中文注释则用中文句号（“。”）结尾。
包名规则 PackageName moduel，默认只允许字母开头。修改第二部分开始允许以下划线（“_”）开头。
添加 ‵NewlineAtEndOfFile` module，文件必须以空行结尾。
添加 TreeWalkermodule 的 IllegalImport 属性，不能出现非法导入，默认不能导入 sun.* 包下的类。
添加 TreeWalkermodule 的 RedundantImport 属性，不能重复导入类。
添加 TreeWalkermodule 的 UnusedImports 属性，不能出现未使用的导入类。
添加 ‵JavadocType` module，配置类和接口必须包含 @author 和 @version 标签，alibaba Java 开发手册限定必须包含 @author 标签。参见：JavadocType。
checkstyle 的默认规则只可以限定必须包含 author 和 version 标签，不能使用非 Javadoc 标准标签。如果需要支持其他标签，需要定制开发。
规则评审和确定后，可编写类似 Google Java Style Guide 的在线文档，并加入版本控制。便于团队内部人员参考。
这里介绍在 Maven 中引入 Checkstyle 插件来集成应用上述规则。其他构建工具如 Gradle 只是工具使用方式不同，检查规则一致。
<project>
... other elements
<build>
<pluginManagement>
<plugins>
... other plugins
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.2</version>
<configuration>
<configLocation>99cloud-java-checks.xml</configLocation>
<consoleOutput>true</consoleOutput>
<linkXRef>false</linkXRef>
<failsOnError>true</failsOnError>
</configuration>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.45.1</version>
</dependency>
</dependencies>
</plugin>
... other plugins
</plugins>
</pluginManagement>
<plugins>
... other plugins
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
... other plugins
</plugins>
</build>
<reporting>
<plugins>
... other plugins
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<!-- override default failsOnError value, do not fail the build -->
<failsOnError>false</failsOnError>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>checkstyle</report>
</reports>
</reportSet>
</reportSets>
</plugin>
... other plugins
</plugins>
</reporting>
... other elements
</project>
说明：
在 parent POM pluginManagement 中引入，方便后续在子模块中和 reporting 中统一应用。
当前（2022-03-12），maven-checkstyle-plugin 最新插件版本为 3.1.2，依赖的是 Checkstyle 版本为 8.29，按照提示升级为 8 版本中最新的 8.45.1。否则会报版本升级的警告。
因为 Maven 插件依赖的还是 8.x 版本，考虑到兼容性，并未升级到最新的 9 和 10。
检查过程配置在 Maven validate 阶段（即生命周期起始阶段），如果 Checkstyle 代码检查未通过，则整个构建过程失败。
reporting 中要覆盖 failsOnError 设置，才可以正常通过 mvn site 生成项目报告。
configLocation 配置了检查规则的文件位置，支持本地或网络路径。也可不引用外部文件，直接配置在<configuration> 的 <checkstyleRules> 中。
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。