Android增量更新（bsdiff使用）

作者: CoderYuZ | 来源:发表于2019-05-31 14:36 被阅读244次

简单了解

增量更新是什么？
APP版本更新时不需要客户端下载新的apk，只需要下载差分包（两个apk的差异）。
差分包怎么得到？怎么用旧的apk和差分包合成新的apk？
使用bsdiff。
bsdiff是怎么工作的？
比较两个文件二进制，具体实现有兴趣可以去深挖。
举个例子方便理解：Git，就可以记录你每次修改、增加、删除，而且不是以文件为单位的，可具体到某个文件中的某一行，每次上传代码其实只上传的差异。
bsdiff咋用？
先下载bsdiff，解压看下都有什么文件：

bsdiff.c使用来计算差异生成差分包的，bspatch是来合成新apk的。

服务端配置（Linux）

下载bsdiff：wget http://www.daemonology.net/bsdiff/bsdiff-4.3.tar.gz
解压bsdiff：tar -xvf bsdiff-4.3.tar.gz
cd到bsdiff下ls，跟刚才解压看到的一样：bsdiff.1 bsdiff.c bspatch.1 bspatch.c Makefile
直接在该目录下执行make命令，结果：
Makefile:13: *** missing separator. Stop.
刚下在的就有坑，需要修改Makefile
修改Makefile：vim Makefile
打开Makefile可以看到13行格式错误，少了缩进，15行也也有同样问题，修改完后为：

CFLAGS          +=      -O3 -lbz2                                                               
                                                                                                
PREFIX          ?=      /usr/local                                            
INSTALL_PROGRAM ?=      ${INSTALL} -c -s -m 555                               
INSTALL_MAN     ?=      ${INSTALL} -c -m 444                                  
                                                                              
all:            bsdiff bspatch                                                
bsdiff:         bsdiff.c                                                      
bspatch:        bspatch.c                                                     
                                                                               
install:                                                                       
        ${INSTALL_PROGRAM} bsdiff bspatch ${PREFIX}/bin                        
        .ifndef WITHOUT_MAN                                                                     
        ${INSTALL_MAN} bsdiff.1 bspatch.1 ${PREFIX}/man/man1                     
        .endif

再make：bsdiff.c:33:19: fatal error: bzlib.h: No such file or directory
说缺少bzip库，bzip是压缩工具，可以去下载bzip源码进行编译，这里采用直接安装系统环境的方式：
Ubuntu: apt install libbz2-dev
Centos: yum -y install bzip2-devel.x86_64
Mac: brew install bzip2
再再make，OJBK！ ls一下：bsdiff bsdiff.1 bsdiff.c bspatch bspatch.1 bspatch.c Makefile
多了两个工具：bsdiff、bspatch
服务端配置完成，一会回使用7中的bsdiff工具去生成差分包

客户端配置

服务端通过两个apk文件比较会生存差分包，客户端拿到差分包肯定是要跟旧的apk(就是现在安装的apk)去合成新的apk，所以客户端要做的就是合成、安装。

直接创建一个C++项目（apk合成是在native层干的）
把bspatch.c放到cpp目录下（上面说到bsdiff用开差分，bspatch用开合成，客户端需要合成操作），bspatch.c中也需要bzlib.h
下载bzip，在cpp中新建bzip文件夹，把bzlib解压结果copy进去。这些文件有一些使用不到，可以在bzlib的makefile中找到哪些文件有用，makefile中可以看到这样内容：

libbz2.a: $(OBJS)

...

OBJS= blocksort.o  \
      huffman.o    \
      crctable.o   \
      randtable.o  \
      compress.o   \
      decompress.o \
      bzlib.o

所以只保留对应的.c文件就可以，删除完之后的src目录：

其中bzlib.h和bzlib_private.h是bzlib.c中用到的，要保留。

