Android熱修復二(手寫熱更新代碼)

Android熱修復二(手寫熱更新)

通過第一篇已經瞭解了原理了,想必動手實現也不是那麼難了,下面到了激動人心的代碼環節,決定課後不看代碼自己手擼。

回顧一下基於類加載的熱修復的實現步驟:

  1. 反射獲取當前程序的PathClassLoader
  2. 反射獲取DexPathClassLoader的pathList屬性
  3. 反射獲取pathList中的屬性dexElements
  4. 把自己的補丁包 patch.dex 轉化爲 Elements[]數組 pathElements
  5. 將pathElements 插入到  dexElements最前面,得到新的 newElements
  6. 將newElements反射替換原來的dexElements 

不廢話,手擼開始。

編寫測試代碼:

首先建立一個MainActivity,通過點擊事件來查看代碼信息:

public class MainActivity extends AppCompatActivity {

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

    public void onClick(View view) {
        switch (view.getId()){
            case R.id.btn_test:
                Toast.makeText(this, BugTest.getMessage(), Toast.LENGTH_SHORT).show();
                break;
        }
    }
}

BugTest.java:

public class BugTest {
    public static String getMessage() {
        return "程序出bug了,趕緊叫人來修補!!!";
    }
}

超簡單的代碼,正常點擊,會提示  “程序出bug了,趕緊叫人來修補!!!”

 

下面對上面的代碼做修復,目的是修改BugTest#getMessage() 方法。

我們程序中會多出用到反射,而且很多都是從父類中查找屬性和方法,考慮到兩個函數

  • getMethod/getField()  可以得到自己和父類的所有public 方法,但是不能獲取非public的
  • getDeclaredMethod()/getDeclaredField() 可以得到自己類中包括非public所有方法,但是不能獲取父類中方法

但是我們的需求既要父類的,也需要獲取非public方法,所以有必要封裝一個反射的工具類ReflectUtil.java:

package com.dragonforest.app.qqhotfix.util;

import android.util.Log;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import static android.content.ContentValues.TAG;

/**
 * 反射工具類
 *
 * @author 韓龍林
 * @date 2019/9/26 10:23
 */
public class ReflectUtil {

    /**
     * 反射獲取屬性 會從所有父類中找,不區分private
     */
    public static Field getField(Class cls, String fieldName) {
        // 如果自己類中找不到 就去父類中遞歸查找
        Field declaredField = null;
        while (cls != null) {
            Log.e(TAG, "getField: 當前類" + cls.getName());
            try {
                declaredField = cls.getDeclaredField(fieldName);
                if (declaredField != null) {
                    declaredField.setAccessible(true);
                    return declaredField;
                }
            } catch (NoSuchFieldException e) {
                e.printStackTrace();
            }
            cls = cls.getSuperclass();
        }
        // 沒有找到
        return null;
    }

    /**
     * 反射獲取方法 會從所有父類中找,不區分private  注意方法需要傳入參數
     */
    public static Method getMethod(Class cls, String methodName, Class<?>... paramTypes) {

        // 如果自己類中找不到 就去父類中遞歸查找
        Method declaredMethod = null;
        while (cls != null) {
            try {
                declaredMethod = cls.getDeclaredMethod(methodName, paramTypes);
                if (declaredMethod != null) {
                    declaredMethod.setAccessible(true);
                    return declaredMethod;
                }
                cls = cls.getSuperclass();
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            }
        }

        // 沒有找到
        return null;
    }
}

 

下面正式進入熱修復的步驟,編寫一個FixUtil.java:

package com.dragonforest.app.qqhotfix.util;

import android.content.Context;
import android.os.Build;
import android.util.Log;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import static android.content.ContentValues.TAG;

/**
 * 修復類
 *
 * @author 韓龍林
 * @date 2019/9/26 10:29
 */
public class FixUtil {

