战争

API文档:War

组装 WAR 档案。

特性

财产描述
archiveAppendix

存档名称的附录部分(如果有)。

archiveBaseName

存档的基本名称。

archiveClassifier

存档名称的分类器部分(如果有)。

archiveExtension

存档名称的扩展部分。

archiveFile

RegularFile构建档案的位置。路径就是简单的destinationDirectory加号archiveFileName

archiveFileName

档案名称。如果未显式设置名称,则名称的模式为: [archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

archiveVersion

存档名称的版本部分。

caseSensitive

指定是否应使用区分大小写的模式匹配。

classpath

要包含在 WAR 存档中的类路径。该类路径中的任何 JAR 或 ZIP 文件都包含在该WEB-INF/lib目录中。该类路径中的任何目录都包含在该WEB-INF/classes目录中。

destinationDirectory

将放置存档的目录。

dirPermissions

用于配置目录访问权限的属性。详细信息请参见ConfigurableFilePermissions

duplicatesStrategy

尝试将多个文件复制到同一目标时使用的策略。

entryCompression

存档条目的压缩级别。如果设置为ZipEntryCompression.DEFLATED(默认值),则使用 DEFLATE 算法压缩每个条目。如果设置为ZipEntryCompression.STORED存档条目将保持未压缩状态。

excludes

排除模式集。

filePermissions

用于配置文件访问权限的属性。详细信息请参见ConfigurableFilePermissions

includeEmptyDirs

告知空目标目录是否将包含在副本中。

includes

包含模式集。

manifest

此 JAR 存档的清单。

metadataCharset

用于编码 JAR 元数据(如文件名)的字符集。默认为 UTF-8。您可以更改此属性,但不建议这样做,因为 JVM 期望使用 UTF-8 编码 JAR 元数据

preserveFileTimestamps

指定是否应在存档中保留文件时间戳。

reproducibleFileOrder

指定从目录读取文件时是否强制执行可重现的文件顺序。

source

此任务的源文件。

webXml

web.xml要包含在 WAR 存档中的文件。当 时nullweb.xmlWAR 中不包含任何文件。

zip64

zip 是否可以包含超过 65535 个文件和/或支持大小超过 4GB 的文件。

方法

方法描述
classpath(classpath)

将文件添加到类路径以包含在 WAR 存档中。

eachFile(closure)

添加一个要在每个文件将被复制到其目标时应用的操作。给定的闭包以 aFileCopyDetails作为参数来调用。操作按照添加的顺序执行,并且继承自父规范。

eachFile(action)

添加要在每个文件即将复制到其目标时应用于该文件的操作。该操作可以更改文件的目标路径、过滤文件的内容或从结果中完全排除文件。操作按照添加的顺序执行,并且继承自父规范。

exclude(excludeSpec)

添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 FileTreeElement作为其参数传递。闭包应该返回 true 或 false。例子:

exclude(excludes)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

exclude(excludes)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

exclude(excludeSpec)

添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

expand(properties)

在复制每个文件时扩展其属性引用。更具体地说,每个文件都使用 Groovy 的SimpleTemplateEngine.这意味着您可以使用简单的属性引用,例如 文件中的$property或。${property}您还可以在文件中包含任意 Groovy 代码,例如${version ?: 'unknown'}${classpath*.name.join(' ')}

expand(properties, action)

在复制每个文件时扩展其属性引用。更具体地说,每个文件都使用 Groovy 的SimpleTemplateEngine.这意味着您可以使用简单的属性引用,例如 文件中的$property或。${property}您还可以在文件中包含任意 Groovy 代码,例如${version ?: 'unknown'}${classpath*.name.join(' ')}。可以使用提供的操作来配置模板引擎。

filesMatching(patterns, action)

FileCopyDetails为其路径与任何指定 Ant 样式模式匹配的每个文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

filesMatching(pattern, action)

FileCopyDetails为每个路径与指定 Ant 样式模式匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

filesNotMatching(patterns, action)

FileCopyDetails为每个其路径与任何指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

filesNotMatching(pattern, action)

FileCopyDetails为每个路径与指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

filter(closure)

根据提供的闭包添加内容过滤器。闭包将在每一行中被调用(go除行结尾),并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行,结果将是一个空文件,而不是缺失的文件。

filter(filterType)

添加要在复制过程中使用的内容过滤器。多次调用filter,将额外的过滤器添加到过滤器链中。每个过滤器都应该实现java.io.FilterReader.包括org.apache.tools.ant.filters.*用于访问所有标准 Ant 过滤器。

filter(properties, filterType)

添加要在复制过程中使用的内容过滤器。多次调用filter,将额外的过滤器添加到过滤器链中。每个过滤器都应该实现java.io.FilterReader.包括org.apache.tools.ant.filters.*用于访问所有标准 Ant 过滤器。

filter(transformer)

基于提供的转换器添加内容过滤器。闭包将在每一行中被调用(go除行结尾),并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行,结果将是一个空文件,而不是缺失的文件。

from(sourcePath, c)

指定副本的源文件或目录并创建子副本CopySourceSpec。给定的源路径按照 进行评估Project.files(java.lang.Object[])

from(sourcePath, configureAction)

指定副本的源文件或目录并创建子副本CopySpec。给定的源路径按照 进行评估Project.files(java.lang.Object[])

from(sourcePaths)

指定副本的源文件或目录。给定的路径按照 进行评估Project.files(java.lang.Object[])

include(includeSpec)

添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 aFileTreeElement作为其参数传递 。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要包含的包含模式或规范之一。

include(includes)

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要处理的包含模式之一。

include(includes)

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要处理的包含模式之一。

include(includeSpec)

添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要包含的包含模式或规范之一。

into(destPath)

指定文件存档*内部*的目标目录。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

into(destPath, configureClosure)

创建并配置一个子级CopySpec,其目标目录*位于*文件的存档中。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

into(destPath, copySpec)

创建并配置一个子级CopySpec,其目标目录*位于*文件的存档中。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

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)

