API 文档 | Ear |
---|
组装一个 EAR 归档文件。
属性 | 描述 |
archiveAppendix | 归档文件名的附录部分(如果存在)。 |
archiveBaseName | 归档文件的基本名称。 |
archiveClassifier | 归档文件名的分类器部分(如果存在)。 |
archiveExtension | 归档文件名的扩展名部分。 |
archiveFile | 构造归档文件的 |
archiveFileName | 归档文件名。如果未显式设置名称,则名称的模式为: |
archiveVersion | 归档文件名的版本部分。 |
caseSensitive | 指定是否使用区分大小写的模式匹配。 |
destinationDirectory | 归档文件将被放置的目录。 |
dirPermissions | 用于查询和配置目录访问权限的属性。如果未设置属性值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 |
duplicatesStrategy | 尝试将多个文件复制到同一目标位置时使用的策略。 |
entryCompression | 归档文件条目的压缩级别。如果设置为 |
excludes | 排除模式集合。 |
filePermissions | 用于查询和配置文件访问权限的属性。如果未设置属性值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 |
generateDeploymentDescriptor | 是否应该生成部署描述符? |
includeEmptyDirs | 指示复制操作中是否包含空目标目录。 |
includes | 包含模式集合。 |
libDirName | EAR 文件中库目录的名称。默认值为 "lib"。 |
manifest | 此 JAR 归档文件的清单。 |
metadataCharset | 用于编码 JAR 元数据(如文件名)的字符集。默认为 UTF-8。您可以更改此属性,但不建议这样做,因为 JVM 期望 JAR 元数据使用 UTF-8 编码。 |
preserveFileTimestamps | 指定是否在归档文件中保留文件时间戳。 |
reproducibleFileOrder | 指定从目录读取文件时是否强制执行可重现的文件顺序。 |
source | 此任务的源文件。 |
zip64 | Zip 文件是否可以包含超过 65535 个文件和/或支持大于 4GB 的文件。 |
方法 | 描述 |
deploymentDescriptor(configureClosure) | 为此 EAR 归档文件配置部署描述符。 |
deploymentDescriptor(configureAction) | 为此 EAR 归档文件配置部署描述符。 |
eachFile(closure) | 添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。给定的闭包以 |
eachFile(action) | 添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容,或者完全将文件从结果中排除。操作按添加顺序执行,并从父 spec 继承。 |
exclude(excludeSpec) | 添加一个排除 spec。可以多次调用此方法以附加新的 spec。给定的闭包以 |
exclude(excludes) | 添加 ANT 风格的排除模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludes) | 添加 ANT 风格的排除模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludeSpec) | 添加一个排除 spec。可以多次调用此方法以附加新的 spec。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。 |
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) | 添加一个基于提供的闭包的内容过滤器。闭包将以每一行(去除行尾)作为参数调用,应返回一个 String 来替换该行,或返回 |
filter(filterType) | 添加一个在复制过程中使用的内容过滤器。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 |
filter(properties, filterType) | 添加一个在复制过程中使用的内容过滤器。多次调用 filter 会向过滤器链中添加额外的过滤器。每个过滤器都应实现 |
filter(transformer) | 添加一个基于提供的 transformer 的内容过滤器。闭包将以每一行(去除行尾)作为参数调用,应返回一个 String 来替换该行,或返回 |
from(sourcePath, c) | 指定复制的源文件或目录,并创建一个子 |
from(sourcePath, configureAction) | 指定复制的源文件或目录,并创建一个子 |
from(sourcePaths) | 指定复制的源文件或目录。给定的路径按照 |
include(includeSpec) | 添加一个包含 spec。可以多次调用此方法以附加新的 spec。给定的闭包以 |
include(includes) | 添加 ANT 风格的包含模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。 |
include(includes) | 添加 ANT 风格的包含模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。 |
include(includeSpec) | 添加一个包含 spec。可以多次调用此方法以附加新的 spec。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式或 spec 才能被包含。 |
into(destPath) | 指定文件中 *在归档文件内部* 的目标目录。目标位置按照 |
into(destPath, configureClosure) | 创建并配置一个子 |
into(destPath, copySpec) | 创建并配置一个子 |
lib(configureClosure) | 添加要包含在 EAR 归档文件 'lib' 目录中的依赖库。 |
lib(configureAction) | 添加要包含在 EAR 归档文件 'lib' 目录中的依赖库。 |
manifest(configureClosure) | 为此 JAR 归档文件配置清单。 |
manifest(configureAction) | 为此 JAR 归档文件配置清单。 |
metaInf(configureClosure) | 为此 JAR 归档文件的 META-INF 目录添加内容。 |
metaInf(configureAction) | 为此 JAR 归档文件的 META-INF 目录添加内容。 |
rename(closure) | 重命名源文件。闭包将以文件名作为单一参数调用。闭包应返回一个 String 对象作为新的目标名称。闭包可以返回 null,在这种情况下将使用原始名称。 |
rename(sourceRegEx, replaceWith) | 根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意,替换字符串应使用 '$1' 语法引用源正则表达式中的捕获组。不匹配源正则表达式的文件将以原始名称复制。 |
rename(sourceRegEx, replaceWith) | 根据正则表达式重命名文件。请参阅 |
rename(renamer) | 重命名源文件。函数将以文件名作为单一参数调用。函数应返回一个新的目标名称。函数可以返回 null,在这种情况下将使用原始名称。 |
with(sourceSpecs) | 将给定的 specs 添加为此 spec 的子项。 |
Provider
<RegularFile
>
archiveFile
Provider
<RegularFile
>构造归档文件的 RegularFile
。路径即为 destinationDirectory
加上 archiveFileName
。
- 使用
ear
插件时的默认值 ${destinationDirectory}
/${archiveFileName}
归档文件名。如果未显式设置名称,则名称的模式为:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]
- 使用
ear
插件时的默认值 ${archiveBaseName}
-${archiveAppendix}
-${archiveVersion}
-${archiveClassifier}
.${archiveExtension}
Property
<ConfigurableFilePermissions
>
dirPermissions
Property
<ConfigurableFilePermissions
>用于查询和配置目录访问权限的属性。如果未设置属性值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions
。
- 使用
ear
插件时的默认值 null
DuplicatesStrategy
duplicatesStrategy
尝试将多个文件复制到同一目标位置时使用的策略。
该值可以使用枚举值的字符串(不区分大小写)设置(例如,DuplicatesStrategy.EXCLUDE
使用 'exclude'
)。
对于单个文件,可以使用 CopySpec.eachFile(org.gradle.api.Action)
或 CopySpec.filesMatching(java.lang.String, org.gradle.api.Action)
覆盖此策略。
- 使用
ear
插件时的默认值 DuplicatesStrategy.INHERIT
ZipEntryCompression
entryCompression
归档文件条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED
(默认值),则每个条目都使用 DEFLATE 算法压缩。如果设置为 ZipEntryCompression.STORED
,则归档文件的条目保持未压缩状态。
- 默认值
ZipEntryCompression.DEFLATED
Property
<ConfigurableFilePermissions
>
filePermissions
Property
<ConfigurableFilePermissions
>用于查询和配置文件访问权限的属性。如果未设置属性值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions
。
- 使用
ear
插件时的默认值 null
Manifest
manifest
此 JAR 归档文件的清单。
String
metadataCharset
用于编码 JAR 元数据(如文件名)的字符集。默认为 UTF-8。您可以更改此属性,但不建议这样做,因为 JVM 期望 JAR 元数据使用 UTF-8 编码。
- 默认值
UTF-8
指定是否在归档文件中保留文件时间戳。
如果为 false
,则确保不同机器、Java 版本和操作系统之间的构建具有相同的归档条目时间。
- 使用
ear
插件时的默认值 true
指定从目录读取文件时是否强制执行可重现的文件顺序。
然后 Gradle 将以独立于文件系统和操作系统的可重现顺序遍历作为此归档文件一部分的磁盘目录。这有助于 Gradle 可靠地生成逐字节可重现的归档文件。
- 使用
ear
插件时的默认值 false
FileCollection
source
(只读)
此任务的源文件。
Zip 文件是否可以包含超过 65535 个文件和/或支持大于 4GB 的文件。
标准 zip 格式对文件大小和数量有硬性限制。Zip64 格式扩展 实际上消除了这些限制,因此对于构建大型 zip 文件是必需的。
但是,并非所有 Zip 读取器都支持 Zip64 扩展。值得注意的是,JDK 类 ZipInputStream
在 Java 7 之前的版本中不支持 Zip64。这意味着如果您构建的 JAR 要在 Java 6 及更早版本的运行时环境中使用,则不应启用此属性。
- 默认值
false
为此 EAR 归档文件配置部署描述符。
执行给定的闭包来配置部署描述符。DeploymentDescriptor
作为其代理传递给闭包。
Ear
deploymentDescriptor
(Action
<? super DeploymentDescriptor
>
configureAction)
Action
<? super DeploymentDescriptor
>为此 EAR 归档文件配置部署描述符。
执行给定的 action 来配置部署描述符。
AbstractCopyTask
eachFile
(Closure
closure)
添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。给定的闭包以 FileCopyDetails
作为参数调用。操作按添加顺序执行,并从父 spec 继承。
AbstractCopyTask
eachFile
(Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容,或者完全将文件从结果中排除。操作按添加顺序执行,并从父 spec 继承。
AbstractCopyTask
exclude
(Closure
excludeSpec)
添加一个排除 spec。可以多次调用此方法以附加新的 spec。给定的闭包以 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
>添加一个排除 spec。可以多次调用此方法以附加新的 spec。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。
AbstractCopyTask
expand
(Map
<String
, ?>
properties)
Map
<String
, ?>在复制每个文件时,扩展文件中的属性引用。更具体地说,每个文件都使用 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)
Map
<String
, ?>Action
<? super ExpandDetails
>在复制每个文件时,扩展文件中的属性引用。更具体地说,每个文件都使用 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)
Iterable
<String
>Action
<? super FileCopyDetails
>为路径匹配任何指定 Ant 风格模式的文件配置 FileCopyDetails
。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
AbstractCopyTask
filesMatching
(String
pattern, Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>为路径匹配指定 Ant 风格模式的文件配置 FileCopyDetails
。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
AbstractCopyTask
filesNotMatching
(Iterable
<String
>
patterns, Action
<? super FileCopyDetails
>
action)
Iterable
<String
>Action
<? super FileCopyDetails
>为路径不匹配任何指定 Ant 风格模式的文件配置 FileCopyDetails
。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
AbstractCopyTask
filesNotMatching
(String
pattern, Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>为路径不匹配指定 Ant 风格模式的文件配置 FileCopyDetails
。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
AbstractCopyTask
filter
(Closure
closure)
添加一个基于提供的闭包的内容过滤器。闭包将以每一行(去除行尾)作为参数调用,应返回一个 String 来替换该行,或返回 null
来移除该行。如果移除了所有行,结果将是一个空文件,而不是不存在的文件。
AbstractCopyTask
filter
(Class
<? extends FilterReader
>
filterType)
Class
<? extends FilterReader
>添加一个在复制过程中使用的内容过滤器。多次调用 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)
Map
<String
, ?>Class
<? extends FilterReader
>添加一个在复制过程中使用的内容过滤器。多次调用 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'])
AbstractCopyTask
filter
(Transformer
<String
, String
>
transformer)
Transformer
<String
, String
>添加一个基于提供的 transformer 的内容过滤器。闭包将以每一行(去除行尾)作为参数调用,应返回一个 String 来替换该行,或返回 null
来移除该行。如果移除了所有行,结果将是一个空文件,而不是不存在的文件。
AbstractCopyTask
from
(Object
sourcePath, Closure
c)
指定复制的源文件或目录,并创建一个子 CopySourceSpec
。给定的源路径按照 Project.files(java.lang.Object[])
的方式进行评估。
AbstractCopyTask
from
(Object
sourcePath, Action
<? super CopySpec
>
configureAction)
Action
<? super CopySpec
>指定复制的源文件或目录,并创建一个子 CopySpec
。给定的源路径按照 Project.files(java.lang.Object[])
的方式进行评估。
AbstractCopyTask
from
(Object
...
sourcePaths)
Object
...指定复制的源文件或目录。给定的路径按照 Project.files(java.lang.Object[])
的方式进行评估。
AbstractCopyTask
include
(Closure
includeSpec)
添加一个包含 spec。可以多次调用此方法以附加新的 spec。给定的闭包以 FileTreeElement
作为参数传递。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式或 spec 才能被包含。
AbstractCopyTask
include
(Iterable
<String
>
includes)
Iterable
<String
>添加 ANT 风格的包含模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。
AbstractCopyTask
include
(String
...
includes)
String
...添加 ANT 风格的包含模式。可以多次调用此方法以附加新模式,也可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。
AbstractCopyTask
include
(Spec
<FileTreeElement
>
includeSpec)
Spec
<FileTreeElement
>添加一个包含 spec。可以多次调用此方法以附加新的 spec。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式或 spec 才能被包含。
AbstractArchiveTask
into
(Object
destPath)
指定文件中 *在归档文件内部* 的目标目录。目标位置按照 Project.file(java.lang.Object)
的方式进行评估。不要与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定了归档文件的输出目录。
AbstractArchiveTask
into
(Object
destPath, Closure
configureClosure)
创建并配置一个子 CopySpec
,指定文件中 *在归档文件内部* 的目标目录。目标位置按照 Project.file(java.lang.Object)
的方式进行评估。不要与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定了归档文件的输出目录。
创建并配置一个子 CopySpec
,指定文件中 *在归档文件内部* 的目标目录。目标位置按照 Project.file(java.lang.Object)
的方式进行评估。不要与 AbstractArchiveTask.getDestinationDirectory()
混淆,后者指定了归档文件的输出目录。
添加要包含在 EAR 归档文件 'lib' 目录中的依赖库。
给定的闭包将执行以配置 CopySpec
。CopySpec
作为其委托对象传递给闭包。
添加要包含在 EAR 归档文件 'lib' 目录中的依赖库。
给定的 Action 将执行以配置 CopySpec
。
为此 JAR 归档文件配置清单。
给定的闭包将执行以配置 manifest。Manifest
作为其委托对象传递给闭包。
为此 JAR 归档文件的 META-INF 目录添加内容。
给定的闭包将执行以配置 CopySpec
。CopySpec
作为其委托对象传递给闭包。
为此 JAR 归档文件的 META-INF 目录添加内容。
给定的 Action 将执行以配置 CopySpec
。
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)
。
AbstractCopyTask
rename
(Transformer
<String
, String
>
renamer)
Transformer
<String
, String
>重命名源文件。函数将以文件名作为单一参数调用。函数应返回一个新的目标名称。函数可以返回 null,在这种情况下将使用原始名称。