Android 热修复入门-Demo实例

Misdirection_XG

于 2023-01-16 19:48:34 发布

阅读量191

点赞数 1

分类专栏： Android开发文章标签： android

本文链接：https://blog.csdn.net/Misdirection_XG/article/details/128708574

版权

Android开发专栏收录该内容

37 篇文章 0 订阅

订阅专栏

一直觉得Android 的热修复深不可测，即使网上有很多的介绍，但是没有自己动手一下，也很难理解。

今天终于自己参考了各种文档，写了一个简单的Demo 并成功实现，所以和大家分享一下。

概念的介绍就不再赘述了。

1. Demo 简介

一个类Cat, 里面仅实现了 say方法，仅返回一个 “汪汪汪”的String，显然这是个bug.

我们需要做的就是在不重新安装apk 的情况下（当然这里也是模拟），达到修复的效果.
这里使用的开发环境是:
Android Studio Arctic Fox| 2020.3.1
Win10

2. 原始程序

新建一个工程，包名为 com.example.hotpatchdemo
(1) Cat.java

package com.example.hotpatchdemo;

public class Cat {
    public String say() {
        // 改了这里后， 经jar -> dex 打包，共HotPatchApplication使用
        return " 还是汪汪汪！ " ;
    }
}

(2) MainActivity.java

package com.example.hotpatchdemo;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.view.View;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {
    private Cat mCat;

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

    public void click(View view) {
        Toast.makeText(this, mCat.say(), Toast.LENGTH_SHORT).show();
    }
}

(3) activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingLeft="20dp"
    android:paddingTop="20dp"
    android:paddingRight="20dp"
    android:paddingBottom="20dp"
    tools:context=".MainActivity">

    <Button
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:onClick="click"
        android:text="小喵叫一声" />
</RelativeLayout>

2.1 编译apk并查看运行结果

点击button后弹出一个错误的 Toast

3. 修复流程

这里其实大体可以分为三步：

修改bug所在的类
重新打包修改的类
应用添加逻辑检查是否有补丁包，有则进行热修复

4 修改bug所在的类

4.1 修复Cat.say 方法

Cat.java

package com.example.hotpatchdemo;

public class Cat {
    public String say() {
        // 改了这里后， 经jar -> dex 打包，共HotPatchApplication使用
        return " 喵喵喵！ " ;
    }
}

4.2 重新编译项目

Build -> Rebuild project
编译成功后，找到 Cat.class 即字节码文件，相对路径如下(不同的AndroidStudio版本可能位置不一样，可以直接在你项目工程所在文件夹搜索 Cat.class)：
HotPatchDemo\app\build\intermediates\javac\debug\classes\com\example\hotpatchdemo

5.重新打包修改的类

5.1 重新打包成 jar / dex 包

(1) 在你D盘或者其它地方，新建一个文件夹，和原始包名路径一致
如 D:\tmp\com\example\hotpatchdemo\
(2) 将上面新编译生成的 Cat.class拷贝到该路径下
(3) 使用cmd 进入该路径的 com目录下, 如进入 D:\tmp\com
(4)生成jar 包命令：
jar -cvf patch.jar com
则在com目录下生成了一个文件，名为 patch.jar
注：如果提示 jar 不是内部命令或者可执行程序，请配置JDK环境变量，
可参考：
https://jingyan.baidu.com/article/c85b7a64645dbe003aac957e.html

5.2 将 patch.jar 使用dx 工具生成新的jar包

dx --dex --output=patch_dex.jar patch.jar
如果提示dx 不是内部命令或者可执行程序，请参考：
https://blog.csdn.net/qq_34253642/article/details/80165761
则新生成的 patch_dex.jar就是我们打包好的补丁

6. 检查补丁包以及替换

应用添加逻辑检查是否有补丁包，有则进行热修复

6.1 获取补丁包

一般情况是用户联网进行下载补丁包，这里为了方便，仅是保存在手机本地文件夹，
将 patch_dex.jar 放入手机的存储目录的根目录下

6.2 使用补丁包

新建HotPatchApplication 继承 Application，执行检查及使用补丁包
代码如下：

package com.example.hotpatchdemo;

import android.app.Application;
import android.os.Environment;
import android.util.Log;
import android.widget.Toast;

import java.io.File;
import java.lang.reflect.Array;
import java.lang.reflect.Field;

import dalvik.system.DexClassLoader;

public class HotPatchApplication extends Application {

    @Override
    public void
    onCreate() {
        super.onCreate();
        //获取补丁，如果存在就执行注入操作
        String dexPath = Environment.getExternalStorageDirectory().getAbsolutePath().concat("/patch_dex.jar");
        // Demo 中 dexPath = /storage/emulated/0/patch_dex.jar 即放在 文件管理器 的根目录下, 根据以下条件确定：
        // (1) Android targetSdk=28(见app 的build.gradle), 因为 sdk 29 限制了在 文件管理器 根目录下的读写
        // (2) Android Manifest 申明 存储权限， 并在授权 (这里代码授权省略，不是重点，可以手动给应用存储权限)
        File file = new File(dexPath);
        if (file.exists()) {
            showToast("patch_dex.jar exist");
            inject(dexPath);
        } else {
            showToast("patch_dex.jar NOT exist");
            Log.e("BugFixApplication", dexPath + " 不存在 ");
        }
    }

    private void showToast(String msg) {
        Toast.makeText(this, msg, Toast.LENGTH_SHORT).show();
    }