根据正则表达式重命名文件。看CopyProcessingSpec.rename(java.lang.String, java.lang.String)

rename(renamer)

重命名源文件。该函数将使用单个参数(文件名)进行调用。该函数应返回一个新的目标名称。该函数可能返回 null,在这种情况下将使用原始名称。

webInf(configureClosure)

WEB-INF向此 WAR 存档的目录 添加一些内容。

webInf(configureAction)

WEB-INF向此 WAR 存档的目录 添加一些内容。

with(sourceSpecs)

将给定规格添加为该规格的子项。

脚本块

无脚本块

物业详情

Property<String> archiveAppendix

存档名称的附录部分(如果有)。

默认使用war插件:
""

Property<String> archiveBaseName

存档的基本名称。

默认使用war插件:
project.archivesBaseName

Property<String> archiveClassifier

存档名称的分类器部分(如果有)。

默认使用war插件:
""

Property<String> archiveExtension

存档名称的扩展部分。

Provider<RegularFile> archiveFile

RegularFile构建档案的位置。路径就是简单的destinationDirectory加号archiveFileName

默认使用war插件:
${destinationDirectory}/${archiveFileName}

Property<String> archiveFileName

档案名称。如果未显式设置名称,则名称的模式为: [archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

默认使用war插件:
${archiveBaseName}-${archiveAppendix}-${archiveVersion}-${archiveClassifier}.${archiveExtension}

Property<String> archiveVersion

存档名称的版本部分。

默认使用war插件:
project.version

boolean caseSensitive

指定是否应使用区分大小写的模式匹配。

默认使用war插件:
true

FileCollection classpath

要包含在 WAR 存档中的类路径。该类路径中的任何 JAR 或 ZIP 文件都包含在该WEB-INF/lib目录中。该类路径中的任何目录都包含在该WEB-INF/classes目录中。

默认使用war插件:
project.sourceSets.main.runtimeClasspath - project.configurations.providedRuntime

DirectoryProperty destinationDirectory

将放置存档的目录。

默认使用war插件:
project.distsDir

用于配置目录访问权限的属性。详细信息请参见ConfigurableFilePermissions

默认使用war插件:
null

DuplicatesStrategy duplicatesStrategy

尝试将多个文件复制到同一目标时使用的策略。

该值可以使用枚举值的不区分大小写的字符串来设置(例如'exclude'for 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

Set<String> excludes

排除模式集。

默认使用war插件:
[]

用于配置文件访问权限的属性。详细信息请参见ConfigurableFilePermissions

默认使用war插件:
null

boolean includeEmptyDirs

告知空目标目录是否将包含在副本中。

默认使用war插件:
true

Set<String> includes

包含模式集。

默认使用war插件:
[]

Manifest manifest

此 JAR 存档的清单。

String metadataCharset

用于编码 JAR 元数据(如文件名)的字符集。默认为 UTF-8。您可以更改此属性,但不建议这样做,因为 JVM 期望使用 UTF-8 编码 JAR 元数据

默认:
UTF-8

boolean preserveFileTimestamps

指定是否应在存档中保留文件时间戳。

如果false这可以确保归档条目在不同机器、Java 版本和操作系统之间的构建具有相同的时间。

默认使用war插件:
true

boolean reproducibleFileOrder

指定从目录读取文件时是否强制执行可重现的文件顺序。

然后,Gradle 将以独立于文件系统和操作系统的可重现顺序遍历磁盘上的目录,这些目录是此存档的一部分。这有助于 Gradle 可靠地生成逐字节可重现的存档。

默认使用war插件:
false

FileCollection source(只读)

此任务的源文件。

File webXml

web.xml要包含在 WAR 存档中的文件。当 时nullweb.xmlWAR 中不包含任何文件。

默认使用war插件:
null

boolean zip64

zip 是否可以包含超过 65535 个文件和/或支持大小超过 4GB 的文件。

标准 zip 格式对文件大小和数量有严格限制。Zip64 格式扩展实际上 消除了这些限制,因此是构建大型 zip 所必需的。

但是,并非所有 Zip 阅读器都支持 Zip64 扩展。值得注意的是,ZipInputStream对于 Java 7 之前的版本,JDK 类不支持 Zip64。这意味着,如果您正在构建与 Java 6 及更早运行时一起使用的 JAR,则不应启用此属性。

默认:
false

方法详情

void classpathObject...类路径)

将文件添加到类路径以包含在 WAR 存档中。

AbstractCopyTask eachFileClosure关闭)

