Android 增量更新手把手教学

概述：当我们的APP的安装包越来越大时，版本更新每次都下载几十兆的apk，可能需要等待几分钟的时间，用户体验就不是很好；如果使用增量更新，那用户就不用下载整个新版本的app了，只需要下载一个体积较小的差分包，然后我们app合并差分包生成新版本的安装包，用户体验就可以提升不少。

生成差分包.png

合并差分包.png

一、准备c库

1、下载bsdiff库，里面包括bsdiff.c和bspatch.c，前者用于生产差分包，后者用于合并差分包的。
2、下载bzip2库，里面包括的大量文件，只有.c和.h文件是有需要的，其他都可以删掉；

二、集成c库

1、在bsdiff库中，我们的android项目只需要用到bspatch.c，另一个暂时先不管，把bspatch.c和bzip2中的所有文件都拷贝进项目中，放入app/src/main/cpp/路径下，再配置好项目的ndk环境（在CMakeLists文件中要配置上bspatch.c的导入）；
2、直接运行，我们会依次看到以下的错误：

• error: 'bzlib.h' file not found with include; use "quotes" instead
• error: undefined reference to 'BZ2_bzReadOpen'
• error: undefined reference to 'BZ2_compressBlock'
• error: undefined reference to 'BZ2_decompress'
• error: undefined reference to 'BZ2_crc32Table'
• error: undefined reference to 'BZ2_rNums'
• error: undefined reference to 'BZ2_hbCreateDecodeTables'
• error: undefined reference to 'BZ2_blockSort'

3、解决报错

• 第一个报错，我们把bspatch中的 #include 改成 #include "bzlib.h"；
• 第二个报错，缺了bzlib.c，bspatch加上#include "bzlib.c"即可；
• 第三个报错，BZ2_compressBlock是在compress.c中被定义，bspatch加上#include "compress.c"；
• 第四个报错，BZ2_decompress很明显和decompress.c有关系，bspatch加上#include "decompress.c"；
• 第五个报错，BZ2_crc32Table在crctable.c中被定义，bspatch加上#include "crctable.c"；
• 第六个报错，BZ2_rNums在randtable.c中被定义，bspatch加上#include "randtable.c"；
• 第七个报错，BZ2_hbCreateDecodeTable在huffman.c中被定义，bspatch加上#include "huffman.c"；
• 第八个报错，BZ2_blockSort在blocksort.c中被定义，bspatch加上#include "blocksort.c"；

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

#include 
#include 
#include 
#include 
#include 
#include 

三、实现合并差分包的功能

1、查看bspatch.c的代码：

(1) 只需要查看bspatch中的main方法，参数为int argc和char * argv[]；
(2) 参数argc在main方法中只在一个地方被调用，如果argc不等于4，抛出err；

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

(3) 参数argv为char*数组，argv[0]也是和argc在同一句代码被调用，argv[0]用于抛出err时的提示语，所以argv[0]我们可以自定义；

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

(4)argv[1]在以下代码被调用，可以猜到argv[1]代表的是oldVersionapk的所在地址；

if(((fd=open(argv[1],O_RDONLY,0))<0) ||
        ((oldsize=lseek(fd,0,SEEK_END))==-1) ||
        ((old=malloc(oldsize+1))==NULL) ||
        (lseek(fd,0,SEEK_SET)!=0) ||
        (read(fd,old,oldsize)!=oldsize) ||
        (close(fd)==-1)) err(1,"%s",argv[1]);
    if((new=malloc(newsize+1))==NULL) err(1,NULL);

(5) argv[2]在以下代码被调用到，可以确定argv[2]是newVersionApk需要输出的路径；

/* Write the new file */
    if(((fd=open(argv[2],O_CREAT|O_TRUNC|O_WRONLY,0666))<0) ||
        (write(fd,new,newsize)!=newsize) || (close(fd)==-1))
        err(1,"%s",argv[2]);

(6) argv[3]可以从以下代码中确定是patch文件的路径；

/* Open patch file */
    if ((f = fopen(argv[3], "r")) == NULL)
        err(1, "fopen(%s)", argv[3]);

