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归档文件的清单。

metadataCharset

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

preserveFileTimestamps

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

reproducibleFileOrder

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

source

此任务的源文件。

zip64

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

方法

方法描述
eachFile(closure)

添加一个操作，该操作将在每个文件即将复制到其目的地时应用。给定的闭包以FileCopyDetails作为参数被调用。操作按添加顺序执行，并从父规范继承。

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

基于提供的闭包添加内容过滤器。闭包将用每行（去除行尾）调用，并应返回一个字符串替换该行或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)

添加基于提供的转换器的内容过滤器。闭包将用每一行（去除行尾）调用，并应返回一个字符串替换该行或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)

添加一个包含规范。此方法可以多次调用以添加新的规范。给定的闭包将FileTreeElement作为其参数。如果未提供包含模式，则此容器中的所有文件都将包含。如果提供了包含模式，则文件必须至少匹配其中一个包含模式或规范才能包含。

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)

重命名源文件。闭包将使用单个参数，即文件名。闭包应返回一个带有新目标名称的字符串对象。闭包可以返回null，在这种情况下将使用原始名称。

rename(sourceRegEx, replaceWith)

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

rename(sourceRegEx, replaceWith)

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

rename(renamer)

重命名源文件。该函数将使用单个参数，即文件名。该函数应返回一个新的目标名称。该函数可以返回null，在这种情况下将使用原始名称。

with(sourceSpecs)

将给定规范作为此规范的子级添加。

脚本块

无脚本块

属性详情

Property<String> archiveAppendix

归档名称的附录部分（如果有）。

默认与java插件一起使用
""

Property<String> archiveBaseName

归档的基本名称。

默认与java插件一起使用
project.base.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归档文件的清单。

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扩展。值得注意的是，JDK类ZipInputStream在Java 7之前的版本中不支持Zip64。这意味着如果你正在构建用于Java 6及更早运行时环境的JAR，则不应启用此属性。

默认值
false

方法详情

AbstractCopyTask eachFile(Closure closure)

添加一个操作，该操作将在每个文件即将复制到其目的地时应用。给定的闭包以FileCopyDetails作为参数被调用。操作按添加顺序执行，并从父规范继承。

AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)

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

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)

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

AbstractCopyTask exclude(String... excludes)

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

AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件必须不匹配任何排除模式才能进行处理。

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)

基于提供的闭包添加内容过滤器。闭包将用每行（去除行尾）调用，并应返回一个字符串替换该行或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映射语法指定过滤器属性。

示例

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

添加基于提供的转换器的内容过滤器。闭包将用每一行（去除行尾）调用，并应返回一个字符串替换该行或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)

添加一个包含规范。此方法可以多次调用以添加新的规范。给定的闭包将FileTreeElement作为其参数。如果未提供包含模式，则此容器中的所有文件都将包含。如果提供了包含模式，则文件必须至少匹配其中一个包含模式或规范才能包含。

AbstractCopyTask include(Iterable<String> includes)

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

AbstractCopyTask include(String... includes)

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

AbstractCopyTask include(Spec<FileTreeElement> includeSpec)

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

指定文件中归档文件*内部*的目标目录。目标按照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作为其委托传递给闭包。

Jar manifest(Action<? super Manifest> configureAction)

配置此JAR归档文件的清单。

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

CopySpec metaInf(Closure<?> configureClosure)

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

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

CopySpec metaInf(Action<? super CopySpec> configureAction)

将内容添加到此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)。

重命名源文件。该函数将使用单个参数，即文件名。该函数应返回一个新的目标名称。该函数可以返回null，在这种情况下将使用原始名称。

CopySpec with(CopySpec... sourceSpecs)

将给定规范作为此规范的子级添加。

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

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