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