API 文档 | AbstractArchiveTask |
---|
AbstractArchiveTask
是所有归档任务的基类。
属性 | 描述 |
archiveAppendix | 归档名称的附加部分(如果有)。 |
archiveBaseName | 归档的基本名称。 |
archiveClassifier | 归档名称的分类符部分(如果有)。 |
archiveExtension | 归档名称的扩展名部分。 |
archiveFile | 构造归档的 |
archiveFileName | 归档名称。如果名称未显式设置,则名称的模式为: |
archiveVersion | 归档名称的版本部分。 |
caseSensitive | 指定是否应使用区分大小写的模式匹配。 |
destinationDirectory | 归档将被放置的目录。 |
dirPermissions | 用于查询和配置目录访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息,请参阅 |
duplicatesStrategy | 尝试将多个文件复制到同一目标时要使用的策略。 |
excludes | 排除模式的集合。 |
filePermissions | 用于查询和配置文件访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息,请参阅 |
includeEmptyDirs | 指示是否将空目标目录包含在复制中。 |
includes | 包含模式的集合。 |
preserveFileTimestamps | 指定是否应在归档中保留文件时间戳。 |
reproducibleFileOrder | 指定从目录读取文件时是否强制执行可重现的文件顺序。 |
source | 此任务的源文件。 |
方法 | 描述 |
eachFile(closure) | 添加一个操作,以便在每个文件即将复制到其目标位置时应用。给定的闭包使用 |
eachFile(action) | 添加一个操作,以便在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件的内容,或将文件完全从结果中排除。操作按添加顺序执行,并从父规范继承。 |
exclude(excludeSpec) | 添加排除规范。可以多次调用此方法以追加新规范。给定的闭包传递一个 |
exclude(excludes) | 添加 ANT 样式排除模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。 |
exclude(excludes) | 添加 ANT 样式排除模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。 |
exclude(excludeSpec) | 添加排除规范。可以多次调用此方法以追加新规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。 |
expand(properties) | 在复制每个文件时扩展属性引用。更具体地说,每个文件都使用 Groovy 的 |
expand(properties, action) | 在复制每个文件时扩展属性引用。更具体地说,每个文件都使用 Groovy 的 |
filesMatching(patterns, action) | 为路径与任何指定的 Ant 样式模式匹配的每个文件配置 |
filesMatching(pattern, action) | 为路径与指定的 Ant 样式模式匹配的每个文件配置 |
filesNotMatching(patterns, action) | 为路径与任何指定的 Ant 样式模式不匹配的每个文件配置 |
filesNotMatching(pattern, action) | 为路径与指定的 Ant 样式模式不匹配的每个文件配置 |
filter(closure) | 根据提供的闭包添加内容过滤器。将使用每一行(去除行尾符)调用闭包,并且应返回一个字符串以替换该行,或返回 |
filter(filterType) | 添加要在复制期间使用的内容过滤器。多次调用 filter 会将其他过滤器添加到过滤器链。每个过滤器都应实现 |
filter(properties, filterType) | 添加要在复制期间使用的内容过滤器。多次调用 filter 会将其他过滤器添加到过滤器链。每个过滤器都应实现 |
filter(transformer) | 根据提供的转换器添加内容过滤器。将使用每一行(去除行尾符)调用闭包,并且应返回一个字符串以替换该行,或返回 |
from(sourcePath, c) | 指定复制的源文件或目录,并创建子 |
from(sourcePath, configureAction) | 指定复制的源文件或目录,并创建子 |
from(sourcePaths) | 指定复制的源文件或目录。给定的路径根据 |
include(includeSpec) | 添加包含规范。可以多次调用此方法以追加新规范。给定的闭包传递一个 |
include(includes) | 添加 ANT 样式包含模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须匹配至少一个包含模式才能进行处理。 |
include(includes) | 添加 ANT 样式包含模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须匹配至少一个包含模式才能进行处理。 |
include(includeSpec) | 添加包含规范。可以多次调用此方法以追加新规范。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。 |
into(destPath) | 指定文件在归档 *内部* 的目标目录。目标根据 |
into(destPath, configureClosure) | 创建和配置子 |
into(destPath, copySpec) | 创建和配置子 |
rename(closure) | 重命名源文件。将使用单个参数(即文件名)调用闭包。闭包应返回一个包含新目标名称的 String 对象。闭包可以返回 null,在这种情况下将使用原始名称。 |
rename(sourceRegEx, replaceWith) | 基于正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意,替换字符串应使用“$1”语法来引用源正则表达式中的捕获组。与源正则表达式不匹配的文件将使用原始名称复制。 |
rename(sourceRegEx, replaceWith) | 基于正则表达式重命名文件。请参阅 |
rename(renamer) | 重命名源文件。将使用单个参数(即文件名)调用函数。函数应返回一个新目标名称。函数可以返回 null,在这种情况下将使用原始名称。 |
with(sourceSpecs) | 将给定的规范添加为此规范的子规范。 |
Provider
<RegularFile
>
archiveFile
Provider
<RegularFile
>构造归档的 RegularFile
。路径只是 destinationDirectory
加上 archiveFileName
。
- 使用
java
插件的默认值 ${destinationDirectory}
/${archiveFileName}
归档名称。如果名称未显式设置,则名称的模式为:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]
- 使用
java
插件的默认值 ${archiveBaseName}
-${archiveAppendix}
-${archiveVersion}
-${archiveClassifier}
.${archiveExtension}
Property
<ConfigurableFilePermissions
>
dirPermissions
Property
<ConfigurableFilePermissions
>用于查询和配置目录访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息,请参阅 ConfigurableFilePermissions
。
- 使用
java
插件的默认值 null
DuplicatesStrategy
duplicatesStrategy
尝试将多个文件复制到同一目标时要使用的策略。
可以使用枚举值的不区分大小写的字符串设置该值(例如,'exclude'
表示 DuplicatesStrategy.EXCLUDE
)。
可以使用 CopySpec.eachFile(org.gradle.api.Action)
或 CopySpec.filesMatching(java.lang.String, org.gradle.api.Action)
覆盖各个文件的此策略。
- 使用
java
插件的默认值 DuplicatesStrategy.INHERIT
Property
<ConfigurableFilePermissions
>
filePermissions
Property
<ConfigurableFilePermissions
>用于查询和配置文件访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息,请参阅 ConfigurableFilePermissions
。
- 使用
java
插件的默认值 null
指定是否应在归档中保留文件时间戳。
如果为 false
,则确保归档条目在不同机器、Java 版本和操作系统之间的构建中具有相同的时间。
- 使用
java
插件的默认值 true
指定从目录读取文件时是否强制执行可重现的文件顺序。
然后,Gradle 将以可重现的顺序遍历磁盘上作为此归档一部分的目录,而与文件系统和操作系统无关。这有助于 Gradle 可靠地生成字节对字节可重现的归档。
- 使用
java
插件的默认值 false
AbstractCopyTask
eachFile
(Closure
closure)
添加一个操作,以便在每个文件即将复制到其目标位置时应用。给定的闭包使用 FileCopyDetails
作为其参数调用。操作按添加顺序执行,并从父规范继承。
AbstractCopyTask
eachFile
(Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>添加一个操作,以便在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件的内容,或将文件完全从结果中排除。操作按添加顺序执行,并从父规范继承。
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)
Iterable
<String
>添加 ANT 样式排除模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。
AbstractCopyTask
exclude
(String
...
excludes)
String
...添加 ANT 样式排除模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。
AbstractCopyTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)
Spec
<FileTreeElement
>添加排除规范。可以多次调用此方法以追加新规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件不得匹配任何排除模式才能进行处理。
在复制每个文件时扩展属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine
进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property
或 ${property}
。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}
或 ${classpath*.name.join(' ')}
请注意,所有转义序列 (\n
, \t
, \\
, 等) 都会被转换为它们所代表的符号,因此,例如,\n
会变为换行符。如果这是不希望的行为,则应使用 ContentFilterable.expand(java.util.Map, org.gradle.api.Action)
来禁用此行为。
在复制每个文件时扩展属性引用。更具体地说,每个文件都使用 Groovy 的 SimpleTemplateEngine
进行转换。这意味着您可以在文件中使用简单的属性引用,例如 $property
或 ${property}
。您还可以在文件中包含任意 Groovy 代码,例如 ${version ?: 'unknown'}
或 ${classpath*.name.join(' ')}
。可以使用提供的操作配置模板引擎。
请注意,默认情况下,所有转义序列 (\n
, \t
, \\
, 等) 都会被转换为它们所代表的符号,因此,例如,\n
会变为换行符。此行为由 ExpandDetails.getEscapeBackslash()
属性控制。应将其设置为 true
以禁用转义序列转换
expand(one: '1', two: 2) { escapeBackslash = true }
为路径与任何指定的 Ant 样式模式匹配的每个文件配置 FileCopyDetails
。这等效于使用 eachFile() 并根据文件的路径选择性地应用配置。
为路径与指定的 Ant 样式模式匹配的每个文件配置 FileCopyDetails
。这等效于使用 eachFile() 并根据文件的路径选择性地应用配置。
为路径与任何指定的 Ant 样式模式不匹配的每个文件配置 FileCopyDetails
。这等效于使用 eachFile() 并根据文件的路径选择性地应用配置。
为路径与指定的 Ant 样式模式不匹配的每个文件配置 FileCopyDetails
。这等效于使用 eachFile() 并根据文件的路径选择性地应用配置。
根据提供的闭包添加内容过滤器。将使用每一行(去除行尾符)调用闭包,并且应返回一个字符串以替换该行,或返回 null
以删除该行。如果删除每一行,则结果将是一个空文件,而不是一个不存在的文件。
添加要在复制期间使用的内容过滤器。多次调用 filter 会将其他过滤器添加到过滤器链。每个过滤器都应实现 java.io.FilterReader
。包含 org.apache.tools.ant.filters.*
以访问所有标准 Ant 过滤器。
示例
filter(StripJavaComments) filter(com.mycompany.project.CustomFilter)
添加要在复制期间使用的内容过滤器。多次调用 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'])
根据提供的转换器添加内容过滤器。将使用每一行(去除行尾符)调用闭包,并且应返回一个字符串以替换该行,或返回 null
以删除该行。如果删除每一行,则结果将是一个空文件,而不是一个不存在的文件。
指定复制的源文件或目录,并创建子 CopySourceSpec
。给定的源路径根据 Project.files(java.lang.Object[])
进行评估。
指定复制的源文件或目录,并创建子 CopySpec
。给定的源路径根据 Project.files(java.lang.Object[])
进行评估。
指定复制的源文件或目录。给定的路径根据 Project.files(java.lang.Object[])
进行评估。
添加包含规范。可以多次调用此方法以追加新规范。给定的闭包传递一个 FileTreeElement
作为其参数。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。
添加 ANT 样式包含模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须匹配至少一个包含模式才能进行处理。
添加 ANT 样式包含模式。可以多次调用此方法以追加新模式,并且可以在单个调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须匹配至少一个包含模式才能进行处理。
添加包含规范。可以多次调用此方法以追加新规范。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。
指定文件在归档 *内部* 的目标目录。目标根据 Project.file(java.lang.Object)
进行评估。不要将其与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定归档的输出目录。
创建和配置子 CopySpec
,其中包含文件在归档 *内部* 的目标目录。目标根据 Project.file(java.lang.Object)
进行评估。不要将其与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定归档的输出目录。
创建和配置子 CopySpec
,其中包含文件在归档 *内部* 的目标目录。目标根据 Project.file(java.lang.Object)
进行评估。不要将其与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定归档的输出目录。
重命名源文件。将使用单个参数(即文件名)调用闭包。闭包应返回一个包含新目标名称的 String 对象。闭包可以返回 null,在这种情况下将使用原始名称。
基于正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意,替换字符串应使用“$1”语法来引用源正则表达式中的捕获组。与源正则表达式不匹配的文件将使用原始名称复制。
示例
rename '(.*)_OEM_BLUE_(.*)', '$1$2'
将文件 'style_OEM_BLUE_.css' 映射到 'style.css'
基于正则表达式重命名文件。请参阅 CopyProcessingSpec.rename(java.lang.String, java.lang.String)
。
重命名源文件。将使用单个参数(即文件名)调用函数。函数应返回一个新目标名称。函数可以返回 null,在这种情况下将使用原始名称。
将给定的规范添加为此规范的子规范。
def contentSpec = copySpec { from("content") { include "**/*.txt" } } task copy(type: Copy) { into "$buildDir/copy" with contentSpec }