| API 文档 | War |
|---|
打包 WAR 归档文件。
| 属性 | 描述 |
archiveAppendix | 归档名称的附录部分(如果有)。 |
archiveBaseName | 归档的基本名称。 |
archiveClassifier | 归档名称的分类器部分(如果有)。 |
archiveExtension | 归档名称的扩展名部分。 |
archiveFile | 构建归档文件的 |
archiveFileName | 归档名称。如果未明确设置名称,则名称的模式为: |
archiveVersion | 归档名称的版本部分。 |
caseSensitive | 指定是否应使用区分大小写的模式匹配。 |
类路径 | 包含在 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) | 添加基于提供的闭包的内容过滤器。闭包将以每行(去除行尾)作为参数被调用,并应返回一个字符串替换该行或 |
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) | 创建并配置一个子 |
manifest(configureClosure) | 配置此JAR归档文件的清单。 |
manifest(configureAction) | 配置此JAR归档文件的清单。 |
metaInf(configureClosure) | 将内容添加到此JAR归档文件的META-INF目录中。 |
metaInf(configureAction) | 将内容添加到此JAR归档文件的META-INF目录中。 |
rename(closure) | 重命名源文件。闭包将使用单个参数,即文件名。闭包应返回一个带有新目标名称的字符串对象。闭包可以返回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 目录中。此类路径中的任何目录都包含在 WEB-INF/classes 目录中。
- 默认使用
war插件 project.sourceSets.main.runtimeClasspath - project.configurations.providedRuntime
Property<ConfigurableFilePermissions> dirPermissions
Property<ConfigurableFilePermissions>用于查询和配置目录访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息,请参阅 ConfigurableFilePermissions。
- 默认使用
war插件 null
DuplicatesStrategy duplicatesStrategy
尝试将多个文件复制到同一目标时使用的策略。
该值可以使用不区分大小写的枚举值字符串进行设置(例如,DuplicatesStrategy.EXCLUDE 的 '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 扩展。值得注意的是,Java 7 之前的 ZipInputStream JDK 类不支持 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 样式排除模式。此方法可以多次调用以追加新的模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能进行处理。
AbstractCopyTask exclude(String... excludes)
String...添加 ANT 样式排除模式。此方法可以多次调用以追加新的模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能进行处理。
AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)
Spec<FileTreeElement>添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件必须不匹配任何排除模式才能进行处理。
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(' ')}。模板引擎可以通过提供的操作进行配置。
请注意,默认情况下,所有转义序列(\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)
添加基于提供的闭包的内容过滤器。闭包将以每行(去除行尾)作为参数被调用,并应返回一个字符串替换该行或 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映射语法指定过滤器属性。
示例
filter(HeadFilter, lines:25, skip:2) filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
AbstractCopyTask filter(Transformer<String, String> transformer)
Transformer<String, 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)
添加包含规范。此方法可以多次调用以追加新的规范。给定的闭包将 FileTreeElement 作为其参数传递。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。
AbstractCopyTask include(Iterable<String> includes)
Iterable<String>添加 ANT 样式包含模式。此方法可以多次调用以追加新的模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能进行处理。
AbstractCopyTask include(String... includes)
String...添加 ANT 样式包含模式。此方法可以多次调用以追加新的模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式才能进行处理。
AbstractCopyTask include(Spec<FileTreeElement> includeSpec)
Spec<FileTreeElement>添加包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项,则此容器中的所有文件都将包含在内。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含在内。
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归档文件的META-INF目录中。
执行给定的闭包以配置CopySpec。CopySpec作为其委托传递给闭包。
将内容添加到此JAR归档文件的META-INF目录中。
执行给定的操作以配置CopySpec。
AbstractCopyTask rename(Closure 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。