Android打包工具packer-ng-plugin的使用 快速生成渠道包

简介:该工具快速生成渠道包。它可以将一个包快速生成多个渠道包

github地址 : https://github.com/mcxiaoke/packer-ng-plugin

使用场景:

安卓app上线,需要创建各个市场和推广渠道的apk安装包。每个安装包携带对应的渠道信息。

基本所有安卓项目需要创建渠道包,而且上线时间越长,推广渠道会越来越多,时有更新,同时可能还会有创建马甲包的需求。在实际中一次上线可能会创建数十个渠道包。所以使用一套方便、稳定的打包流程,是非常有必要的。尤其体现在打包时间,安装包稳定性方面。

创建多渠道方法:

方案一:在安卓项目studio编译器gradle文件中配置flavors.根据 flavors信息给每个apk包配置对应的渠道信息。生成Apk包再进行加固和签名,这种方法是在编译期将渠道文件写在buildconfig文件中,不受加固影响。但是它需要studio编译器生成N个渠道包,再将N个渠道包加固。studio和加固工具都不适合一次性处理过多apk文件,所以需要分批处理,这就会导致手动操作频繁和工作时间过长,容易出错也耗时过多。

方案二:使用打包工具(packer-ng-plugin)生成渠道包。先由studio编译器生成release包,再用360加固宝加固(不使用它的自动签名和签名校验),然后进行签名和验证,最后由该工具生成N个渠道包。这种流程单 一 ,始终是操作一个apk文件,相比方案一更好。无论是操作流程还是打包时间都是占有绝对优势的。

如何使用该工具?

进入github地址 : https://github.com/mcxiaoke/packer-ng-plugin

步骤一:在android项目中集成读取渠道的库。

修改项目配置

// build.gradle
buildscript {
    dependencies{
        classpath 'com.mcxiaoke.packer-ng:plugin:2.0.1'
    }
}

修改模块配置

apply plugin: 'packer'
// build.gradle
dependencies {
    compile 'com.mcxiaoke.packer-ng:helper:2.0.1'
}

步骤二:生成渠道包。

该库提供了多种方法生成渠道包,一种是在Gradle中生成,另一种是使用脚本打包工具packer-ng-2.0.1.jar来创建渠道包。由于安卓apk需加固,加固后会破坏渠道信息,所以实际中都是将加固后的apk文件再添加渠道信息。所以个人认为通过gradle来创建渠道包是不合适的,这就需要选择脚本打包工具来实现打包。这里,我就只讲脚本打包工具的使用。

鉴于安卓apk都需要加固的情况,同时现有的加固工具(我用的是360加固宝)会破坏签名文件,会让渠道信息丢失;加固Apk的过程也是需要时间的,尤其是加固数十个apk的时候,其加固时间是不可忽视。

 

2.1 脚本打包

项目提供的Java脚本打包,Jar位于本项目的 tools 目录,请使用最新版,以下用 packer-ng 指代 java -jar tools/packer-ng-2.0.1.jar,下面是几个示例。

  • 参数说明:
packer-ng - 表示 java -jar packer-ng-2.0.1.jar
channels.txt - 替换成你的渠道列表文件的实际路径
build/archives - 替换成你指定的渠道包的输出路径
app.apk - 替换成你要打渠道包的APK文件的实际路径

运行cmd程序,进入该工具的目录下,并将已经加固好的Apk放至该目录,然后执行下面的命令(下面使用的是相对路径,自己根据实际需要来编写对应的命令)。

  • 直接指定渠道列表打包:

packer-ng generate --channels=ch1,ch2,ch3 --output=build/archives app.apk
  • 指定渠道列表文件打包:
packer-ng generate --channels=@channels.txt --output=build/archives app.apk

上述命令都是相对路径,也可以写绝对路径,如下:

例:  java -jar packer-ng-2.0.1.jar generate --channels=@D:\channelsFile\channels.txt --output=D:\ouputApk D:\apk\app.apk

效果都是一样的。

channels.txt的内容示例如下:

