Apache Maven Checkstyle 插件——常见问题

经常问的问题

config/maven_checks.xml预定义规则集在哪里？
Checkstyle 属性是如何设置的？
如何设置自定义规则集？
如何在 Checkstyle 中包含测试目录？
checkstyle:checkstyle 和 checkstyle:check 有什么区别？

config/maven_checks.xml预定义规则集在哪里？

从 maven-checkstyle-plugin 2.14 版开始，config/maven_checks.xml预定义规则集不再是插件的一部分，而是移至 Apache Maven Shared Resources。

Checkstyle 属性是如何设置的？

您可以通过 propertiesLocation参数设置要在 POM 的插件配置中使用的 Checkstyle 属性。插件将根据其值解析属性文件。

如何设置自定义规则集？

您可以通过configLocation插件参数设置自定义规则集。如果未指定任何值，插件将使用与插件捆绑在一起的默认规则集sun_checks.xml 。

如何在 Checkstyle 中包含测试目录？

您可以通过将includeTestSourceDirectory插件参数设置为true 来在 Checkstyle 报告中包含测试目录。

checkstyle:checkstyle 和 checkstyle:check 有什么区别？

checkstyle:checkstyle 目标是一个报告目标，它将 Checkstyle 违规报告添加到 maven-site-plugin 的输出中。checkstyle:check 目标是向控制台报告违规和/或在出现违规时使构建失败的普通目标。