检查样式：检查样式

注意：这个 Mojo 应该用作 Maven 报告。

全名：

org.apache.maven.plugins:maven-checkstyle-plugin:2.2:checkstyle

说明：

执行 Checkstyle 分析，并生成违规报告。

属性：

  • 需要执行 Maven 2.0 项目。
  • 需要范围内工件的依赖关系解析：compile.

必需参数

姓名 类型 自从 描述
包括 String - 指定要用于 Checkstyle 的源文件的名称过滤器。默认值为：**/*.java。
输出目录 File - 报告的输出目录。请注意，仅当直接从命令行运行目标时才会评估此参数。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。默认值为：${project.reporting.outputDirectory}。
源目录 File - 指定要用于 Checkstyle 的源目录的位置。默认值为：${project.build.sourceDirectory}。

可选参数

姓名 类型 自从 描述
缓存文件 String - 指定用于在连续运行中加速 Checkstyle 的缓存文件。默认值为：${project.build.directory}/checkstyle-cachefile。
配置位置 String -

指定要使用的 XML 配置的位置。

潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式（Checkstyle Checker 模块 ）配置。

此参数被解析为资源、URL 和文件。如果成功解析，配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中，然后作为配置传递给 Checkstyle。

有 4 个预定义的规则集。

  • config/sun_checks.xml: 太阳检查。
  • config/turbine_checks.xml: 涡轮检查。
  • config/avalon_checks.xml: 阿瓦隆检查。
  • config/maven_checks.xml: Maven 源代码检查。
默认值为：config/sun_checks.xml。
控制台输出 boolean - 将错误输出到控制台。默认值为：false。
enableFiles总结 boolean - 指定是否应启用文件摘要。默认值为：true。
启用RSS boolean - 指定是否应启用 RSS。默认值为：true。
enableRules总结 boolean - 指定是否应启用规则摘要。默认值为：true。
enableSeveritySummary boolean - 指定是否应启用严重性摘要。默认值为：true。
编码 String 2.2 读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。注意：此参数始终覆盖charsetCheckstyleTreeWalker模块中的属性。默认值为：${project.build.sourceEncoding}。
排除 String - 指定要为 Checkstyle 排除的源文件的名称过滤器。
失败错误 boolean - 指定构建是否应因违规而失败。默认值为：false。
格式 String - 已弃用。指定要使用的预定义检查集。可用的集合是“sun”（用于 Sun 编码约定）、“turbine”和“avalon”。默认值为：sun。
头文件 File - 已弃用。指定 Checkstyle 用来验证源代码是否具有正确的许可证头的许可证文件（也称为头文件）的位置。
标头位置 String 2.0-beta-2

指定 Checkstyle 可以使用的许可证文件（也称为头文件）的位置，以验证源代码是否具有正确的许可证头。

您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。

例如：

<module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module>

默认值为：LICENSE.txt。
包括TestSourceDirectory boolean 2.2 包含或不包含用于 Checkstyle 的测试源目录。默认值为：${false}。
链接外部参照 boolean 2.1 将违规行号链接到源外部参照。如果正在使用 Maven JXR 插件，将自动链接。默认值为：true。
输出文件 File - 指定保存 checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数决定。默认值为：${project.build.directory}/checkstyle-result.xml。
输出文件格式 String - 指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。默认值为：xml。
包名文件 String - 已弃用。指定用于配置 Checkstyle 的包名称 XML 的位置。
包名称位置 String 2.0-beta-2

指定用于配置 Checkstyle Packages的包名称 XML 的位置 。

此参数被解析为资源、URL 和文件。如果解析为资源或 URL，则将包名称 XML 的内容复制到 ${project.build.directory}/checkstyle-packagenames.xml 文件中，然后再传递给 Checkstyle 进行加载。
属性文件 File - 已弃用。指定将用于检查源的 Checkstyle 属性文件的位置。
属性位置 String 2.0-beta-2

指定属性文件的位置。

这个参数被解析为 URL，文件然后资源。如果成功解析，则将属性位置的内容复制到 ${project.build.directory}/checkstyle-checker.properties 文件中，然后再传递给 Checkstyle 进行加载。

的内容propertiesLocation将提供给 Checkstyle 用于指定 xml 配置中的参数值（在configLocation 参数中指定）。
属性URL URL - 已弃用。指定将用于检查源的 Checkstyle 属性的 URL。
财产扩张 String - 允许指定原始属性扩展信息。
跳过 boolean 2.2 跳过整个检查。默认值为：false。
抑制文件 String - 已弃用。指定要使用的抑制 XML 文件的位置。该插件定义了一个以该属性的值命名的 Checkstyle checkstyle.suppressions.file属性。这允许在指定抑制文件时在您自己的自定义 checkstyle 配置文件中使用 Checkstyle 属性。
抑制文件表达式 String 2.1 要在抑制文件的属性中使用的键。默认值为：checkstyle.suppressions.file。
抑制位置 String 2.0-beta-2

指定要使用的抑制 XML 文件的位置。

此参数被解析为资源、URL 和文件。如果成功解决，则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中，然后再传递给 Checkstyle 进行加载。

查看suppressionsFileExpression将可用于您的 checkstyle 配置的属性。
测试源目录 File 2.2 指定要用于 Checkstyle 的测试源目录的位置。默认值为：${project.build.testSourceDirectory}。
使用文件 File - 如果null是，Checkstyle 插件将在标准输出上显示违规。否则，将创建一个包含违规的文本文件。
外部参照位置 File - 要链接到的外部参照的位置。默认值为：${project.reporting.outputDirectory}/xref。

参数详情

缓存文件 ：

指定用于在连续运行中加速 Checkstyle 的缓存文件。

  • 类型：java.lang.String
  • 必需：No
  • 默认：${project.build.directory}/checkstyle-cachefile

配置位置 ：

指定要使用的 XML 配置的位置。

潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式（Checkstyle Checker 模块 ）配置。

此参数被解析为资源、URL 和文件。如果成功解析，配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中，然后作为配置传递给 Checkstyle。

有 4 个预定义的规则集。

  • config/sun_checks.xml: 太阳检查。
  • config/turbine_checks.xml: 涡轮检查。
  • config/avalon_checks.xml: 阿瓦隆检查。
  • config/maven_checks.xml: Maven 源代码检查。

  • 类型：java.lang.String
  • 必需：No
  • 表达式：${checkstyle.config.location}
  • 默认：config/sun_checks.xml

控制台输出 ：

将错误输出到控制台。

  • 类型：boolean
  • 必需：No
  • 默认：false

enableFiles总结 ：

指定是否应启用文件摘要。

  • 类型：boolean
  • 必需：No
  • 表达式：${checkstyle.enable.files.summary}
  • 默认：true

启用RSS ：

指定是否应启用 RSS。

  • 类型：boolean
  • 必需：No
  • 表达式：${checkstyle.enable.rss}
  • 默认：true

enableRules总结 ：

指定是否应启用规则摘要。

  • 类型：boolean
  • 必需：No
  • 表达式：${checkstyle.enable.rules.summary}
  • 默认：true

启用严重性摘要 ：

指定是否应启用严重性摘要。

  • 类型：boolean
  • 必需：No
  • 表达式：${checkstyle.enable.severity.summary}
  • 默认：true

编码 ：

读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。注意：此参数始终覆盖charsetCheckstyleTreeWalker模块中的属性。

  • 类型：java.lang.String
  • 自：2.2
  • 必需：No
  • 表达式：${encoding}
  • 默认：${project.build.sourceEncoding}

不包括 ：

指定要为 Checkstyle 排除的源文件的名称过滤器。

  • 类型：java.lang.String
  • 必需：No
  • 表达式：${checkstyle.excludes}

失败错误 ：

指定构建是否应因违规而失败。

  • 类型：boolean
  • 必需：No
  • 默认：false

格式 ：

指定要使用的预定义检查集。可用的集合是“sun”（用于 Sun 编码约定）、“turbine”和“avalon”。

  • 已弃用：Use configLocation instead.
  • 类型：java.lang.String
  • 必需：No
  • 默认：sun

头文件 ：

指定 Checkstyle 用来验证源代码是否具有正确的许可证头的许可证文件（也称为头文件）的位置。

  • 已弃用：Use headerLocation instead.
  • 类型：java.io.File
  • 必需：No
  • 表达式：${basedir}/LICENSE.txt

标头位置 ：

指定 Checkstyle 可以使用的许可证文件（也称为头文件）的位置，以验证源代码是否具有正确的许可证头。

您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。

例如：

<module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module>

  • 类型：java.lang.String
  • 自：2.0-beta-2
  • 必需：No
  • 表达式：${checkstyle.header.file}
  • 默认：LICENSE.txt

包括TestSourceDirectory ：

包含或不包含用于 Checkstyle 的测试源目录。

  • 类型：boolean
  • 自：2.2
  • 必需：No
  • 默认：${false}

包括 ：

指定要用于 Checkstyle 的源文件的名称过滤器。

  • 类型：java.lang.String
  • 必需：Yes
  • 表达式：${checkstyle.includes}
  • 默认：**/*.java