    public static void installPatch(Context context, String patchPath) {
        File patchFile = new File(patchPath);
        if (!patchFile.exists()) {
            Log.e(TAG, "installPatch: " + patchPath + "無文件,無需修復");
            return;
        }
        File optDir = context.getCacheDir();
        try {
            // 1.得到當前程序的classLoader
            ClassLoader classLoader = context.getClassLoader();
            // 2.反射獲取類加載器的pathList屬性
            Class<? extends ClassLoader> pathClassLoaderCls = classLoader.getClass();
            Field pathListField = ReflectUtil.getField(pathClassLoaderCls, "pathList");
            Object pathList = pathListField.get(classLoader);
            // 3.反射獲取DexPathList中的dexElements
            Field dexElementsField = ReflectUtil.getField(pathList.getClass(), "dexElements");
            Object[] dexElements = (Object[]) dexElementsField.get(pathList);
            // 4.加載自己的dex,並轉化爲Element[]
            // 通過反射DexPathList 中的makeDexElements() 方法來實現
            // 4.1 反射獲取makeDexElements方法
            Object[] patchElements = null;
            // 版本適配
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
                // Android 7.0+ 使用makeDexElements(List,File,List,ClassLoader)
                Method makeDexElementsMethod = ReflectUtil.getMethod(pathList.getClass(), "makeDexElements", List.class, File.class, List.class, ClassLoader.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makeDexElementsMethod.invoke(null, dexFileList, optDir, suppressedExceptions, classLoader);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
                // Android 6.0-7.0 使用makePathElements(List,File,List)
                Method makePathElements = ReflectUtil.getMethod(pathList.getClass(), "makePathElements", List.class, File.class, List.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makePathElements.invoke(null, dexFileList, optDir, suppressedExceptions);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                // Android 5.0-6.0 使用makeDexElements(ArrayList,File,ArrayList)  注意這裏參數編程ArrayList類型
                Method makeDexElementsMethod = ReflectUtil.getMethod(pathList.getClass(), "makeDexElements", ArrayList.class, File.class, ArrayList.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makeDexElementsMethod.invoke(null, dexFileList, optDir, suppressedExceptions);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
                // Android 4.4-5.0 使用makeDexElements(ArrayList,File,ArrayList)  注意這裏參數編程ArrayList類型
                // 和5.0一樣的方法,注意4.4 會報錯 Class ref in pre-verified class resolved to unexpected implementation
                Log.e(TAG, "installPatch: 當前版本:" + Build.VERSION.SDK_INT + "此版本暫未解決 Class ref in pre-verified class resolved to unexpected implementation 的問題,敬請期待!");
                return;
            } else {
                Log.e(TAG, "installPatch: 當前版本:" + Build.VERSION.SDK_INT + "不支持熱更新");
                return;
            }
            // 5.合併兩個Element[] patchElements要放在前面
            Object[] newElements = (Object[]) Array.newInstance(dexElements.getClass().getComponentType(), dexElements.length + patchElements.length);
            System.arraycopy(patchElements, 0, newElements, 0, patchElements.length);
            System.arraycopy(dexElements, 0, newElements, patchElements.length, dexElements.length);
            // 6.反射替換原來的dexElements
            dexElementsField.set(pathList, newElements);
            Log.e(TAG, "installPatch: 修復成功");
        } catch (Exception e) {
            e.printStackTrace();
            Log.e(TAG, "installPatch: 修復失敗!!" + e.getMessage());
        }
    }
}

 

這個類包含了最核心的代碼了,熱更新的步驟就不說了,對版本適配做一下說明吧:

版本適配的點都在 將文件dex轉化爲Elements數組的地方,不同版本的DexPathList方法中對應的方法有所區別(注意參數):

  • Android 7.0 -  8.0 :   使用  makeDexElements(List,File,List,ClassLoader)
  • Android 6.0 - 7.0: 使用  makePathElements(List,File,List)
  • Android 5.0 - 6.0: 使用  makeDexElements(ArrayList,File,ArrayList)
  • android 4.4 - 5.0: 和5.0-6.0一樣,但是4.4會報錯 java.lang.IllegalAccessError: Class ref in pre-verified class resolved to unexpected implementation  具體原因,我正在研究。

 

最後就到用的環節了,我們在程序最開始啓動的地方進行熱修復,MyApplication#attachBaseContext:

package com.dragonforest.app.qqhotfix.application;

import android.app.Application;
import android.content.Context;

import com.dragonforest.app.qqhotfix.util.FixUtil;

import java.io.File;

/**
 * @author 韓龍林
 * @date 2019/9/26 12:52
 */
public class MyApplication extends Application {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        FixUtil.installPatch(this,getFilesDir()+ File.separator+"patch.dex");
    }
}

這裏傳入的是getFilesDir() 沒有使用getCacheDir()  應爲後者在7.0上測試時會自動刪除,所以沒有使用。此外,7.0以後的私有目錄結構有所修改。 7.0以前是 data/data/包名/files,  7.0以後變成了 data/user/0/包名/files了。

生成補丁包:

首先將BugTest.java 修改成如下:

package com.dragonforest.app.qqhotfix.util;

/**
 * @author 韓龍林
 * @date 2019/9/26 10:24
 */
public class BugTest {
    public static String getMessage() {
        return "聰明的程序員已經通過熱更新修補了!";
    }
}

我的步驟是 .java   --->  .class  --->  .jar --->  .dex

  1. .java 編譯成 .class       javac -encoding UTF-8 com/dragonforest/app/qqhotfix/util/BugTest.java
  2.  .class 打包成 jar          jar cvf patch.jar com/dragonforest/app/qqhotfix/util/BugTest.class
  3.  jar包轉化爲dex            dx --dex --output=patch.dex patch.jar

至於配置dx什麼的,去百度吧。

得到patch.dex, 然後上傳到 模擬器的私有目錄的files下。

此時需要結束進程重啓。即可看到更新代碼已經生效。上訴代碼已完成測試。下面去研究一下 android4.4上那個奇怪的問題啦。

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章