API 文档 | War |
---|
组装一个 WAR 归档文件。
属性 | 描述 |
archiveAppendix | 归档文件名称中的附录部分(如果有)。 |
archiveBaseName | 归档文件的基本名称。 |
archiveClassifier | 归档文件名称中的分类器部分(如果有)。 |
archiveExtension | 归档文件名称中的扩展名部分。 |
archiveFile | 构建归档文件的 |
archiveFileName | 归档文件名称。如果名称未明确设置,则名称的模式为: |
archiveVersion | 归档文件名称中的版本部分。 |
caseSensitive | 指定是否应使用区分大小写的模式匹配。 |
classpath | 要包含在 WAR 归档文件中的 classpath。此 classpath 中的任何 JAR 或 ZIP 文件都将包含在 |
destinationDirectory | 放置归档文件的目录。 |
dirPermissions | 用于查询和配置目录访问权限的属性。如果此属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参见 |
duplicatesStrategy | 尝试将多个文件复制到同一目标位置时使用的策略。 |
entryCompression | 归档文件条目的压缩级别。如果设置为 |
excludes | 排除模式集。 |
filePermissions | 用于查询和配置文件访问权限的属性。如果此属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参见 |
includeEmptyDirs | 指示是否在复制中包含空目标目录。 |
includes | 包含模式集。 |
manifest | 此 JAR 归档文件的 manifest。 |
metadataCharset | 用于编码 JAR 元数据(如文件名)的字符集。默认为 UTF-8。您可以更改此属性,但不建议这样做,因为 JVM 期望 JAR 元数据使用 UTF-8 编码。 |
preserveFileTimestamps | 指定是否在归档文件中保留文件时间戳。 |
reproducibleFileOrder | 指定从目录读取文件时是否强制使用可重现的文件顺序。 |
source | 此任务的源文件。 |
webXml | 要包含在 WAR 归档文件中的 |
zip64 | zip 文件是否可以包含超过 65535 个文件和/或支持大于 4GB 的文件。 |
方法 | 描述 |
classpath(classpath) | 向要包含在 WAR 归档文件中的 classpath 添加文件。 |
eachFile(closure) | 添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。给定的 closure 将以 |
eachFile(action) | 添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容或完全从结果中排除文件。操作按添加顺序执行,并从父 spec 继承。 |
exclude(excludeSpec) | 添加一个排除 spec。此方法可以多次调用以追加新的 spec。给定的 closure 将以 |
exclude(excludes) | 添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。 |
exclude(excludes) | 添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。 |
exclude(excludeSpec) | 添加一个排除 spec。此方法可以多次调用以追加新的 spec。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。 |
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) | 根据提供的 closure 添加内容过滤器。Closure 将以每行(已去除换行符)作为参数调用,并应返回一个 String 来替换该行,或返回 |
filter(filterType) | 添加一个在复制期间使用的内容过滤器。多次调用 filter 会向过滤器链添加额外的过滤器。每个过滤器都应实现 |
filter(properties, filterType) | 添加一个在复制期间使用的内容过滤器。多次调用 filter 会向过滤器链添加额外的过滤器。每个过滤器都应实现 |
filter(transformer) | 根据提供的 transformer 添加内容过滤器。Closure 将以每行(已去除换行符)作为参数调用,并应返回一个 String 来替换该行,或返回 |
from(sourcePath, c) | 指定用于复制的源文件或目录,并创建一个子 |
from(sourcePath, configureAction) | 指定用于复制的源文件或目录,并创建一个子 |
from(sourcePaths) | 指定用于复制的源文件或目录。给定的路径按照 |
include(includeSpec) | 添加一个包含 spec。此方法可以多次调用以追加新的 spec。给定的 closure 将以 |
include(includes) | 添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式才能被处理。 |
include(includes) | 添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式才能被处理。 |
include(includeSpec) | 添加一个包含 spec。此方法可以多次调用以追加新的 spec。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。 |
into(destPath) | 指定文件在归档文件*内部*的目标目录。目标目录按照 |
into(destPath, configureClosure) | 创建一个子 |
into(destPath, copySpec) | 创建一个子 |
manifest(configureClosure) | 配置此 JAR 归档文件的 manifest。 |
manifest(configureAction) | 配置此 JAR 归档文件的 manifest。 |
metaInf(configureClosure) | 向此 JAR 归档文件的 META-INF 目录添加内容。 |
metaInf(configureAction) | 向此 JAR 归档文件的 META-INF 目录添加内容。 |
rename(closure) | 重命名源文件。closure 将以一个参数(文件名)调用。closure 应返回一个 String 对象作为新的目标名称。closure 可能返回 null,此时将使用原始名称。 |
rename(sourceRegEx, replaceWith) | 基于正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意,替换字符串应使用 '$1' 语法来引用源正则表达式中的捕获组。不匹配源正则表达式的文件将以原始名称复制。 |
rename(sourceRegEx, replaceWith) | 基于正则表达式重命名文件。请参见 |
rename(renamer) | 重命名源文件。该函数将以一个参数(文件名)调用。该函数应返回一个新的目标名称。该函数可能返回 null,此时将使用原始名称。 |
webInf(configureClosure) | 向此 WAR 归档文件的 |
webInf(configureAction) | 向此 WAR 归档文件的 |
with(sourceSpecs) | 将给定的 spec 作为此 spec 的子项添加。 |
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 归档文件中的 classpath。此 classpath 中的任何 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 归档文件的 manifest。
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 扩展。特别是,早于 Java 7 版本的 JDK 类 ZipInputStream
不支持 Zip64。这意味着如果您正在构建用于 Java 6 及更早版本运行时的 JAR 文件,则不应启用此属性。
- 默认值
false
void
classpath
(Object
...
classpath)
Object
...向要包含在 WAR 归档文件中的 classpath 添加文件。
AbstractCopyTask
eachFile
(Closure
closure)
添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。给定的 closure 将以 FileCopyDetails
作为参数调用。操作按添加顺序执行,并从父 spec 继承。
AbstractCopyTask
eachFile
(Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容或完全从结果中排除文件。操作按添加顺序执行,并从父 spec 继承。
AbstractCopyTask
exclude
(Closure
excludeSpec)
添加一个排除 spec。此方法可以多次调用以追加新的 spec。给定的 closure 将以 FileTreeElement
作为参数传递。closure 应返回 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 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。
AbstractCopyTask
exclude
(String
...
excludes)
String
...添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。
AbstractCopyTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)
Spec
<FileTreeElement
>添加一个排除 spec。此方法可以多次调用以追加新的 spec。如果未提供 excludes,则不排除任何文件。如果提供了 excludes,则文件必须与任何排除模式都不匹配才能被处理。
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)
根据提供的 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 添加内容过滤器。Closure 将以每行(已去除换行符)作为参数调用,并应返回一个 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。给定的 closure 将以 FileTreeElement
作为参数传递。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。
AbstractCopyTask
include
(Iterable
<String
>
includes)
Iterable
<String
>添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式才能被处理。
AbstractCopyTask
include
(String
...
includes)
String
...添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式才能被处理。
AbstractCopyTask
include
(Spec
<FileTreeElement
>
includeSpec)
Spec
<FileTreeElement
>添加一个包含 spec。此方法可以多次调用以追加新的 spec。如果未提供 includes,则包含此容器中的所有文件。如果提供了 includes,则文件必须至少匹配一个包含模式或 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()
混淆,后者指定归档文件的输出目录。
配置此 JAR 归档文件的 manifest。
执行给定的闭包来配置清单文件。将 Manifest
作为其委托传递给闭包。
向此 JAR 归档文件的 META-INF 目录添加内容。
执行给定的闭包来配置 CopySpec
。将 CopySpec
作为其委托传递给闭包。
向此 JAR 归档文件的 META-INF 目录添加内容。
执行给定的操作来配置 CopySpec
。
AbstractCopyTask
rename
(Closure
closure)
重命名源文件。closure 将以一个参数(文件名)调用。closure 应返回一个 String 对象作为新的目标名称。closure 可能返回 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,此时将使用原始名称。
向此 WAR 归档文件的 WEB-INF
目录添加一些内容。
执行给定的闭包来配置 CopySpec
。将 CopySpec
作为其委托传递给闭包。
向此 WAR 归档文件的 WEB-INF
目录添加一些内容。
执行给定的操作来配置 CopySpec
。