备注:

     1.上述两行是实际打包中所需要用的最关键的两条语句。channels后面指定了多少个渠道信息,就会打多少个渠道包。以--channels=ch1,ch2,ch3为例表示需要打三个包,对应的Apk识别到的渠道信息分别就是ch1 ch2 ch3. 而--channels=@channels.txt表示会读取channels.txt的渠道信息,以换行符为分隔,每一行的字符串就是一个渠道信息,有多少行就会创建多少个渠道包(空字符串默认过滤)。

    2.输出渠道包的文件名,有一定的规则,规则是由packer-ng-2.0.1.jar工具决定的。后述我讲到它的源码时请关注。在实际项目中,apk的文件名可能需要有我们自己的规则,例如各大应用市场,推广渠道等安装包是有特定名字的,这样方便后台管理。这个时候建议重新编译上述脚本工具,按照自己的规则生成文件名等。

 3.该工具的核心代码其实是集成美团的多渠道打包项目中的代码。作者也标注出来了。作者是将美团多渠道打包的代码进行了精简和封装,便于开发者使用。可以用上面的命令比较轻松地创建多渠道包。

 4.请注意V3签名。该库集成美团写入和读取渠道信息的代码没有及时更新。它现在并不支持V3签名的apk包写入渠道信息。美团打包库的代码已经更新,但该库还未更新最新代码。如果开发者使用V3签名apk(使用buildtools28及以上版本进行签名),那么这个apk文件被该库创建渠道包后,创建的渠道包如果安装在安卓9.0及以上系统上,会出现报错,安装不上,其它版本系统可以正常安装和正常读取渠道信息。这跟安卓9.0系统验证签名有关。

 5.设置渠道信息注意事项。在设置渠道信息时(channels.txt文件的内容),请不要使用特殊字符,例如“* ? |”等,如果设置了有这些特殊字符,会将其替换成"_"符号。该工具替换特殊字符的源码如下,可以根据如下替换规则来避免被替换了。如果开发者需要有自己的命名规则,可以重新编译该工具,自行修改。

读取channels.txt文件中的渠道信息的源码如下:

    public static Set<String> parseChannels(final File file) throws IOException {
        final List<String> channels = new ArrayList<>();
        FileReader fr = new FileReader(file);
        BufferedReader br = new BufferedReader(fr);
        String line;
        while ((line = br.readLine()) != null) {
            String parts[] = line.split("#");
            if (parts.length > 0) {
                final String ch = parts[0].trim();
                if (ch.length() > 0) {
                    channels.add(ch);
                }
            }
        }
        br.close();
        fr.close();
        return escape(channels);
    }

替换渠道特殊字符规则如下:

    public static Set<String> escape(Collection<String> cs) {
        // filter invalid chars for filename
        Pattern p = Pattern.compile("[\\\\/:*?\"'<>|]");
        Set<String> set = new HashSet<>();
        for (String s : cs) {
            set.add(p.matcher(s).replaceAll("_"));
        }
        return set;
    }
  • 验证渠道信息:
packer-ng verify app.apk
  • java -jar packer-ng-2.0.1.jar verify build/archives/5.apk
  • 验证结果如下:
  • 运行命令查看帮助
java -jar tools/packer-ng-2.0.1.jar --help

 

 

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
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.setCommentFileOutputStream 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 标签:packer
你可以使用Packer来创建一个基于Ubuntu的机器映像。通过定义一个Packer模板,你可以指定要使用的操作系统、软件和配置。以下是一个示例的Packer模板,用于创建一个Ubuntu 20.04的机器映像: ```json { "builders": [ { "type": "qemu", "accelerator": "kvm", "iso_url": "https://releases.ubuntu.com/20.04/ubuntu-20.04.3-live-server-amd64.iso", "iso_checksum": "sha256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "iso_checksum_type": "sha256", "boot_wait": "5s", "ssh_username": "ubuntu", "ssh_password": "ubuntu", "ssh_port": 22, "ssh_wait_timeout": "10m", "format": "qcow2", "output_directory": "output-qemu", "disk_size": 10000 } ], "provisioners": [ { "type": "shell", "inline": [ "echo 'provisioning script'" ] } ] } ``` 在这个示例中,我们使用qemu builder来创建一个基于QEMU虚拟化的机器映像。我们指定了Ubuntu 20.04的ISO镜像地址和校验和,以及SSH连接所需的用户名和密码。在`provisioners`部分,你可以添加一些自定义的脚本或命令来进行进一步的配置。 请注意替换`iso_url`中的URL和`iso_checksum`中的校验和为你所需的Ubuntu版本的实际值。 完成配置后,你可以运行以下命令来生成机器映像: ``` $ packer build ubuntu.json ``` 这将启动Packer创建一个基于Ubuntu的机器映像。生成的机器映像将保存在`output-qemu`目录下。 这只是一个简单的示例,你可以根据自己的需求进行更复杂的配置和定制。更多关于Packer的信息可以在Packer官方文档中找到。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值