添加一个要在每个文件将被复制到其目标时应用的操作。给定的闭包以 aFileCopyDetails作为参数来调用。操作按照添加的顺序执行,并且继承自父规范。

AbstractCopyTask eachFile(行动)Action<? super FileCopyDetails>

添加要在每个文件即将复制到其目标时应用于该文件的操作。该操作可以更改文件的目标路径、过滤文件的内容或从结果中完全排除文件。操作按照添加的顺序执行,并且继承自父规范。

AbstractCopyTask excludeClosure不包括规格)

添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 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>

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

AbstractCopyTask excludeString...不包括)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

AbstractCopyTask exclude(不包括规格)Spec<FileTreeElement>

添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

AbstractCopyTask expand(特性)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, ?>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>Action<? super FileCopyDetails>

FileCopyDetails为其路径与任何指定 Ant 样式模式匹配的每个文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

AbstractCopyTask filesMatchingString模式、动作)Action<? super FileCopyDetails>

FileCopyDetails为每个路径与指定 Ant 样式模式匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

AbstractCopyTask filesNotMatching(模式、动作)Iterable<String>Action<? super FileCopyDetails>

FileCopyDetails为每个其路径与任何指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

AbstractCopyTask filesNotMatchingString模式、动作)Action<? super FileCopyDetails>

FileCopyDetails为每个路径与指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

AbstractCopyTask filterClosure关闭)

根据提供的闭包添加内容过滤器。闭包将在每一行中被调用(go除行结尾),并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行,结果将是一个空文件,而不是缺失的文件。

AbstractCopyTask filter(过滤器类型)Class<? extends FilterReader>

添加要在复制过程中使用的内容过滤器。多次调用filter,将额外的过滤器添加到过滤器链中。每个过滤器都应该实现java.io.FilterReader.包括org.apache.tools.ant.filters.*用于访问所有标准 Ant 过滤器。

例子:

filter(StripJavaComments)
filter(com.mycompany.project.CustomFilter)

AbstractCopyTask filter(属性,过滤器类型)Map<String, ?>Class<? extends FilterReader>

添加要在复制过程中使用的内容过滤器。多次调用filter,将额外的过滤器添加到过滤器链中。每个过滤器都应该实现java.io.FilterReader.包括org.apache.tools.ant.filters.*用于访问所有标准 Ant 过滤器。

过滤器属性可以使用常规映射语法来指定。