修改项目的CMakeLists.txt，引入bzip：
- 定义file(GLOB bzip bzip/*.c)
- 在add_library中添加：
  ${bzip}
  bspatch.c
run一下试试：bspatch.c:31:10: fatal error: 'bzlib.h' file not found
打开看到Bspatch.c中引入头文件是这样写的：#include <bzlib.h>
<>是引入系统头文件，可以改成 #include “bzip/bzlib.h”
或者在cmake文件中添加:include_directories(bzip)
最终的cmake文件：

cmake_minimum_required(VERSION 3.4.1)

file(GLOB bzip bzip/*.c)

add_library(
        native-lib

        SHARED

        native-lib.cpp

        ${bzip}

        bspatch.c
)

include_directories(bzip)

find_library(
        log-lib

        log)

target_link_libraries(
        native-lib

        ${log-lib})

客户端编码

服务端和客户端都配置好了，之后是客户端完成合成、安装的操作，这里就不写下载过程了，直接把一会服务端生成的差分包放到sdcard目录下。
安装apk没什么说的，主要是怎么调用bspatch去合成，打开bspatch.c文件，总共就俩函数，很明显应该用这个叫main的函数（名字有点特别，叫什么没关系，可以随便改），看看参数：

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

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

这个函数需要传入一个数组，第一个参数是数组长度（长度必须是4），数组第一元素是个字符串，用来输出log的，没什么真正用处，后面三个元素依次是oldfile、newfile、patchfile，也就是现有apk、新apk、差分包，现有apk和差分包我们可以拿到，新apk指的合成之后的存放在哪。看到这可以开撸了：

在MainActivity创建参数相对应的native函数：

// 参数顺序不用太在意，知道对应关系就行
private native void bsPatch(String oldApk, String patch, String output);

直接用AS提示生成native方法：

extern "C"
JNIEXPORT void JNICALL
Java_com_yu_mybsdiff_MainActivity_bsPatch(JNIEnv *env, jobject instance, jstring oldApk_,
                                          jstring patch_, jstring output_) {
    const char *oldApk = env->GetStringUTFChars(oldApk_, 0);
    const char *patch = env->GetStringUTFChars(patch_, 0);
    const char *output = env->GetStringUTFChars(output_, 0);

    //TODO

    env->ReleaseStringUTFChars(oldApk_, oldApk);
    env->ReleaseStringUTFChars(patch_, patch);
    env->ReleaseStringUTFChars(output_, output);
}

上面代码是自动生成的，不用管，只要在TODO里调用bspatch的main函数就可以了，参数刚才分析过了，调用简单的很：

    const char *argv[] = {"", oldApk, output, patch};
    main(4, argv);

直接这样写会发现找不到main函数，因为没有引入bspatch头文件，include半天发现bspatch根本没有.h文件，无法include，我们直接在上面加上main函数的声明就可以了，因为C工程中的函数不能重名，所以这俩mian函数就是一个声明一个实现，最终的native-lib.cpp内容：

#include <jni.h>
#include <string>

extern "C" {
    extern int main(int argc, const char *argv[]);
}

extern "C"
JNIEXPORT void JNICALL
Java_com_yu_mybsdiff_MainActivity_bsPatch(JNIEnv *env, jobject instance, jstring oldApk_,
                                          jstring patch_, jstring output_) {
    const char *oldApk = env->GetStringUTFChars(oldApk_, 0);
    const char *patch = env->GetStringUTFChars(patch_, 0);
    const char *output = env->GetStringUTFChars(output_, 0);

    const char *argv[] = {"", oldApk, output, patch};
    main(4, argv);

    env->ReleaseStringUTFChars(oldApk_, oldApk);
    env->ReleaseStringUTFChars(patch_, patch);
    env->ReleaseStringUTFChars(output_, output);
}

到这里合成apk的native代码就实现完成，就三四句代码。

在写MainActivity中的逻辑之前先看下布局

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:gravity="center"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/sample_text"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"/>

    <Button
        android:onClick="update"
        android:id="@+id/button"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text=" 更新 "
        android:layout_marginTop="10dp"/>

</LinearLayout>

MainActivity中获取bspatch中所需参数的代码：

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("native-lib");
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        ...
    }



    public void update(View view) {
        new AsyncTask<Void, Void, File>() {
            @Override
            protected File doInBackground(Void... voids) {

                // 获得bspatch中要传入的参数
                String patch = new File(Environment.getExternalStorageDirectory(), "patch").getAbsolutePath();
                String oldApk = getApplicationInfo().sourceDir;
                String output = createNewApk().getAbsolutePath();

                if (!new File(patch).exists()) {
                    return null;
                }
                bsPatch(oldApk, patch, output);
                return new File(output);
            }

            @Override
            protected void onPostExecute(File file) {
                super.onPostExecute(file);
                //安装新apk
               ...
            }
        }.execute();
    }


    /**
     * 创建合成后的新版本apk文件
     *
     * @return
     */
    private File createNewApk() {
        File newApk = new File(Environment.getExternalStorageDirectory(), "bsdiff.apk");
        if (!newApk.exists()) {
            try {
                newApk.createNewFile();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return newApk;
    }


    private native void bsPatch(String oldApk, String patch, String output);
}

记得添加权限：

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES"/>

安装apk代码，不多说什么了，不熟悉的话一搜一堆，直接贴出流程：

res/xml目录下创建file_paths.xml文件：

<?xml version="1.0" encoding="utf-8"?>
<paths>

    <root-path
        name="root"
        path="" />

    <files-path
        name="files"
        path="." />

    <cache-path
        name="cache"
        path="." />

    <external-path
        name="external"
        path="." />

    <external-files-path
        name="external_file_path"
        path="." />

    <external-cache-path
        name="external_cache_path"
        path="." />

</paths>

AndroidManifest.xml中添加

       <provider
            android:name="android.support.v4.content.FileProvider"
            android:authorities="com.yu.mybsdiff.fileprovider"
            android:exported="false"
            android:grantUriPermissions="true">
            <meta-data
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/file_paths" />
        </provider>

含有安装逻辑的MainActivity代码：

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("native-lib");
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        TextView tv = findViewById(R.id.sample_text);
        // 显示当前版本号
        tv.setText(BuildConfig.VERSION_NAME);

        // 运行时权限申请
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            String perms[] = {Manifest.permission.WRITE_EXTERNAL_STORAGE};
            if (checkSelfPermission(perms[0]) == PackageManager.PERMISSION_DENIED) {
                requestPermissions(perms, 1000);
            }
        }
    }



    public void update(View view) {
        new AsyncTask<Void, Void, File>() {
            @Override
            protected File doInBackground(Void... voids) {

                String patch = new File(Environment.getExternalStorageDirectory(), "patch").getAbsolutePath();
                String oldApk = getApplicationInfo().sourceDir;
                String output = createNewApk().getAbsolutePath();

                if (!new File(patch).exists()) {
                    return null;
                }
                bsPatch(oldApk, patch, output);
                return new File(output);
            }

            @Override
            protected void onPostExecute(File file) {
                super.onPostExecute(file);
                //安装新apk
                if (file != null) {
                    if (!file.exists()) return;
                    Intent intent = new Intent(Intent.ACTION_VIEW);
                    intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
                    intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
                        Uri fileUri = FileProvider.getUriForFile(MainActivity.this, MainActivity.this.getApplicationInfo().packageName + ".fileprovider", file);
                        intent.setDataAndType(fileUri, "application/vnd.android.package-archive");
                    } else {
                        intent.setDataAndType(Uri.fromFile(file), "application/vnd.android.package-archive");
                    }
                    MainActivity.this.startActivity(intent);
                } else {
                    Toast.makeText(MainActivity.this, "差分包不存在！", Toast.LENGTH_LONG).show();
                }
            }
        }.execute();
    }


    /**
     * 创建合成后的新版本apk文件
     *
     * @return
     */
    private File createNewApk() {
        File newApk = new File(Environment.getExternalStorageDirectory(), "bsdiff.apk");
        if (!newApk.exists()) {
            try {
                newApk.createNewFile();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return newApk;
    }


    private native void bsPatch(String oldApk, String patch, String output);
}

生成差分包，演示更新

上面的客户端代码就完成了，可以build之后在outputs中取出这个apk先，当前版本号默认为1.0：

        versionCode 1
        versionName "1.0"

为了展示更新流程，还需要一个新的apk，这里修改一下布局文件，在里面加一个图片，然后把版本改成2.0:

        versionCode 2
        versionName "2.0"

再build一下，取出2.0的apk
分别命名为app_1_0.apk、app_2_0.apk

两个apk文件准备好了，刚才服务端也配置好了bsdiff，现在用scp命令把这俩apk上传到服务器中的，现在服务端bsdiff的目录下是这样的：
bsdiff.1
bsdiff.c
bspatch.1
bspatch.c
Makefile
app_1_0.apk
app_2_0.apk
直接在该目录下执行./bsdiff app_1_0.apk app_2_0.apk patch，意思是调用bsdiff生成旧apk(app_1_0.apk)和新apk(app_1_0.apk)的差分包patch。这样目录下又多了patch文件，把文件下载下来，放到手机sdcard目录下。
在手机上安装app_1_0.apk，点击更新：
⚠️注意：如果你debug环境下build出的apk不能直接通过adb install 安装到手机上，更新的时候就会出现安装失败的情况，需要在gradle.propertoes中加上:

android.injected.testOnly=false

就可以了。

最后看下几个文件大小：

只下载了73KB的文件，就完成了版本升级！虽然差分包大小也会跟随修改内容变多而变大，但是如果项目很大，apk和差分包大小应该也不只是几十倍了。

项目地址
如果运行过程中出现问题，先看sdcard目录下有没有生成bsdiff.apk(这个名字是在createNewApk方法中自己取的，本项目中叫bsdiff.apk)，如果存在就把它导出来直接adb install看能不能安装上。

Android增量更新（bsdiff使用）

简单了解

服务端配置（Linux）

客户端配置

客户端编码

生成差分包，演示更新

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android学习笔记 - NDK

android

框架【库】