packer-ng-plugin｜下一代安卓打包工具

packer-ng-plugin 是下一代Android渠道打包工具Gradle插件，支持极速打包， 1000 个渠道包只需要 5 秒钟，速度是 gradle-packer-plugin 的 1000 倍以上，可方便的用于CI系统集成，支持自定义输出目录和最终APK文件名，依赖包： com.mcxiaoke.gradle:packer-ng:1.0.+ 简短名： packer ，可以在项目的 build.gradle 中指定使用，还提供了命令行独立使用的Java和Python脚本。

实现原理

PackerNg原理

优点

• 使用APK注释字段保存渠道信息和MAGIC字节，从文件末尾读取渠道信息，速度快

• 实现为一个Gradle Plugin，支持定制输出APK的文件名等信息，方便CI集成

• 提供Java版和Python的独立命令行脚本，不依赖Gradle插件，支持独立使用

• 由于打包速度极快，单个包只需要5毫秒左右，可用于网站后台动态生成渠道包

缺点

• 没有使用Android的productFlavors，无法利用flavors条件编译的功能

文件格式

Android应用使用的APK文件就是一个带签名信息的ZIP文件，根据 ZIP文件格式规范 ，每个ZIP文件的最后都必须有一个叫 Central Directory Record 的部分，这个CDR的最后部分叫"end of central directory record"，这一部分包含一些元数据，它的末尾是ZIP文件的注释。注释包含 Comment Length 和 File Comment 两个字段，前者表示注释内容的长度，后者是注释的内容，正确修改这一部分不会对ZIP文件造成破坏，利用这个字段，我们可以添加一些自定义的数据，PackerNg项目就是在这里添加和读取渠道信息。

细节处理

原理很简单，就是将渠道信息存放在APK文件的注释字段中，但是实现起来遇到不少坑，测试了好多次。

ZipOutputStream.setComment

FileOutputStream is = new FileOutputStream("demo.apk", true);ZipOutputStream zos = new ZipOutputStream(is); zos.setComment("Google_Market"); zos.finish(); zos.close();ZipFile zipFile=new ZipFile("demo.apk");System.out.println(zipFile.getComment());

使用Java写入APK文件注释虽然可以正常读取，但是安装的时候会失败，错误信息是：

adb install -r demo.apk Failure [INSTALL_FAILED_INVALID_APK]

原因未知，可能Java的Zip实现写入了某些特殊字符导致APK文件校验失败，于是只能放弃这个方法。同样的功能使用Python测试完全没有问题，处理后的APK可以正常安装。

ZipFile.getComment

上面是ZIP文件注释写入，使用Java会导致APK文件被破坏，无法安装。这里是读取ZIP文件注释的问题，Java 7里可以使用 zipFile.getComment() 方法直接读取注释，非常方便。但是Android系统直到API 19，也就是4.4以上的版本才支持 ZipFile.getComment() 方法。由于要兼容之前的版本，所以这个方法也不能使用。

解决方法

由于使用Java直接写入和读取ZIP文件的注释都不可行，使用Python又不方便与Gradle系统集成，所以只能自己实现注释的写入和读取。 实现起来也不复杂，就是为了提高性能，避免读取整个文件，需要在注释的最后加入几个MAGIC字节，这样从文件的最后开始，读取很少的几个字节就可以定位 渠道名的位置。

几个常量定义：

// ZIP文件的注释最长65535个字节 static final int ZIP_COMMENT_MAX_LENGTH = 65535; // ZIP文件注释长度字段的字节数 static final int SHORT_LENGTH = 2; // 文件最后用于定位的MAGIC字节 static final byte[] MAGIC = new byte[]{0x21, 0x5a, 0x58, 0x4b, 0x21}; //!ZXK!

读写注释

Java版详细的实现见 PackerNg.java ，Python版的实现见 ngpacker.py 。

写入ZIP文件注释：

public static void writeZipComment(File file, String comment)  throws IOException {     byte[] data = comment.getBytes(UTF_8);     final RandomAccessFile raf = new RandomAccessFile(file, "rw");     raf.seek(file.length() - SHORT_LENGTH);     // write zip comment length     // (content field length + length field length + magic field length)     writeShort(data.length + SHORT_LENGTH + MAGIC.length, raf);     // write content     writeBytes(data, raf);     // write content length     writeShort(data.length, raf);     // write magic bytes     writeBytes(MAGIC, raf);     raf.close(); }

读取ZIP文件注释，有两个版本的实现，这里使用的是 RandomAccessFile ，另一个版本使用的是 MappedByteBuffer ，经过测试，对于特别长的注释，使用内存映射文件读取性能要稍微好一些，对于特别短的注释（比如渠道名），这个版本反而更快一些。

public static String readZipComment(File file) throws IOException {     RandomAccessFile raf = null;     try {         raf = new RandomAccessFile(file, "r");         long index = raf.length();         byte[] buffer = new byte[MAGIC.length];         index -= MAGIC.length;         // read magic bytes         raf.seek(index);         raf.readFully(buffer);         // if magic bytes matched         if (isMagicMatched(buffer)) {             index -= SHORT_LENGTH;             raf.seek(index);             // read content length field             int length = readShort(raf);             if (length > 0) {                 index -= length;                 raf.seek(index);                 // read content bytes                 byte[] bytesComment = new byte[length];                 raf.readFully(bytesComment);                 return new String(bytesComment, UTF_8);             }         }     } finally {         if (raf != null) {             raf.close();         }     }     return null; }

读取APK文件，由于这个库 packer-helper 需要同时给Gradle插件和Android项目使用，所以不能添加Android相关的依赖，但是又需要读取自身APK文件的路径，使用反射实现：

// for android code private static String getSourceDir(final Object context)         throws ClassNotFoundException,         InvocationTargetException,         IllegalAccessException,         NoSuchFieldException,         NoSuchMethodException {     final Class<?> contextClass = Class.forName("android.content.Context");     final Class<?> applicationInfoClass = Class.forName("android.content.pm.ApplicationInfo");     final Method getApplicationInfoMethod = contextClass.getMethod("getApplicationInfo");     final Object appInfo = getApplicationInfoMethod.invoke(context);     final Field sourceDirField = applicationInfoClass.getField("sourceDir");     return (String) sourceDirField.get(appInfo); }

Gradle Plugin

这个和旧版插件基本一致，首先是读取渠道列表文件，保存起来，打包的时候遍历列表，复制生成的APK文件到临时文件，给临时文件写入渠道信息，然后复制到输出目录，文件名可以使用模板定制。主要代码如下：

// 添加打包用的TASK def archiveTask = project.task("apk${variant.name.capitalize()}",                 type: ArchiveAllApkTask) {             theVariant = variant             theExtension = modifierExtension             theMarkets = markets             dependsOn variant.assemble         }         def buildTypeName = variant.buildType.name         if (variant.name != buildTypeName) {             project.task("apk${buildTypeName.capitalize()}", dependsOn: archiveTask)         }   // 遍历列表修改APK文件 theMarkets.each { String market ->             String apkName = buildApkName(theVariant, market)             File tempFile = new File(tempDir, apkName)             File finalFile = new File(outputDir, apkName)             tempFile << originalFile.bytes             copyTo(originalFile, tempFile)             PackerNg.Helper.writeMarket(tempFile, market)             if (PackerNg.Helper.verifyMarket(tempFile, market)) {                 copyTo(tempFile, finalFile)             }          }

详细的实现可以查看文件 PackerNgPlugin.groovy 和文件 ArchiveAllApkTask.groovy