Jar

API 文档Jar
已知子类型
Ear
War

组装一个 JAR 归档文件。

属性

属性描述
archiveAppendix

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

archiveBaseName

归档文件的基本名称。

archiveClassifier

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

archiveExtension

归档名称的扩展名部分。

archiveFile

构建归档文件的 RegularFile。路径即为 destinationDirectory 加上 archiveFileName

archiveFileName

归档文件名称。如果名称未明确设置,则名称模式为:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

archiveVersion

归档名称的版本部分。

caseSensitive

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

destinationDirectory

归档文件将放置的目录。

dirPermissions

用于查询和配置目录访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

duplicatesStrategy

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

entryCompression

归档条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED(默认值),则使用 DEFLATE 算法压缩每个条目。如果设置为 ZipEntryCompression.STORED,则归档中的条目将不压缩。

excludes

排除模式的集合。

filePermissions

用于查询和配置文件访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

includeEmptyDirs

指示复制时是否包含空的目标目录。

includes

包含模式的集合。

manifest

此 JAR 归档文件的 manifest。

metadataCharset

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

preserveFileTimestamps

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

reproducibleFileOrder

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

source

此任务的源文件。

zip64

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

方法

方法描述
eachFile(closure)

添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。提供的 closure 将以 FileCopyDetails 作为参数调用。操作按照添加顺序执行,并继承自父 spec。

eachFile(action)

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

exclude(excludeSpec)

添加一个排除 spec。此方法可以多次调用以附加新的 spec。提供的 closure 将以 FileTreeElement 作为参数传入。closure 应返回 true 或 false。示例

exclude(excludes)

添加一个 ANT 风格的排除模式。此方法可以多次调用以附加新的模式,并且可以在一次调用中指定多个模式。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

exclude(excludes)

添加一个 ANT 风格的排除模式。此方法可以多次调用以附加新的模式,并且可以在一次调用中指定多个模式。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

exclude(excludeSpec)

添加一个排除 spec。此方法可以多次调用以附加新的 spec。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

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(' ')}。模板引擎可以通过提供的 action 进行配置。

filesMatching(patterns, action)

为路径匹配指定 Ant 风格模式之一的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

filesMatching(pattern, action)

为路径匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

filesNotMatching(patterns, action)

为路径不匹配指定 Ant 风格模式之一的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

filesNotMatching(pattern, action)

为路径不匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

filter(closure)

添加一个基于提供的 closure 的内容过滤器。Closure 将以每行(剥去行尾符)作为参数调用,应返回一个 String 来替换该行,或返回 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)

添加一个基于提供的 transformer 的内容过滤器。Transformer 将以每行(剥去行尾符)作为参数调用,应返回一个 String 来替换该行,或返回 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)

添加一个包含 spec。此方法可以多次调用以附加新的 spec。提供的 closure 将以 FileTreeElement 作为参数传入。如果没有提供 includes,则此容器中的所有文件都将被包含。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。

include(includes)

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

include(includes)

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

include(includeSpec)

添加一个包含 spec。此方法可以多次调用以附加新的 spec。如果没有提供 includes,则此容器中的所有文件都将被包含。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。

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。

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)

基于正则表达式重命名文件。请参阅 CopyProcessingSpec.rename(java.lang.String, java.lang.String)

rename(renamer)

重命名源文件。函数将以文件名作为唯一参数调用。函数应返回一个新的目标名称。函数可能返回 null,在这种情况下将使用原始名称。

with(sourceSpecs)

将给定的 specs 添加为此 spec 的子项。

脚本块

无脚本块

属性详情

Property<String> archiveAppendix

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

使用 java 插件时的默认值
""

Property<String> archiveBaseName

归档文件的基本名称。

使用 java 插件时的默认值
project.archivesBaseName

Property<String> archiveClassifier

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

使用 java 插件时的默认值
""

Property<String> archiveExtension

归档名称的扩展名部分。

Provider<RegularFile> archiveFile

构建归档文件的 RegularFile。路径即为 destinationDirectory 加上 archiveFileName

使用 java 插件时的默认值
${destinationDirectory}/${archiveFileName}

Property<String> archiveFileName

归档文件名称。如果名称未明确设置,则名称模式为:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

使用 java 插件时的默认值
${archiveBaseName}-${archiveAppendix}-${archiveVersion}-${archiveClassifier}.${archiveExtension}

Property<String> archiveVersion

归档名称的版本部分。

使用 java 插件时的默认值
project.version

boolean caseSensitive

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

使用 java 插件时的默认值
true

DirectoryProperty destinationDirectory

归档文件将放置的目录。

使用 java 插件时的默认值
project.distsDir

用于查询和配置目录访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

使用 java 插件时的默认值
null

DuplicatesStrategy duplicatesStrategy

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

该值可以使用枚举值的字符串(不区分大小写)来设置(例如,DuplicatesStrategy.EXCLUDE 对应 'exclude')。

此策略可以通过使用 CopySpec.eachFile(org.gradle.api.Action)CopySpec.filesMatching(java.lang.String, org.gradle.api.Action) 对单个文件进行覆盖。

使用 java 插件时的默认值
DuplicatesStrategy.INHERIT

ZipEntryCompression entryCompression

归档条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED(默认值),则使用 DEFLATE 算法压缩每个条目。如果设置为 ZipEntryCompression.STORED,则归档中的条目将不压缩。

默认值
ZipEntryCompression.DEFLATED

Set<String> excludes

排除模式的集合。

使用 java 插件时的默认值
[]

用于查询和配置文件访问权限的属性。如果该属性未设置值,则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详情请参阅 ConfigurableFilePermissions

使用 java 插件时的默认值
null

boolean includeEmptyDirs

