手把手带你实现Android增量更新

Posted 2022-04-26 伯努力不努力

android增量更新技术在很多公司都在使用，网上也有一些相关的文章，但大家可能未必完全理解实现的方式，本篇博客，我将一步步的带大家实现增量更新。

为什么需要增量更新？

当我们开发完一个项目之后，上线维护 ， 增加新功能 ， 添加第三方库 ， APK大小从4 - 5M ， 增长到10+M ， 用户由原来的几十秒下载 ， 到现在几分钟以上的下载 ， 网络情况不好的时候 ， 或许就是十分钟不等。每次全量下载 ， 无论从体验还是流量上 ， 都是不友好的 ， 所有增量更新还是有必要的 （小公司好像没几个用 ， 一般大公司在用，如QQ空间）。

增量原理

说白了，增量更新就是：用户手机上安装着某个应用，下载了增量包，手机上的apk和增量包合并形成新的包，然后再次安装（注意这个过程是要重新安装的，当然部分应用市场有root权限你可能感知不到）。

实现思路：使用开源项目bsdiff 进行文件内容比较，并且使用了bzip2进行文件压缩 ， 所有得出的差分包可能比理论值要小 ， 进一步可以减少用户流量 。增量更新 ， 较为关键的部分就是生成差分包 ， 将新旧APK进行比较 ， 生成一个新的文件 。

需要使用的资源

进行增加更新主要是通过开源项目bsdiff项目来进行实现，还需要一些辅助的工具，列表如下：
bsdiff — bsdiff （win环境） 生成差分包及合并差分包库 ， 源码内已包含bzip2
项目地址：
https://github.com/hymanAndroid/tools/tree/master/bsdiff-4.3
bzip2 — bzip2 bsdiff 依赖
服务器 — Tomcat 7.0 （模拟网络环境）放置差分包 ， 供APP下载
开发工具 — Eclipse NDK开发 ， 目前建议使用Eclipse开发
开发工具 — VS 因为服务器搭建在windows平台 ， 所以使用VS开发JNI

如何进行差分包的生成？

下载完bsdiff之后 ， 我们看到如下目录：

看这么多文件 ， 还有一些乱七八糟的不知道什么的文件 ， 那么我们只关注 ， 我们想要的文件 ， 将C/C++源文件以及.h头文件，找出来 ，放到一个干净的文件夹中 。

1.使用visual studio去新建一个项目

2.将bsdiff中的.c和.cpp文件放到VS项目源文件中，把.h文件放到VS项目头文件中

然后尝试进行编译，发现报错，用到了过时的函数

错误内容是：使用了非安全的函数 ， 解决方法是在文件中声明#define _CRT_SECURE_NO_WARNINGS即可 。如果是多个文件都需要进行声明，显然一条条的声明太麻烦了，所以可以在属性中声明，所有的文件都适用。

修改完毕，再次尝试编译，还是报错，内容如下：

原因是在VS中通不过安全语法检查 ， 在VS中进行如下设置，将SDL检查由“是”改为“否”：

还需要在文件中添加#define _CRT_NONSTDC_NO_DEPRECATE预处理指令。

然后我们需要生成.dll动态库，需要我们在配置中，将“配置类型”改为“动态库(.dll)”

编译生成.dll动态库后 ， 赋值到服务器项目的目录下 ， 或是Java项目也可以 。
编译生成.dll动态库时，还可能出现一个坑，那就是：变量未初始化

    u_char *old = nullptr,*_new = nullptr;
    off_t oldsize,newsize;
    off_t *I,*V = nullptr;

可能会是这几个 ， 将其赋值为nullptr就可以了。 如果还有其他错误 ， 可执行分析 ， google ， 也欢迎评论留言 ， 多多交流 。

3.了解bsdiff的用法 ， 在main函数中寻找思路

int main(int argc,char *argv[])

    int fd;
    u_char *old,*_new;
    off_t oldsize,newsize;
    off_t *I,*V;
    off_t scan,pos,len;
    off_t lastscan,lastpos,lastoffset;
    off_t oldscore,scsc;
    off_t s,Sf,lenf,Sb,lenb;
    off_t overlap,Ss,lens;
    off_t i;
    off_t dblen,eblen;
    u_char *db,*eb;
    u_char buf[8];
    u_char header[32];
    FILE * pf;
    BZFILE * pfbz2;
    int bz2err;

    if(argc!=4) errx(1,"usage: %s oldfile newfile patchfile\\n",argv[0]);

在bsdiff.cpp文件找到带参数的main函数 ， 并且有一个关于用法的线索 ， 那就是：

if(argc!=4) errx(1,"usage: %s oldfile newfile patchfile\\n",argv[0]);

我们可以根据这句话来推测 ， 需要四个参数 ， 并且三个参数必须传入的文件路径 ， 剩下的一个参数不会有影响，直接传入任何值都可以。

4.创建JNI方法 ， 修改main函数
既然知道了需要传入的参数 ， 那么就可以创建一个Java工程 ， 编写JNI方法了。

public class BsDiff 

    /**
     * 生成差分包
     * 
     * @param oldfile 老版本文件路径
     * @param newfile 新版本文件路径
     * @param patchfile 生成差分包文件路径
     */
    public native static void diff(String oldfile, String newfile, String patchfile);

    static
        System.loadLibrary("bsdiff");
    

接下来使用javah命令，生成头文件 ， 将.h头文件拷贝到我们 VS的工程中，同时com_dispatch_bsdiff_BsDiff.h头文件还需要依赖jni.h和jni_md.h两个文件

com_dispatch_bsdiff_BsDiff.h中引入jni.h

将头文件com_dispatch_bsdiff_BsDiff.h引入到bsdiff.cpp文件中

