| API 文档 | Pmd |
|---|
对 Java 源代码文件运行一组静态代码分析规则，并生成发现问题的报告。
| 属性 | 描述 |
类路径 | 要分析的类的编译类路径。此类路径上的类在分析期间使用，但本身不进行分析。这仅在 PMD 5.2.1 或更高版本中得到良好支持。 |
consoleOutput | 是否将 PMD 结果写入 |
excludes | 排除模式集。 |
ignoreFailures | 孵化中 指定此任务执行的验证失败时是否应中断构建。 |
includes | 包含模式集。 |
incrementalAnalysis | 控制是否使用增量分析。这仅在 PMD 6.0.0 或更高版本中得到支持。有关更多详细信息，请参阅 https://docs.pmd-code.org/pmd-doc-7.13.0/pmd_userdocs_incremental_analysis.html。 |
javaLauncher | 孵化中 用于启动工作进程的Java启动器 |
maxFailures | 在停止构建之前允许的最大失败次数。默认为 0，这意味着任何失败都会停止构建。值 0 及以上均有效。如果 |
maxHeapSize | 孵化中 工作进程的最大堆大小。如果未指定，Gradle将提供最大堆大小。支持像命令行选项 |
minHeapSize | 孵化中 工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持像命令行选项 |
pmdClasspath | 包含要使用的 PMD 库的类路径。 |
reports | 此任务要生成的报告。 |
ruleSetConfig | 要使用的自定义规则集（如果有）。替换 |
ruleSetFiles | 要使用的自定义规则集文件。有关如何编写规则集文件，请参阅官方文档。如果您只想使用自定义规则集，则必须清除 |
ruleSets | 要使用的内置规则集。请参阅内置规则集的官方列表。 |
rulesMinimumPriority | 指定规则优先级阈值。 |
source | 应用包含和排除模式后，此任务的源。忽略不存在的源文件。 |
targetJdk | PMD 要使用的目标 JDK。 |
threads | 指定 PMD 使用的线程数。 |
| 方法 | 描述 |
exclude(excludeSpec) | 添加排除规范。此方法可以多次调用以追加新的规范。给定的闭包将其参数作为 |
exclude(excludes) | 添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须与任何排除模式都不匹配才能进行处理。 |
exclude(excludes) | 添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须与任何排除模式都不匹配才能进行处理。 |
exclude(excludeSpec) | 添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件必须不匹配任何排除模式才能进行处理。 |
include(includeSpec) | 添加包含规范。此方法可以多次调用以追加新的规范。给定的闭包将其参数作为 |
include(includes) | 添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式才能进行处理。 |
include(includes) | 添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式才能进行处理。 |
include(includeSpec) | 添加包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式或规范才能包含在内。 |
reports(configureAction) | 配置此任务要生成的报告。 |
source(sources) | 向此任务添加一些源。给定的源对象将按照 |
| 块 | 描述 |
reports | 配置此任务要生成的报告。 |
FileCollection classpath
要分析的类的编译类路径。此类路径上的类在分析期间使用，但本身不进行分析。这仅在 PMD 5.2.1 或更高版本中得到良好支持。
- 默认使用
pmd插件 -
sourceSet.outputsourceSet.compileClasspath
控制是否使用增量分析。这仅在 PMD 6.0.0 或更高版本中得到支持。有关更多详细信息，请参阅 https://docs.pmd-code.org/pmd-doc-7.13.0/pmd_userdocs_incremental_analysis.html。
- 默认使用
pmd插件 -
false
在停止构建之前允许的最大失败次数。默认为 0，这意味着任何失败都会停止构建。值 0 及以上均有效。如果
ignoreFailures
设置后，此项将被忽略，构建将继续（允许无限次失败）。
- 默认使用
pmd插件 project.pmd.maxFailures
注意：此属性处于孵化中，可能会在 Gradle 的未来版本中更改。
工作进程的最大堆大小。如果未指定，Gradle将提供最大堆大小。支持像命令行选项-Xmx一样的单位，例如"1g"。
注意：此属性处于孵化中，可能会在 Gradle 的未来版本中更改。
工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持像命令行选项-Xms一样的单位，例如"1g"。
PmdReports reports (只读)
此任务要生成的报告。
TextResource ruleSetConfig
要使用的自定义规则集（如果有）。替换 ruleSetFiles，但目前不支持多个规则集。有关如何编写规则集，请参阅官方文档。
ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))
- 默认使用
pmd插件 project.pmd.ruleSetConfig
FileCollection ruleSetFiles
要使用的自定义规则集文件。有关如何编写规则集文件，请参阅官方文档。如果您只想使用自定义规则集，则必须清除 ruleSets。
ruleSetFiles = files("config/pmd/myRuleSet.xml")
- 默认使用
pmd插件 project.pmd.ruleSetFiles
FileTree source (只读)
应用包含和排除模式后，此任务的源。忽略不存在的源文件。
源的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源不那么严格，请在子类中覆盖此方法以相应地更改它。
- 默认使用
pmd插件 sourceSet.allJava
SourceTask exclude(Closure excludeSpec)
添加排除规范。此方法可以多次调用以追加新的规范。给定的闭包将其参数作为 FileTreeElement 传入。闭包应返回 true 或 false。示例
copySpec {
from 'source'
into 'destination'
//an example of excluding files from certain configuration:
exclude { it.file in configurations.someConf.files }
}
如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能进行处理。
SourceTask exclude(Iterable<String>
Iterable<String>添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须与任何排除模式都不匹配才能进行处理。
SourceTask exclude(String...
String...添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须与任何排除模式都不匹配才能进行处理。
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件必须不匹配任何排除模式才能进行处理。
SourceTask include(Closure includeSpec)
添加包含规范。此方法可以多次调用以追加新的规范。给定的闭包将其参数作为 FileTreeElement 传入。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式或规范才能包含在内。
SourceTask include(Iterable<String>
Iterable<String>添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式才能进行处理。
SourceTask include(String...
String...添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在一次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式才能进行处理。
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>添加包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须至少匹配其中一个包含模式或规范才能包含在内。
PmdReports reports(Action<? super PmdReports>
Action<? super PmdReports>配置此任务要生成的报告。
SourceTask source(Object...
Object...向此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。