指示复制时是否包含空的目标目录。

使用 java 插件时的默认值
true

Set<String> includes

包含模式的集合。

使用 java 插件时的默认值
[]

Manifest manifest

此 JAR 归档文件的 manifest。

String metadataCharset

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

默认值
UTF-8

boolean preserveFileTimestamps

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

如果设置为 false,则确保在不同机器、Java 版本和操作系统之间构建时,归档条目具有相同的时间戳。

使用 java 插件时的默认值
true

boolean reproducibleFileOrder

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

Gradle 将以独立于文件系统和操作系统的可重现顺序遍历磁盘上属于此归档文件的目录。这有助于 Gradle 可靠地生成字节级可重现的归档文件。

使用 java 插件时的默认值
false

FileCollection source (只读)

此任务的源文件。

使用 java 插件时的默认值
[]

boolean zip64

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

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

然而,并非所有 Zip 读取器都支持 Zip64 扩展。值得注意的是,JDK 中的 ZipInputStream 类在 Java 7 之前的版本中不支持 Zip64。这意味着如果您正在构建用于 Java 6 及更早运行时环境的 JAR 文件,则不应启用此属性。

默认值
false

方法详情

AbstractCopyTask eachFile(Closure closure)

添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。提供的 closure 将以 FileCopyDetails 作为参数调用。操作按照添加顺序执行,并继承自父 spec。

AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)

添加一个操作,该操作将在每个文件即将复制到其目标位置时应用。此操作可以更改文件的目标路径、过滤文件的内容,或将文件完全从结果中排除。操作按照添加顺序执行,并继承自父 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 }
}

如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(Iterable<String> excludes)

添加一个 ANT 风格的排除模式。此方法可以多次调用以附加新的模式,并且可以在一次调用中指定多个模式。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(String... excludes)

添加一个 ANT 风格的排除模式。此方法可以多次调用以附加新的模式,并且可以在一次调用中指定多个模式。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)

添加一个排除 spec。此方法可以多次调用以附加新的 spec。如果没有提供 excludes,则不会排除任何文件。如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

AbstractCopyTask expand(Map<String, ?> properties)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 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)

在复制每个文件时展开文件中的属性引用。更具体地说,每个文件都使用 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)

为路径匹配指定 Ant 风格模式之一的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

AbstractCopyTask filesMatching(String pattern, Action<? super FileCopyDetails> action)

为路径匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

AbstractCopyTask filesNotMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

为路径不匹配指定 Ant 风格模式之一的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

AbstractCopyTask filesNotMatching(String pattern, Action<? super FileCopyDetails> action)

为路径不匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

AbstractCopyTask filter(Closure closure)

添加一个基于提供的 closure 的内容过滤器。Closure 将以每行(剥去行尾符)作为参数调用,应返回一个 String 来替换该行,或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是一个不存在的文件。

AbstractCopyTask filter(Class<? extends FilterReader> filterType)

添加一个内容过滤器,用于复制期间。多次调用 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)

添加一个内容过滤器,用于复制期间。多次调用 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'])

添加一个基于提供的 transformer 的内容过滤器。Transformer 将以每行(剥去行尾符)作为参数调用,应返回一个 String 来替换该行,或返回 null 来删除该行。如果删除了所有行,结果将是一个空文件,而不是一个不存在的文件。

AbstractCopyTask from(Object sourcePath, Closure c)

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

AbstractCopyTask from(Object sourcePath, Action<? super CopySpec> configureAction)

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

AbstractCopyTask from(Object... sourcePaths)

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

AbstractCopyTask include(Closure includeSpec)

添加一个包含 spec。此方法可以多次调用以附加新的 spec。提供的 closure 将以 FileTreeElement 作为参数传入。如果没有提供 includes,则此容器中的所有文件都将被包含。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。

AbstractCopyTask include(Iterable<String> includes)

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

AbstractCopyTask include(String... includes)

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

AbstractCopyTask include(Spec<FileTreeElement> includeSpec)

添加一个包含 spec。此方法可以多次调用以附加新的 spec。如果没有提供 includes,则此容器中的所有文件都将被包含。如果提供了 includes,则文件必须至少匹配一个包含模式或 spec 才能被包含。

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

AbstractArchiveTask into(Object destPath, Closure configureClosure)

创建一个子 CopySpec 并为其配置文件在归档文件 *内部* 的目标目录。目标位置按照 Project.file(java.lang.Object) 进行评估。不要与指定归档文件输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

CopySpec into(Object destPath, Action<? super CopySpec> copySpec)

创建一个子 CopySpec 并为其配置文件在归档文件 *内部* 的目标目录。目标位置按照 Project.file(java.lang.Object) 进行评估。不要与指定归档文件输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

Jar manifest(Closure<?> configureClosure)

配置此 JAR 归档文件的 manifest。

给定的闭包用于配置 manifest。 Manifest 会作为其委托对象传递给闭包。

Jar manifest(Action<? super Manifest> configureAction)

配置此 JAR 归档文件的 manifest。

给定的 action 用于配置 manifest。

CopySpec metaInf(Closure<?> configureClosure)

向此 JAR 归档文件的 META-INF 目录添加内容。

给定的闭包用于配置一个 CopySpecCopySpec 会作为其委托对象传递给闭包。

CopySpec metaInf(Action<? super CopySpec> configureAction)

向此 JAR 归档文件的 META-INF 目录添加内容。

给定的 action 用于配置一个 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)

重命名源文件。函数将以文件名作为唯一参数调用。函数应返回一个新的目标名称。函数可能返回 null,在这种情况下将使用原始名称。

CopySpec with(CopySpec... sourceSpecs)

将给定的 specs 添加为此 spec 的子项。

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

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