ProcessResources

将资源从源目录复制到目标目录,可能对其进行处理。确保目标目录中没有残留的过期资源。

属性

属性描述
caseSensitive

指定是否应使用区分大小写的模式匹配。

destinationDir

将文件复制到的目录。

dirPermissions

用于查询和配置目录访问权限的属性。如果属性未设置值,表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

duplicatesStrategy

当尝试将多个文件复制到同一目标时使用的策略。

excludes

排除模式的集合。

filePermissions

用于查询和配置文件访问权限的属性。如果属性未设置值,表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

includeEmptyDirs

指示是否将空目标目录包含在复制中。

includes

包含模式的集合。

source

此任务的源文件。

方法

方法描述
eachFile(closure)

添加一个操作,在每个文件即将复制到目标时应用于它们。给定的闭包将以一个 FileCopyDetails 作为参数调用。操作按添加顺序执行,并继承自父规范。

eachFile(action)

添加一个操作,在每个文件即将复制到目标时应用于它们。该操作可以改变文件的目标路径、过滤文件内容或完全从结果中排除该文件。操作按添加顺序执行,并继承自父规范。

exclude(excludeSpec)

添加一个排除规范。可以多次调用此方法来添加新的规范。给定的闭包将以一个 FileTreeElement 作为参数传递。闭包应返回 true 或 false。例如:

exclude(excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

exclude(excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

exclude(excludeSpec)

添加一个排除规范。可以多次调用此方法来添加新的规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

expand(properties)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property${property}。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}${classpath*.name.join(' ')}

expand(properties, action)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property${property}。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}${classpath*.name.join(' ')}。模板引擎可以通过提供的 action 进行配置。

filesMatching(patterns, action)

为路径匹配任一指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

filesMatching(pattern, action)

为路径匹配指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

filesNotMatching(patterns, action)

为路径不匹配任一指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

filesNotMatching(pattern, action)

为路径不匹配指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

filter(closure)

基于提供的闭包添加内容过滤器。闭包将以每行(去掉行尾符)作为参数调用,应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是不存在的文件。

filter(filterType)

添加一个内容过滤器,用于复制过程中。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以访问所有标准的 Ant 过滤器。

filter(properties, filterType)

添加一个内容过滤器,用于复制过程中。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以访问所有标准的 Ant 过滤器。

filter(transformer)

基于提供的 transformer 添加内容过滤器。Transformer 将以每行(去掉行尾符)作为参数调用,应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是不存在的文件。

from(sourcePath, c)

指定复制的源文件或目录,并创建一个子 CopySourceSpec。给定源路径根据 Project.files(java.lang.Object[]) 进行评估。

from(sourcePath, configureAction)

指定复制的源文件或目录,并创建一个子 CopySpec。给定源路径根据 Project.files(java.lang.Object[]) 进行评估。

from(sourcePaths)

指定复制的源文件或目录。给定路径根据 Project.files(java.lang.Object[]) 进行评估。

include(includeSpec)

添加一个包含规范。可以多次调用此方法来添加新的规范。给定的闭包将以一个 FileTreeElement 作为参数传递。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。

include(includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能包含在内。

include(includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能包含在内。

include(includeSpec)

添加一个包含规范。可以多次调用此方法来添加新的规范。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。

into(destDir)

指定复制的目标目录。目标目录根据 Project.file(java.lang.Object) 进行评估。

into(destPath, configureClosure)

创建并配置一个带有给定目标路径的子 CopySpec。目标目录根据 Project.file(java.lang.Object) 进行评估。

into(destPath, copySpec)

创建并配置一个带有给定目标路径的子 CopySpec。目标目录根据 Project.file(java.lang.Object) 进行评估。

rename(closure)

重命名源文件。闭包将以文件名称作为单个参数调用。闭包应返回一个带有新目标名称的 String 对象。闭包可以返回 null,在这种情况下将使用原始名称。

rename(sourceRegEx, replaceWith)

基于正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。注意,替换字符串应使用 '$1' 语法引用源正则表达式中的捕获组。不匹配源正则表达式的文件将使用原始名称复制。

rename(sourceRegEx, replaceWith)

基于正则表达式重命名文件。请参阅 CopyProcessingSpec.rename(java.lang.String, java.lang.String)

rename(renamer)

重命名源文件。该函数将以文件名称作为单个参数调用。函数应返回一个新目标名称。函数可以返回 null,在这种情况下将使用原始名称。

with(sourceSpecs)

将给定规范作为此规范的子规范添加。

脚本块

无脚本块

属性详情

boolean caseSensitive

指定是否应使用区分大小写的模式匹配。

默认值
true

File destinationDir

将文件复制到的目录。

默认值
null

用于查询和配置目录访问权限的属性。如果属性未设置值,表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

默认值
null

DuplicatesStrategy duplicatesStrategy

当尝试将多个文件复制到同一目标时使用的策略。

该值可以使用枚举值的字符串形式设置,不区分大小写(例如,'exclude' 对应 DuplicatesStrategy.EXCLUDE)。

可以通过使用 CopySpec.eachFile(org.gradle.api.Action)CopySpec.filesMatching(java.lang.String, org.gradle.api.Action) 为单个文件覆盖此策略。

默认值
DuplicatesStrategy.INHERIT

Set<String> excludes

排除模式的集合。

默认值
[]

用于查询和配置文件访问权限的属性。如果属性未设置值,表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

默认值
null

boolean includeEmptyDirs

指示是否将空目标目录包含在复制中。

默认值
true

Set<String> includes

包含模式的集合。

默认值
[]

FileCollection source (只读)

此任务的源文件。

默认值
[]

方法详情

AbstractCopyTask eachFile(Closure closure)

添加一个操作,在每个文件即将复制到目标时应用于它们。给定的闭包将以一个 FileCopyDetails 作为参数调用。操作按添加顺序执行,并继承自父规范。

AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)

添加一个操作,在每个文件即将复制到目标时应用于它们。该操作可以改变文件的目标路径、过滤文件内容或完全从结果中排除该文件。操作按添加顺序执行,并继承自父规范。

AbstractCopyTask 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 }
}