链接外部参照 ：

将违规行号链接到源外部参照。如果正在使用 Maven JXR 插件，将自动链接。

  • 类型：boolean
  • 自：2.1
  • 必需：No
  • 表达式：${linkXRef}
  • 默认：true

输出目录 ：

报告的输出目录。请注意，仅当直接从命令行运行目标时才会评估此参数。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。

  • 类型：java.io.File
  • 必需：Yes
  • 默认：${project.reporting.outputDirectory}

输出文件 ：

指定保存 checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数决定。

  • 类型：java.io.File
  • 必需：No
  • 表达式：${checkstyle.output.file}
  • 默认：${project.build.directory}/checkstyle-result.xml

输出文件格式 ：

指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。

  • 类型：java.lang.String
  • 必需：No
  • 表达式：${checkstyle.output.format}
  • 默认：xml

包名文件 ：

指定用于配置 Checkstyle 的包名称 XML 的位置。

  • 已弃用：Use packageNamesLocation instead.
  • 类型：java.lang.String
  • 必需：No

包名位置 ：

指定用于配置 Checkstyle Packages的包名称 XML 的位置 。

此参数被解析为资源、URL 和文件。如果解析为资源或 URL，则将包名称 XML 的内容复制到 ${project.build.directory}/checkstyle-packagenames.xml 文件中，然后再传递给 Checkstyle 进行加载。

  • 类型：java.lang.String
  • 自：2.0-beta-2
  • 必需：No