(7) 没有argv[4]，说明argv的长度为4，同时修改main方法名为combine;

2、创建CombinePatchUtil类，创建native方法combinePatch， 用于调用native方法合并差分包，同时用javah命令生成.h文件：

/**
 * 合并差分包工具类
 * */
public class CombinePatchUtil {

    static {
        System.loadLibrary("bspatch");
    }

    public static native void combinePatch(String oldApkPath, String newApkPath, String patchPath);
}

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class com_adams_combinepatchapplication_CombinePatchUtil */

#ifndef _Included_com_adams_combinepatchapplication_CombinePatchUtil
#define _Included_com_adams_combinepatchapplication_CombinePatchUtil
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     com_adams_combinepatchapplication_CombinePatchUtil
 * Method:    combinePatch
 * Signature: (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 */
JNIEXPORT void JNICALL Java_com_adams_combinepatchapplication_CombinePatchUtil_combinePatch
  (JNIEnv *, jclass, jstring, jstring, jstring);

#ifdef __cplusplus
}
#endif
#endif

3、在bspatch.c导入com_adams_combinepatchapplication_CombinePatchUtil.h，并实现combinePatch方法：

/*
 * Class:     com_adams_combinepatchapplication_CombinePatchUtil
 * Method:    combinePatch
 * Signature: (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 */
JNIEXPORT void JNICALL Java_com_adams_combinepatchapplication_CombinePatchUtil_combinePatch
        (JNIEnv * jniEnv, jclass jclz, jstring oldApkPath, jstring newApkPath, jstring patchPath){

    const int argc = 4;
    char* argv[argc];

    argv[0] = (char*)'combine';

    // jstring转char*
    //char* GetStringUTFChars(jstring str, jboolean *isCopy) {
    const char* c_oldApkPath = (*jniEnv)->GetStringUTFChars(jniEnv, oldApkPath, NULL);
    argv[1] = (char*)c_oldApkPath;
    const char* c_newApkPath = (*jniEnv)->GetStringUTFChars(jniEnv, newApkPath, NULL);
    argv[2] = (char*)c_newApkPath;
    const char* c_pacthPath = (*jniEnv)->GetStringUTFChars(jniEnv, patchPath, NULL);
    argv[3] = (char*)c_pacthPath;

    combine(argc, argv);

    //释放资源
    // void ReleaseStringUTFChars(jstring str, const char* chars)
    (*jniEnv)->ReleaseStringUTFChars(jniEnv, oldApkPath, c_oldApkPath);
    (*jniEnv)->ReleaseStringUTFChars(jniEnv, newApkPath, c_newApkPath);
    (*jniEnv)->ReleaseStringUTFChars(jniEnv, patchPath, c_pacthPath);
}

4、在合并差分包后，我们要对生成的新版本apk文件进行md5校验（正确的md5值通常由服务器返回给我们），确保其是正确的，md5值正确，我们才进行新版本apk的安装：

public class MD5Util {