    /**
     * 要注入的
     * dex
     * 的路径
     *
     * @param path
     */
    private void
    inject(String path) {
        try {
           //1. 获取classes的dexElements
            Class<?> cl = Class.forName("dalvik.system.BaseDexClassLoader");
            Object pathList = getField(cl, "pathList", getClassLoader());
            Object baseElements = getField(pathList.getClass(), "dexElements", pathList);

            //2. 获取patch_dex的dexElements（需要先加载dex）
            String dexopt = getDir("dexopt", 0).getAbsolutePath();
            DexClassLoader dexClassLoader = new DexClassLoader(path, dexopt, dexopt, getClassLoader());
            Object obj = getField(cl, "pathList", dexClassLoader);
            Object dexElements = getField(obj.getClass(), "dexElements", obj);

            //3. 合并两个Elements
            Object combineElements = combineArray(dexElements, baseElements);

            //4。 将合并后的Element数组重新赋值给app的classLoader
            setField(pathList.getClass(), "dexElements", pathList, combineElements);

            //========以下是测试是否成功注入=================
            Object object = getField(pathList.getClass(), "dexElements", pathList);
            int length = Array.getLength(object);
            Log.e("BugFixApplication", " length = " + length);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
        }
    }

    /**
     * 通过反射获取对象的属性值
     */
    private Object getField(Class<?> cl, String fieldName, Object object) throws NoSuchFieldException, IllegalAccessException {
        Field field = cl.getDeclaredField(fieldName);
        field.setAccessible(true);
        return field.get(object);
    }

    /**
     * 通过反射设置对象的属性值
     */
    private void setField(Class<?> cl, String fieldName, Object object, Object value) throws NoSuchFieldException, IllegalAccessException {
        Field field = cl.getDeclaredField(fieldName);
        field.setAccessible(true);
        field.set(object, value);
    }

    /**
     * 通过反射合并两个数组， firstArr 在前面， secondArr在后面， 长度依然是两者之和(即长度不变)
     */
    private Object combineArray(Object firstArr, Object secondArr) {
        int firstLength = Array.getLength(firstArr);
        int secondLength = Array.getLength(secondArr);
        int length = firstLength + secondLength;
        Class<?> componentType = firstArr.getClass().getComponentType();
        Object newArr = Array.newInstance(componentType, length);
        for (int i = 0; i < length; i++) {
            if (i < firstLength) {
                Array.set(newArr, i, Array.get(firstArr, i));
            } else {
                Array.set(newArr, i, Array.get(secondArr, i - firstLength));
            }
        }
        return newArr;
    }
}

注意在AndroidManifest 里要引用这个类，并且添加存储权限的声明(读取根目录的patch_dex.jar)：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.hotpatchdemo">
    
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

    <application
        android:name=".HotPatchApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.HotPatchDemo">
        <activity
            android:name=".MainActivity"
            android:exported="true">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

6.3 验证补丁包功能

由于我们是模拟下载补丁包(即拷贝补丁包到手机存储中)，而经过我们的修改，本地代码已经是修复了的，
为了还原有bug的用户版本，我们对 Cat.java 进行回退:

package com.example.hotpatchdemo;

public class Cat {
    public String say() {
        // 改了这里后， 经jar -> dex 打包，共HotPatchApplication使用
        return " 还是汪汪汪！ " ;
    }
}

重新编译apk 并且安装，
手动给apk 存储权限 (授权不是这里的重点，可以长按应用 -> 更多 -> 权限-》存储权限 -> 允许管理所有文件)
然后再点击 button，成功的话就是弹出正确的Toast 提示

7. GitHub 完整项目地址

https://github.com/wuhuijianke1/HotPatchDemo

附录

1. 简图参考

(来自其它学习视频截图，并非完全对应本文)

热修复例子.png

上图大致描述了热修复的过程，
关键在于 Android的分包机制和类加载机制

链接：https://www.jianshu.com/p/f604736aa23c
作者：行走中的3卡

最后

如果想要成为架构师或想突破20~30K薪资范畴，那就不要局限在编码，业务，要会选型、扩展，提升编程思维。此外，良好的职业规划也很重要，学习的习惯很重要，但是最重要的还是要能持之以恒，任何不能坚持落实的计划都是空谈。

如果你没有方向，这里给大家分享一套由阿里高级架构师编写的《Android八大模块进阶笔记》，帮大家将杂乱、零散、碎片化的知识进行体系化的整理，让大家系统而高效地掌握Android开发的各个知识点。
扫描二维码免费领取~

在这里插入图片描述
相对于我们平时看的碎片化内容，这份笔记的知识点更系统化，更容易理解和记忆，是严格按照知识体系编排的。

全套视频资料：

一、面试合集
在这里插入图片描述
二、源码解析合集

在这里插入图片描述
三、开源框架合集

在这里插入图片描述
欢迎大家一键三连支持，若需要文中资料，直接扫描二维码免费领取↓↓↓

Misdirection_XG

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Android 热修复入门-Demo实例

一个类Cat, 里面仅实现了 say方法，仅返回一个 “汪汪汪”的String，显然这是个bug.我们需要做的就是在不重新安装apk的情况下（当然这里也是模拟），达到修复的效果.这里使用的开发环境是:Win10如果想要成为架构师或想突破20~30K薪资范畴，那就不要局限在编码，业务，要会选型、扩展，提升编程思维。此外，良好的职业规划也很重要，学习的习惯很重要，但是最重要的还是要能持之以恒，任何不能坚持落实的计划都是空谈。如果你没有方向，这里给大家分享一套由阿里高级架构师编写的《
复制链接

扫一扫