属性文件 ：

指定将用于检查源的 Checkstyle 属性文件的位置。

  • 已弃用：Use propertiesLocation instead.
  • 类型：java.io.File
  • 必需：No

属性位置 ：

指定属性文件的位置。

这个参数被解析为 URL，文件然后资源。如果成功解析，则将属性位置的内容复制到 ${project.build.directory}/checkstyle-checker.properties 文件中，然后再传递给 Checkstyle 进行加载。

的内容propertiesLocation将提供给 Checkstyle 用于指定 xml 配置中的参数值（在configLocation 参数中指定）。

  • 类型：java.lang.String
  • 自：2.0-beta-2
  • 必需：No
  • 表达式：${checkstyle.properties.location}

属性网址 ：

指定将用于检查源的 Checkstyle 属性的 URL。

  • 已弃用：Use propertiesLocation instead.
  • 类型：java.net.URL
  • 必需：No

属性扩展 ：

允许指定原始属性扩展信息。

  • 类型：java.lang.String
  • 必需：No

跳过 ：

跳过整个检查。

  • 类型：boolean
  • 自：2.2
  • 必需：No
  • 表达式：${checkstyle.skip}
  • 默认：false

源目录 ：

指定要用于 Checkstyle 的源目录的位置。

  • 类型：java.io.File
  • 必需：Yes
  • 默认：${project.build.sourceDirectory}

抑制文件 ：

指定要使用的抑制 XML 文件的位置。该插件定义了一个以该属性的值命名的 Checkstyle checkstyle.suppressions.file属性。这允许在指定抑制文件时在您自己的自定义 checkstyle 配置文件中使用 Checkstyle 属性。

  • 已弃用：Use suppressionsLocation instead.
  • 类型：java.lang.String
  • 必需：No

抑制文件表达式 ：

要在抑制文件的属性中使用的键。

  • 类型：java.lang.String
  • 自：2.1
  • 必需：No
  • 表达式：${checkstyle.suppression.expression}
  • 默认：checkstyle.suppressions.file

抑制位置 ：

指定要使用的抑制 XML 文件的位置。

此参数被解析为资源、URL 和文件。如果成功解决，则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中，然后再传递给 Checkstyle 进行加载。

查看suppressionsFileExpression将可用于您的 checkstyle 配置的属性。

  • 类型：java.lang.String
  • 自：2.0-beta-2
  • 必需：No
  • 表达式：${checkstyle.suppressions.location}

测试源目录 ：

指定要用于 Checkstyle 的测试源目录的位置。

  • 类型：java.io.File
  • 自：2.2
  • 必需：No
  • 默认：${project.build.testSourceDirectory}

使用文件 ：

如果null是，Checkstyle 插件将在标准输出上显示违规。否则，将创建一个包含违规的文本文件。

  • 类型：java.io.File
  • 必需：No

外部参照位置 ：

要链接到的外部参照的位置。

  • 类型：java.io.File
  • 必需：No
  • 默认：${project.reporting.outputDirectory}/xref