Apache Maven Checkstyle 插件

Checkstyle 插件生成有关开发人员使用的代码样式的报告。有关 Checkstyle 的更多信息，请参阅https://checkstyle.org/。

这个版本的插件默认使用 Checkstyle 8.29，需要 Java 8。但是你可以升级运行时使用的版本。

该插件可以在项目的 POM 中配置。可用于此版本插件的预定义规则集是：sun_checks.xml和google_checks.xml。您还可以通过在插件配置中指定自定义规则集来使用它。

目标概述

Checkstyle 插件有三个目标：

  • checkstyle:checkstyle是一个报告目标，它执行 Checkstyle 分析并生成违规报告。
  • checkstyle:checkstyle-aggregate是一个报告目标，它执行 Checkstyle 分析并生成关于多模块反应器构建中违规的聚合 HTML 报告。
  • checkstyle:check是一个目标，它执行 Checkstyle 分析并将违规或违规计数输出到控制台，可能会导致构建失败。它也可以配置为重新使用早期的分析。

主要版本升级到版本 3.0.0

请注意，以下参数已从插件配置中完全删除：

  • sourceDirectory：使用sourceDirectories代替；
  • testSourceDirectory：改用testSourceDirectories。

用法

关于如何使用 Checkstyle 插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。

如果您对插件的使用仍有疑问，请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档，并且可能已经包含您问题的答案，作为旧线程的一部分。因此，也值得浏览/搜索邮件存档。

如果您觉得插件缺少功能或存在缺陷，您可以在我们的问题跟踪器中填写功能请求或错误报告。创建新问题时，请提供您所关注问题的全面描述。特别是对于修复错误，开发人员可以重现您的问题至关重要。出于这个原因，非常感谢附在问题上的整个调试日志、POM 或最好的小演示项目。当然，补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目，并将在帮助使用 Maven 的指南中找到补充信息。

例子

以下示例展示了如何在更高级的用例中使用 Checkstyle 插件：