Jar

API 文档Jar
已知子类型
Jar

构建一个 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

用于编码 ZIP 元数据(如文件名)的字符集。默认为平台的默认字符集。

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 的内容过滤器。Closure 将以每一行(已去除行尾符)作为参数调用,并应返回一个 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)

将给定的 spec 添加为此 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

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

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

用于编码 ZIP 元数据(如文件名)的字符集。默认为平台的默认字符集。

默认值
平台默认编码

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 扩展。值得注意的是,Java 开发工具包 (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 }
}

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

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 的内容过滤器。Closure 将以每一行(已去除行尾符)作为参数调用,并应返回一个 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 目录添加内容。

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

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)

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

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

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