例子:

filter(HeadFilter, lines:25, skip:2)
filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])

AbstractCopyTask filter(变压器)Transformer<String, String>

基于提供的转换器添加内容过滤器。闭包将在每一行中被调用(go除行结尾),并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行,结果将是一个空文件,而不是缺失的文件。

AbstractCopyTask fromObject源路径,Closurec)

指定副本的源文件或目录并创建子副本CopySourceSpec。给定的源路径按照 进行评估Project.files(java.lang.Object[])

AbstractCopyTask fromObject源路径、配置操作)Action<? super CopySpec>

指定副本的源文件或目录并创建子副本CopySpec。给定的源路径按照 进行评估Project.files(java.lang.Object[])

AbstractCopyTask fromObject...源路径)

指定副本的源文件或目录。给定的路径按照 进行评估Project.files(java.lang.Object[])

AbstractCopyTask includeClosure包括规格)

添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 aFileTreeElement作为其参数传递 。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要包含的包含模式或规范之一。

AbstractCopyTask include(包括)Iterable<String>

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要处理的包含模式之一。

AbstractCopyTask includeString...包括)

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要处理的包含模式之一。

AbstractCopyTask include(包括规格)Spec<FileTreeElement>

添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含,则将包含此容器中的所有文件。如果提供了包含,则文件必须至少匹配要包含的包含模式或规范之一。

AbstractArchiveTask intoObject目标路径)

指定文件存档*内部*的目标目录。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

AbstractArchiveTask intoObject目标路径,ClosureconfigureClosure)

创建并配置一个子级CopySpec,其目标目录*位于*文件的存档中。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

CopySpec intoObject目标路径,复制规范)Action<? super CopySpec>

创建并配置一个子级CopySpec,其目标目录*位于*文件的存档中。目的地按照 进行评估Project.file(java.lang.Object)。不要将它与AbstractArchiveTask.getDestinationDirectory()指定存档的输出目录混淆。

Jar manifestClosure<?>配置关闭)

配置此 JAR 存档的清单。

执行给定的闭包来配置清单。作为其委托传递Manifest给闭包。

Jar manifest(配置动作)Action<? super Manifest>

配置此 JAR 存档的清单。

执行给定的操作来配置清单。

CopySpec metaInfClosure<?>配置关闭)

将内容添加到此 JAR 存档的 META-INF 目录。

执行给定的闭包来配置CopySpec.作为其委托传递CopySpec给闭包。

CopySpec metaInf(配置动作)Action<? super CopySpec>

将内容添加到此 JAR 存档的 META-INF 目录。

执行给定的操作来配置CopySpec.

AbstractCopyTask renameClosure关闭)

重命名源文件。将使用单个参数(文件名)调用闭包。闭包应该返回一个带有新目标名称的 String 对象。闭包可能返回 null,在这种情况下将使用原始名称。

AbstractCopyTask renameString源正则表达式,StringreplaceWith)

根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意,替换字符串应使用“$1”语法来引用源正则表达式中的捕获组。与源正则表达式不匹配的文件将使用原始名称进行复制。

例子:

rename '(.*)_OEM_BLUE_(.*)', '$1$2'

会将文件“style_OEM_BLUE_.css”映射到“style.css”

AbstractCopyTask renamePattern源正则表达式,StringreplaceWith)

根据正则表达式重命名文件。看CopyProcessingSpec.rename(java.lang.String, java.lang.String)

AbstractCopyTask rename(重命名)Transformer<String, String>

重命名源文件。该函数将使用单个参数(文件名)进行调用。该函数应返回一个新的目标名称。该函数可能返回 null,在这种情况下将使用原始名称。

CopySpec webInfClosure配置关闭)

WEB-INF向此 WAR 存档的目录 添加一些内容。

执行给定的闭包来配置CopySpec.作为其委托传递CopySpec给闭包。

CopySpec webInf(配置动作)Action<? super CopySpec>

WEB-INF向此 WAR 存档的目录 添加一些内容。

执行给定的操作来配置CopySpec.

CopySpec withCopySpec...来源规格)

将给定规格添加为该规格的子项。

def contentSpec = copySpec {
  from("content") {
    include "**/*.txt"
  }
}

task copy(type: Copy) {
  into "$buildDir/copy"
  with contentSpec
}