5.编写调用的C函数 ， 并修改main函数名称，main函数作为入口函数 ， 在JNI中就适用了 ， 所有将main函数名称改一下 ， 在JNI的C函数中调用即可 。

编写bsdiff.cpp的native函数

//JNI 调用
JNIEXPORT void JNICALL Java_com_dispatch_bsdiff_BsDiff_diff
(JNIEnv *env, jclass jcls, jstring oldfile_jstr, jstring newfile_jstr, jstring patchfile_jstr)
    int argc = 4;
    char* oldfile = (char*)env->GetStringUTFChars(oldfile_jstr, NULL);
    char* newfile = (char*)env->GetStringUTFChars(newfile_jstr, NULL);
    char* patchfile = (char*)env->GetStringUTFChars(patchfile_jstr, NULL);

    //参数（第一个参数无效）
    char *argv[4];
    argv[0] = "bsdiff";
    argv[1] = oldfile;
    argv[2] = newfile;
    argv[3] = patchfile;

    bsdiff_main(argc, argv);

    env->ReleaseStringUTFChars(oldfile_jstr, oldfile);
    env->ReleaseStringUTFChars(newfile_jstr, newfile);
    env->ReleaseStringUTFChars(patchfile_jstr, patchfile);

一切修改完毕 ，重新编译生成.dll动态库 。
差分包工具类：

public class BsdiffUtils 

        /**
         * 生成差分包
         * @param oldFilePath 老版本文件路径
         * @param newFilePath 新版本文件路径
         * @param patchFilePath 生成差分包文件路径
         */
        public static native void diff(String oldFilePath , String newFilePath , String patchFilePath) ;

使用差分包工具类：

public class BsdiffApk 

    public static void main(String args[]) 

        /**
         * 文件差分
         */
        BsdiffUtils.diff(Constract.OLD_FILE_PATH, Constract.NEW_FILE_PATH, Constract.PATCH_FILE_PATH);
    

常量类，主要用于存储差分包路径：

public class Constract 

    public static final String OLD_FILE_PATH = "E:/javaee_workspace/AppUpdateServer/apk/app-old.apk" ;
    public static final String NEW_FILE_PATH = "E:/javaee_workspace/AppUpdateServer/apk/app-new.apk" ;
    public static final String PATCH_FILE_PATH = "E:/javaee_workspace/AppUpdateServer/apk/App_patch.patch" ;

生成差分包：

合并差分包

1.提取bzip2中的源文件

2.将bzip2加入到Android Studio项目中
首先将工程切换到Project模式 ， 将bzip2文件夹复制到cpp目录下 。因为最新的Android Studio采用的是CMake构建工具 ， 所有需要在bzip2目录下，创建一个CMakeLists.txt文件：

3.将bspatch.c复制到cpp目录下 ， 并将自动生成的CMakeList.txt文件拖拽到cpp目录下 ， 并添加子目录参与编译 。

修改了CMakeLists.txt文件的路径之后 ， 需要在build.gradle中修改一下配置了：

并且配置一下build环境

4.然后就是在java代码中编写合并差分文件的JNI方法

public class BspatchJNI 

    /**
     * 合并增量文件
     * @param oldFilePath 当前APK路径
     * @param newFilePath 合成后的新的APK路径
     * @param patchFilePath 增量文件路径
     */
    public static native void bspatchJNI(String oldFilePath,String newFilePath,String patchFilePath) ;

    static 
        System.loadLibrary("bspatch");
    

5.编写C函数 ， 怎样找执行函数 ， 和前面拆分文件的套路是一样的

/*合并APK*/
JNIEXPORT void JNICALL
Java_com_zeno_incrementupdate_ndk_BspatchJNI_bspatchJNI(JNIEnv *env, jclass type,
                                                        jstring oldFilePath_, jstring newFilePath_,
                                                        jstring patchFilePath_) 
    const char *oldFilePath = (*env)->GetStringUTFChars(env, oldFilePath_, 0);
    const char *newFilePath = (*env)->GetStringUTFChars(env, newFilePath_, 0);
    const char *patchFilePath = (*env)->GetStringUTFChars(env, patchFilePath_, 0);


    // if(argc!=4) errx(1,"usage: %s oldfile newfile patchfile\\n",argv[0]);

    int argc = 4 ;
    char* argv[4] ;
    argv[0] = "bspatch";
    argv[1] = oldFilePath;
    argv[2] = newFilePath;
    argv[3] = patchFilePath;

    bspatch_main(argc,argv);

    LOGE("MainActivity","%s","合并APK完成");

    (*env)->ReleaseStringUTFChars(env, oldFilePath_, oldFilePath);
    (*env)->ReleaseStringUTFChars(env, newFilePath_, newFilePath);
    (*env)->ReleaseStringUTFChars(env, patchFilePath_, patchFilePath);

需要注意的时 ， 在bspatch.c中是需要引入bzip2的 ， 所有需要在文件头部， 引入bzip2 :

/ bzip2
#include "bzip2/bzlib.c"
#include "bzip2/crctable.c"
#include "bzip2/compress.c"
#include "bzip2/decompress.c"
#include "bzip2/randtable.c"
#include "bzip2/blocksort.c"
#include "bzip2/huffman.c"

#define LOGE(TAG,FORMAT,...) __android_log_print(ANDROID_LOG_ERROR,TAG,FORMAT,__VA_ARGS__)

拆分和合并的代码就已经写完了，其余下载的java代码，大家可以根据自己项目的情况去进行编写，这里就不再贴出

6.打包
因为Android Studio使用了instant run技术 ， 所以使用Android Studio生成APK最好是打正式包 ， 并且包中内容要有差异性 ， 然后再生成差分包 ， 直接放置在WEB项目的WebContent根目录下即可 。