在Android熱更新實現(xiàn)原理淺析一文中,我們簡單分析了Android熱更新的實現(xiàn)原理斤彼,那么趕緊趁熱打鐵分瘦,一步一步手動實現(xiàn)熱更新,萊茨狗琉苇。所見即所得嘲玫,先看一下最終要達(dá)成的效果。
貼一下Demo的地址
https://github.com/lxbnjupt/HotFixDemo
一并扇、熱更新代碼實現(xiàn)
基于之前的分析去团,我們知道實現(xiàn)熱更新可以分為以下幾個步驟:
- 通過構(gòu)造一個DexClassLoader對象來加載我們的熱更新dex文件;
- 通過反射獲取系統(tǒng)默認(rèn)的PathClassLoader.pathList.dexElements拜马;
- 將我們的熱更新dex與系統(tǒng)默認(rèn)的Elements數(shù)組合并渗勘,同時保證熱更新dex在系統(tǒng)默認(rèn)Elements數(shù)組之前;
- 將合并完成后的數(shù)組設(shè)置回PathClassLoader.pathList.dexElements俩莽。
Talk is cheap, show me the code.
public class HotFixUtils {
private static final String TAG = "lxbnjupt";
private static final String NAME_BASE_DEX_CLASS_LOADER = "dalvik.system.BaseDexClassLoader";
private static final String FIELD_DEX_ELEMENTS = "dexElements";
private static final String FIELD_PATH_LIST = "pathList";
private static final String DEX_SUFFIX = ".dex";
private static final String APK_SUFFIX = ".apk";
private static final String JAR_SUFFIX = ".jar";
private static final String ZIP_SUFFIX = ".zip";
private static final String DEX_DIR = "patch";
private static final String OPTIMIZE_DEX_DIR = "odex";
public void doHotFix(Context context) throws IllegalAccessException, NoSuchFieldException, ClassNotFoundException {
if (context == null) {
return;
}
// 補丁存放目錄為 /storage/emulated/0/Android/data/com.lxbnjupt.hotfixdemo/files/patch
File dexFile = context.getExternalFilesDir(DEX_DIR);
if (dexFile == null || !dexFile.exists()) {
Log.e(TAG,"熱更新補丁目錄不存在");
return;
}
File odexFile = context.getDir(OPTIMIZE_DEX_DIR, Context.MODE_PRIVATE);
if (!odexFile.exists()) {
odexFile.mkdir();
}
File[] listFiles = dexFile.listFiles();
if (listFiles == null || listFiles.length == 0) {
return;
}
String dexPath = getPatchDexPath(listFiles);
String odexPath = odexFile.getAbsolutePath();
// 獲取PathClassLoader
PathClassLoader pathClassLoader = (PathClassLoader) context.getClassLoader();
// 構(gòu)建DexClassLoader旺坠,用于加載補丁dex
DexClassLoader dexClassLoader = new DexClassLoader(dexPath, odexPath, null, pathClassLoader);
// 獲取PathClassLoader的Element數(shù)組
Object pathElements = getDexElements(pathClassLoader);
// 獲取構(gòu)建的DexClassLoader的Element數(shù)組
Object dexElements = getDexElements(dexClassLoader);
// 合并Element數(shù)組
Object combineElementArray = combineElementArray(pathElements, dexElements);
// 通過反射,將合并后的Element數(shù)組賦值給PathClassLoader中pathList里面的dexElements變量
setDexElements(pathClassLoader, combineElementArray);
}
/**
* 獲取補丁dex文件路徑集合
* @param listFiles
* @return
*/
private String getPatchDexPath(File[] listFiles) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < listFiles.length; i++) {
// 遍歷查找文件中.dex .jar .apk .zip結(jié)尾的文件
File file = listFiles[i];
if (file.getName().endsWith(DEX_SUFFIX)
|| file.getName().endsWith(APK_SUFFIX)
|| file.getName().endsWith(JAR_SUFFIX)
|| file.getName().endsWith(ZIP_SUFFIX)) {
if (i != 0 && i != (listFiles.length - 1)) {
// 多個dex路徑 添加默認(rèn)的:分隔符
sb.append(File.pathSeparator);
}
sb.append(file.getAbsolutePath());
}
}
return sb.toString();
}
/**
* 合并Element數(shù)組扮超,將補丁dex放在最前面
* @param pathElements PathClassLoader中pathList里面的Element數(shù)組
* @param dexElements 補丁dex數(shù)組
* @return 合并之后的Element數(shù)組
*/
private Object combineElementArray(Object pathElements, Object dexElements) {
Class<?> componentType = pathElements.getClass().getComponentType();
int i = Array.getLength(pathElements);// 原dex數(shù)組長度
int j = Array.getLength(dexElements);// 補丁dex數(shù)組長度
int k = i + j;// 總數(shù)組長度(原dex數(shù)組長度 + 補丁dex數(shù)組長度)
Object result = Array.newInstance(componentType, k);// 創(chuàng)建一個類型為componentType取刃,長度為k的新數(shù)組
System.arraycopy(dexElements, 0, result, 0, j);// 補丁dex數(shù)組在前
System.arraycopy(pathElements, 0, result, j, i);// 原dex數(shù)組在后
return result;
}
/**
* 獲取Element數(shù)組
* @param classLoader 類加載器
* @return
* @throws ClassNotFoundException
* @throws NoSuchFieldException
* @throws IllegalAccessException
*/
private Object getDexElements(ClassLoader classLoader) throws ClassNotFoundException, NoSuchFieldException, IllegalAccessException {
// 獲取BaseDexClassLoader,是PathClassLoader以及DexClassLoader的父類
Class<?> BaseDexClassLoaderClazz = Class.forName(NAME_BASE_DEX_CLASS_LOADER);
// 獲取pathList字段出刷,并設(shè)置為可以訪問
Field pathListField = BaseDexClassLoaderClazz.getDeclaredField(FIELD_PATH_LIST);
pathListField.setAccessible(true);
// 獲取DexPathList對象
Object dexPathList = pathListField.get(classLoader);
// 獲取dexElements字段璧疗,并設(shè)置為可以訪問
Field dexElementsField = dexPathList.getClass().getDeclaredField(FIELD_DEX_ELEMENTS);
dexElementsField.setAccessible(true);
// 獲取Element數(shù)組,并返回
return dexElementsField.get(dexPathList);
}
/**
* 通過反射馁龟,將合并后的Element數(shù)組賦值給PathClassLoader中pathList里面的dexElements變量
* @param classLoader PathClassLoader類加載器
* @param value 合并后的Element數(shù)組
* @throws ClassNotFoundException
* @throws NoSuchFieldException
* @throws IllegalAccessException
*/
private void setDexElements(ClassLoader classLoader, Object value) throws ClassNotFoundException, NoSuchFieldException, IllegalAccessException {
// 獲取BaseDexClassLoader崩侠,是PathClassLoader以及DexClassLoader的父類
Class<?> BaseDexClassLoaderClazz = Class.forName(NAME_BASE_DEX_CLASS_LOADER);
// 獲取pathList字段,并設(shè)置為可以訪問
Field pathListField = BaseDexClassLoaderClazz.getDeclaredField(FIELD_PATH_LIST);
pathListField.setAccessible(true);
// 獲取DexPathList對象
Object dexPathList = pathListField.get(classLoader);
// 獲取dexElements字段坷檩,并設(shè)置為可以訪問
Field dexElementsField = dexPathList.getClass().getDeclaredField(FIELD_DEX_ELEMENTS);
dexElementsField.setAccessible(true);
// 將合并后的Element數(shù)組賦值給dexElements變量
dexElementsField.set(dexPathList, value);
}
}
相信代碼中的注釋已經(jīng)非常清楚了却音,這里就不再過多贅述。
不過矢炼,有一點需要注意一下系瓢,就是不要忘記打開讀寫手機存儲權(quán)限:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
二、測試驗證
2.1 將java文件編譯成class文件
完成修復(fù)bug之后句灌,使用Android Studio的Rebuild Project功能將代碼進(jìn)行編譯夷陋,然后從build目錄下找到對應(yīng)的class文件。
2.2 將class文件打包成dex文件
step1:
將修復(fù)好的class文件復(fù)制到其他任意地方,我這邊是選擇復(fù)制到桌面骗绕。注意藐窄,在復(fù)制這個class文件時,需要把它所在的完整包目錄一起復(fù)制爹谭。上圖中修復(fù)好的class文件是BugTest.class枷邪,其復(fù)制出來的目錄結(jié)構(gòu)如下圖所示:
step2:
通過dx命令生成dex文件
dx命令的使用有2種選擇:
- 配置環(huán)境變量(添加到classpath),然后命令行窗口(終端)可以在任意位置使用诺凡。
-
不配環(huán)境變量,直接在build-tools/Android版本目錄下使用命令行窗口(終端)使用践惑。
這里直接使用第2種方式腹泌,命令如下:
dx --dex --output=輸出的dex文件完整路徑 (空格) 要打包的完整class文件所在目錄
完成之后,我們可以進(jìn)到桌面文件夾下查看dex文件是否已經(jīng)生成尔觉,我這邊是成功生成了patch.dex文件凉袱。
2.3 將dex文件push至手機
通過adb命令adb push <local> <remote>,可以將dex文件推到手機指定目錄侦铜。在上面的demo中专甩,我設(shè)置的熱更新dex文件的存放路徑是/storage/emulated/0/Android/data/com.lxbnjupt.hotfixdemo/files/patch
2.4 真機運行測試
MainActivity.java
public class MainActivity extends AppCompatActivity {
private static final String DEX_DIR = "patch";
private Button btnRun;
private Button btnRepair;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
btnRun = (Button) findViewById(R.id.btn_run);
btnRepair = (Button) findViewById(R.id.btn_repair);
init();
setOnClickListener();
}
private void init() {
// 補丁存放目錄為 /storage/emulated/0/Android/data/com.lxbnjupt.hotfixdemo/files/patch
File patchDir = new File(this.getExternalFilesDir(null), DEX_DIR);
if (!patchDir.exists()) {
patchDir.mkdirs();
}
}
private void setOnClickListener() {
btnRun.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new BugTest().getBug();
}
});
btnRepair.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
try {
new HotFixUtils().doHotFix(MainActivity.this);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (NoSuchFieldException e) {
e.printStackTrace();
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
});
}
}
如文章開始的gif圖所示,打開App钉稍,點擊「運行」按鈕涤躲,應(yīng)用程序會因為NullPointerException直接crash。再次打開App贡未,先點擊「修復(fù)」按鈕种樱,再點擊「運行」按鈕,此時應(yīng)用程序不會再出現(xiàn)crash俊卤,表示補丁加載成功嫩挤,bug成功修復(fù)。至此消恍,大功告成岂昭!