如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(Iterable<String> excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(String... excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)

添加一个排除规范。可以多次调用此方法来添加新的规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask expand(Map<String, ?> properties)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property${property}。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}${classpath*.name.join(' ')}

注意,所有转义序列(\n\t\\ 等)都会被转换为它们所代表的符号,例如,\n 会变成换行符。如果不需要此行为,应使用 ContentFilterable.expand(java.util.Map, org.gradle.api.Action) 来禁用此行为。

AbstractCopyTask expand(Map<String, ?> properties, Action<? super ExpandDetails> action)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property${property}。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}${classpath*.name.join(' ')}。模板引擎可以通过提供的 action 进行配置。

注意,默认情况下,所有转义序列(\n\t\\ 等)都会被转换为它们所代表的符号,例如,\n 会变成换行符。此行为由 ExpandDetails.getEscapeBackslash() 属性控制。应将其设置为 true 以禁用转义序列转换。

 expand(one: '1', two: 2) {
     escapeBackslash = true
 }

AbstractCopyTask filesMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

为路径匹配任一指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesMatching(String pattern, Action<? super FileCopyDetails> action)

为路径匹配指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

为路径不匹配任一指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching(String pattern, Action<? super FileCopyDetails> action)

为路径不匹配指定 Ant 风格模式的文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filter(Closure closure)

基于提供的闭包添加内容过滤器。闭包将以每行(去掉行尾符)作为参数调用,应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是不存在的文件。

AbstractCopyTask filter(Class<? extends FilterReader> filterType)

添加一个内容过滤器,用于复制过程中。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以访问所有标准的 Ant 过滤器。

示例

   filter(StripJavaComments)
   filter(com.mycompany.project.CustomFilter)

AbstractCopyTask filter(Map<String, ?> properties, Class<? extends FilterReader> filterType)

添加一个内容过滤器,用于复制过程中。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以访问所有标准的 Ant 过滤器。

可以使用 Groovy map 语法指定过滤器属性。

示例

   filter(HeadFilter, lines:25, skip:2)
   filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])

基于提供的 transformer 添加内容过滤器。Transformer 将以每行(去掉行尾符)作为参数调用,应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是不存在的文件。

AbstractCopyTask from(Object sourcePath, Closure c)

指定复制的源文件或目录,并创建一个子 CopySourceSpec。给定源路径根据 Project.files(java.lang.Object[]) 进行评估。

AbstractCopyTask from(Object sourcePath, Action<? super CopySpec> configureAction)

指定复制的源文件或目录,并创建一个子 CopySpec。给定源路径根据 Project.files(java.lang.Object[]) 进行评估。

AbstractCopyTask from(Object... sourcePaths)

指定复制的源文件或目录。给定路径根据 Project.files(java.lang.Object[]) 进行评估。

AbstractCopyTask include(Closure includeSpec)

添加一个包含规范。可以多次调用此方法来添加新的规范。给定的闭包将以一个 FileTreeElement 作为参数传递。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。

AbstractCopyTask include(Iterable<String> includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能包含在内。

AbstractCopyTask include(String... includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法来添加新的模式,单次调用中可以指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能包含在内。

AbstractCopyTask include(Spec<FileTreeElement> includeSpec)

添加一个包含规范。可以多次调用此方法来添加新的规范。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。

AbstractCopyTask into(Object destDir)

指定复制的目标目录。目标目录根据 Project.file(java.lang.Object) 进行评估。

AbstractCopyTask into(Object destPath, Closure configureClosure)

创建并配置一个带有给定目标路径的子 CopySpec。目标目录根据 Project.file(java.lang.Object) 进行评估。

CopySpec into(Object destPath, Action<? super CopySpec> copySpec)

创建并配置一个带有给定目标路径的子 CopySpec。目标目录根据 Project.file(java.lang.Object) 进行评估。

AbstractCopyTask rename(Closure closure)

重命名源文件。闭包将以文件名称作为单个参数调用。闭包应返回一个带有新目标名称的 String 对象。闭包可以返回 null,在这种情况下将使用原始名称。

AbstractCopyTask rename(String sourceRegEx, String replaceWith)

基于正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。注意,替换字符串应使用 '$1' 语法引用源正则表达式中的捕获组。不匹配源正则表达式的文件将使用原始名称复制。

示例

rename '(.*)_OEM_BLUE_(.*)', '$1$2'

会将文件 'style_OEM_BLUE_.css' 映射到 'style.css'

AbstractCopyTask rename(Pattern sourceRegEx, String replaceWith)

基于正则表达式重命名文件。请参阅 CopyProcessingSpec.rename(java.lang.String, java.lang.String)

重命名源文件。该函数将以文件名称作为单个参数调用。函数应返回一个新目标名称。函数可以返回 null,在这种情况下将使用原始名称。

CopySpec with(CopySpec... sourceSpecs)

将给定规范作为此规范的子规范添加。

def contentSpec = copySpec {
  from("content") {
    include "**/*.txt"
  }
}

task copy(type: Copy) {
  into "$buildDir/copy"
  with contentSpec
}