    public static String getFileMD5(File file) {
        if (!file.isFile()) {
            return null;
        }
        MessageDigest digest = null;
        FileInputStream in = null;
        byte buffer[] = new byte[1024];
        int len;
        try {
            digest = MessageDigest.getInstance("MD5");
            in = new FileInputStream(file);
            while ((len = in.read(buffer, 0, 1024)) != -1) {
                digest.update(buffer, 0, len);
            }
            in.close();
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
        return bytesToHexString(digest.digest());
    }

    public static String bytesToHexString(byte[] src) {
        StringBuilder stringBuilder = new StringBuilder("");
        if (src == null || src.length <= 0) {
            return null;
        }
        for (int i = 0; i < src.length; i++) {
            int v = src[i] & 0xFF;
            String hv = Integer.toHexString(v);
            if (hv.length() < 2) {
                stringBuilder.append(0);
            }
            stringBuilder.append(hv);
        }
        return stringBuilder.toString();
    }
}

四、实现生成差分包的功能

1、在eclipse中创建GeneratePatch项目，创建BsDiffUtil类，并创建generatePatch的native方法，同时生成.h文件：

public class BsDiffUtil {
    static {
        System.loadLibrary("BSDiffProject");
    }
    public static native void generatePatch(String OldApkPath, String newApkPath, String patchPath);
}

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class com_adams_bsdiff_BsDiffUtil */

#ifndef _Included_com_adams_bsdiff_BsDiffUtil
#define _Included_com_adams_bsdiff_BsDiffUtil
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     com_adams_bsdiff_BsDiffUtil
 * Method:    generatePatch
 * Signature: (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 */
JNIEXPORT void JNICALL Java_com_adams_bsdiff_BsDiffUtil_generatePatch
  (JNIEnv *, jclass, jstring, jstring, jstring);

#ifdef __cplusplus
}
#endif
#endif

2、生产bsdiff.dll动态库：

(1) 下载win版的bsdiff（官网不提供了，需要自行从github上找bsdiff-win），把.c、.cpp和.h之外的文件都删掉；然后在visual studio创建BSdiffProject项目；
(1) 把bzlib.h和bzlib_private.h导入到头文件中;
(2) 把bspatch.cpp删掉，把剩下的文件c/cpp文件导入到源文件中；
(3) 修改项目-属性-配置属性-常规-配置类型为动态库（.dll）;
(4) 点击生成解决方法，会看到以下几个错误，这里可以修改项目-属性-配置属性- c/c++ -预处理器- 预处理器定义，加上_CRT_SECURE_NO_WARNINGS和_CRT_NONSTDC_NO_DEPRECATE：

报错.jpg

(6) 再次点击生成解决方案，以下错误，修改项目-属性-配置属性- c/c++ -常规- SDL检查设置成否就可以解决：

报错.jpg

(7) 导入com_adams_bsdiff_BsDiffUtil.h文件、jni.h和jni_md.h文件到项目中，然后在bsdiff.cpp中加上#include "com_adams_bsdiff_BsDiffUtil.h"，实现generatePatch方法：

/*
 * Class:     com_adams_bsdiff_BsDiffUtil
 * Method:    generatePatch
 * Signature: (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 */
JNIEXPORT void JNICALL Java_com_adams_bsdiff_BsDiffUtil_generatePatch
(JNIEnv* jniEnv, jclass jclz, jstring oldApkPath, jstring newApkPath, jstring pacthPath) {

    const int argc = 4;
    char* argv[argc];

    argv[0] = (char*)'diff';

    //char* GetStringUTFChars(jstring str, jboolean *isCopy) {
    const char* c_oldApkPath = jniEnv->GetStringUTFChars(oldApkPath, NULL);
    argv[1] = (char*)c_oldApkPath;
    const char* c_newApkPath = jniEnv->GetStringUTFChars(newApkPath, NULL);
    argv[2] = (char*)c_newApkPath;
    const char* c_pacthPath = jniEnv->GetStringUTFChars(pacthPath, NULL);
    argv[3] = (char*)c_pacthPath;

    diff(argc, argv);

    // void ReleaseStringUTFChars(jstring str, const char* chars)
    jniEnv->ReleaseStringUTFChars(oldApkPath, c_oldApkPath);
    jniEnv->ReleaseStringUTFChars(newApkPath, c_newApkPath);
    jniEnv->ReleaseStringUTFChars(pacthPath, c_pacthPath);
}

(8) 点击生成解决方案，即可生成bsdiff.dll动态库；

3、把bsdiff.dll文件拷贝到eclipse的GeneratePatch项目中，即可在GeneratePatch实现生成差分包：

public class GeneratePatchClass {
    
    private final static String OldApkPath = "Version1.0.0.apk";
    private final static String newApkPath = "Version1.0.1.apk";
    private final static String patchPath = "Test.Patch";
    
    public static void main(String[] args) {
        BsDiffUtil.generatePatch(OldApkPath, newApkPath, patchPath);
        System.out.println("生成差分包成功");
    }
}

总结：增量更新实际上是通过调用bsdiff和bzip2两个库，传入oldApkPath，newApkPath和patchPath三个路径地址，即可实现生成差分包和合并差分包，中间比较麻烦的就是项目的配置，毕竟这个库原本不是专门提供给Android使用的。