Android Gradle 插件自定义 Gradle 任务 ⑮ ( Gradle 自带 Zip 任务使用 | Zip 任务简介 | 代码示例 )

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件自定义 Gradle 任务 ⑮ ( Gradle 自带 Zip 任务使用 | Zip 任务简介 | 代码示例 )相关的知识，希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、org.gradle.api.tasks.bundling.Zip 任务简介


org.gradle.api.tasks.bundling.Zip 自带任务 ( 任务类型 ) 文档 :https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Zip.html


org.gradle.api.tasks.bundling.Zip 自带任务 用于 对 目录 或 文件 进行 zip 格式的压缩 ,

org.gradle.api.tasks.bundling.Zip 原型如下 :

public class Zip extends AbstractArchiveTask

org.gradle.api.tasks.bundling.Zip 类继承了 org.gradle.api.tasks.bundling.AbstractArchiveTask 类 ;

org.gradle.api.tasks.bundling.AbstractArchiveTask 类 原型如下 : 其中

  • AbstractArchiveTask#archiveName 成员是 压缩包的名称 , 通过 AbstractArchiveTask#setArchiveName 函数 进行设置 ;
  • AbstractArchiveTask#archiveDestinationDirectory 是压缩包输出目录 , 通过 AbstractArchiveTask#setDestinationDir 函数进行设置 ;
  • AbstractArchiveTask#from 函数 的作用是指定被打包的目录或者文件 ;

特别注意 : 设置的 被压缩的目录或文件 , 压缩包的输出目录 , 尽量是 build 目录下 , 也就是 "$buildDir/" 目录下 ;

public abstract class AbstractArchiveTask extends AbstractCopyTask 
    private final DirectoryProperty archiveDestinationDirectory;
    private final RegularFileProperty archiveFile;
    private final Property<String> archiveName;
    private final Property<String> archiveBaseName;
    private final Property<String> archiveAppendix;
    private final Property<String> archiveVersion;
    private final Property<String> archiveExtension;
    private final Property<String> archiveClassifier;
    private final Property<Boolean> archivePreserveFileTimestamps;
    private final Property<Boolean> archiveReproducibleFileOrder;

    /** @deprecated */
    @Deprecated
    public void setArchiveName(String name) 
        ((DeprecateProperty)DeprecationLogger.deprecateProperty(AbstractArchiveTask.class, "archiveName").replaceWith("archiveFileName")).willBeRemovedInGradle7().withDslReference().nagUser();
        this.archiveName.convention(name);
        this.archiveName.set(name);
    

    /** @deprecated */
    @Deprecated
    public void setDestinationDir(File destinationDir) 
        ((DeprecateProperty)DeprecationLogger.deprecateProperty(AbstractArchiveTask.class, "destinationDir").replaceWith("destinationDirectory")).willBeRemovedInGradle7().withDslReference().nagUser();
        this.archiveDestinationDirectory.set(this.getProject().file(destinationDir));
    

    public AbstractCopyTask from(Object... sourcePaths) 
        this.getMainSpec().from(sourcePaths);
        return this;




二、Zip 任务代码示例


Zip 任务代码示例 : 该任务定义在了 根目录下的 build.gradle 构建脚本中 ;

task zip(type: Zip)
    // 设置输出压缩包名称
    archiveName 'logs.zip'
    // 设置输出目录
    destinationDir file("$buildDir/myZip")

    // 将根目录下的 gradle 目录进行 zip 打包
    from "$buildDir/outputs/logs"

以上是关于Android Gradle 插件自定义 Gradle 任务 ⑮ ( Gradle 自带 Zip 任务使用 | Zip 任务简介 | 代码示例 )的主要内容，如果未能解决你的问题，请参考以下文章

Android之Gradle的理解

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑤ ( 自定义插件中获定义方法 | 在插件中创建 Gradle 任务 | 代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑦ ( 自定义 Gradle 插件导入方式 | buildSrc 插件导入 | 构建脚本中自定义插件 | 独立文件 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑦ ( 自定义 Gradle 插件导入方式 | buildSrc 插件导入 | 构建脚本中自定义插件 | 独立文件 )

Android Gradle 插件自定义 Gradle 插件模块 ② ( 在模块中定义插件 | 引入自定义 Gradle 插件模块 | 配置 Gradle 插件上传选项 | 配置分组名称版本号 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ④ ( 为自定义 Gradle 插件的扩展配置扩展 | 在自定义插件中获取扩展属性 )