文档开发者中心
我的

鸿蒙和安卓一样动态加载外部Dex包的实现分享

1. 介绍

由于在Android端开发时,将dex包存放在外部的SD卡中,使用PathClassLoader进行加载,但是鸿蒙中未找到相关的ClassLoader,在测试和研究过程中发现其底部报错信息,依然是dalvik.system.DexClassLoader,所以持着怀疑的角度考虑,是不是其加载机制和Android并无区别,所以依然使用了原Android下的加载方式,由于鸿蒙在编译器中未开放dalvik.system.DexClassLoader的使用,所以使用反射进行调用其API。

2. 生成Dex包

由于Android虚拟机的限制,所加载的非Java中的Jar包,也就是不可以直接加载.class字节码,需要将其转换成相关的.dex格式,其可以加载.jar、.zip、.apk、.dex等其内部包含dex包的文件,转换步骤如下(使用Android-SDK):

  1. 在安装的Android-SDK目录下,找到/build-tools/<版本号>/dx.bat工具;
  2. 使用如下命令进行转换(后缀可以直接是.dex,也可以是.jar或是.zip,会将classes.dex文件包含在里面):
收起
自动换行
深色代码主题
复制

dx --dex --output [转换后].dex [需要转换的jar].jar

3. 详细使用介绍

  • 获取需要加载的jar包路径所在的目录下,所有文件后缀为.jar、.dex、.apk、.zip、.rar格式的文件(主要是保证有些jar包中的类有依赖关系)
收起
自动换行
深色代码主题
复制

/** * 动态加载外部指定路径的dex或带有dex的jar包 * * @param path dex或带有dex的jar包路径 * @return 实现了ClassLoader的类加载器 * @throws Exception 抛出 {@code NullPointerException} 空指针; {@code FileNotFoundException} jar包文件不存在。 */ public ClassLoader loadJar(String path) throws Exception { if (TextUtils.isEmpty(path)) { throw new NullPointerException("[LoadJarImpl:loadJar]要加载的路径为空"); } if (!new File(path).exists()) { throw new FileNotFoundException("[LoadJarImpl:loadJar]要加载的文件不存在,路径-->" + path); } loadPathAllJar(path); return context.getClassloader(); } /** * 通过路径截取,加载该路径下的所有jar包(为了解决jar依赖jar的问题) * @param path 要加载的jar包路径 */ private void loadPathAllJar(String path) { if (classPathMap.containsKey(path)) { return; } int index = path.lastIndexOf("/"); String jarFolder = path.substring(0, index); File jarFolderFile = new File(jarFolder); String[] files = null; if (jarFolderFile.isDirectory()) { files = jarFolderFile.list(new FilenameFilter() { @Override public boolean accept(File dir, String name) { //过滤要解析的文件 if (name.endsWith(".jar") || name.endsWith(".dex") || name.endsWith(".apk") || name.endsWith(".zip") || name.endsWith(".rar")) { return true; } return false; } }); } if (files != null && files.length > 0) { int i = 0; for (; i < files.length; i++) { String jarPath = jarFolder + File.separator + files[i]; //注入外部dex List<String> dexClassPath = DexUtils.loadPatchReturnClassPath(context, jarPath); classPathMap.put(jarPath, dexClassPath); } }else { //注入外部dex List<String> dexClassPath = DexUtils.loadPatchReturnClassPath(context, path); classPathMap.put(path, dexClassPath); } }
  • 存储已经加载成功的jar包路径至ClassPathMap(主要保证不会重复去加载该Jar包):

收起
自动换行
深色代码主题
复制

private HashMap<String, List<String>> classPathMap = new HashMap<>(); /** * 通过路径截取,加载该路径下的所有jar包(为了解决jar依赖jar的问题) * @param path 要加载的jar包路径 */ private void loadPathAllJar(String path) { if (classPathMap.containsKey(path)) { return; } ... classPathMap.put(path, dexClassPath); }
  • 创建解压目录

收起
自动换行
深色代码主题
复制

private static final String DEX_OPT_DIR = "dex_opt";File dexOptDir = new File(context.getFilesDir(), DEX_OPT_DIR);dexOptDir.mkdir();
  • 反射创建dalvik.system.DexClassLoader对象(鸿蒙编译器中无法引入此对象)

收起
自动换行
深色代码主题
复制

Object dexClassLoader = Reflect.onClass("dalvik.system.DexClassLoader") .create(dexPath, defaultDexOptPath, dexPath, getPathClassLoader()) .get();
  • 此步骤思路是拿到已加载的DexElements属性中的值,添加需要加载的Jar包的路径,进行组合,然后设置到dexElements属性中(使用的是PathClassLoader)

收起
自动换行
深色代码主题
复制

Object baseDexElements = getDexElements(getPathList(getPathClassLoader()));Object newDexElements = getDexElements(getPathList(dexClassLoader));Object allDexElements = combineArray(newDexElements, baseDexElements);Object pathList = getPathList(getPathClassLoader());ReflectionUtils.setField(pathList, pathList.getClass(), "dexElements", allDexElements);HiLogUtil.getInstance("@@@").error("dexFile=%{public}s", dexPath);
  • 剩下就是可以反射使用Jar包中的类了。

4. 相关源码分享

  • 反射工具类,一个是使用了开源框架JOOR:https://github.com/jOOQ/jOOR;另一个是如下类ReflectionUtils:
收起
自动换行
深色代码主题
复制

​import java.lang.reflect.Field;/** * 反射用工具类 * */public class ReflectionUtils { public static Object getField(Object obj, Class<?> cl, String field) throws NoSuchFieldException, IllegalArgumentException, IllegalAccessException { Field localField = cl.getDeclaredField(field); localField.setAccessible(true); return localField.get(obj); } public static void setField(Object obj, Class<?> cl, String field, Object value) throws NoSuchFieldException, IllegalArgumentException, IllegalAccessException { Field localField = cl.getDeclaredField(field); localField.setAccessible(true); localField.set(obj, value); } /** * 获取Class中指定名称的属性Field * * @param clazz Class对象 * @param fieldName 属性名称 * @return 属性Field对象 * @throws NoSuchFieldException 如果未查找到对应属性,则抛出 */ private Field getField(Class clazz, String fieldName) throws NoSuchFieldException { Field field = null; String classStr = clazz.toString(); //从子类向父类循环查找Field while (clazz != null) { field = clazz.getDeclaredField(fieldName); if (field != null) { if (!field.isAccessible()) { field.setAccessible(true); } return field; } //获取父类字节码,从父类查找 clazz = clazz.getSuperclass(); } //如果未查找到,则抛出异常 if (field == null) { throw new NoSuchFieldException("field: " + fieldName + " not in " + classStr); } return field; }}
  • 使用到的LoadJarImpl类:
收起
自动换行
深色代码主题
复制

import net.sqlcipher.utils.TextUtils;import ohos.app.Context;import java.io.File;import java.io.FileNotFoundException;import java.io.FilenameFilter;import java.util.ArrayList;import java.util.HashMap;import java.util.List;/** * 安卓使用类加载器加载外部dex或带有dex的jar包 * */public class LoadJarImpl { private Context context; private HashMap<String, List<String>> classPathMap = new HashMap<>(); public LoadJarImpl(Context context) { this.context = context; } /** * 动态加载外部指定路径的dex或带有dex的jar包 * * @param path dex或带有dex的jar包路径 * @return 实现了ClassLoader的类加载器 * @throws Exception 抛出 {@code NullPointerException} 空指针; {@code FileNotFoundException} jar包文件不存在。 */ public ClassLoader loadJar(String path) throws Exception { if (TextUtils.isEmpty(path)) { throw new NullPointerException("[LoadJarImpl:loadJar]要加载的路径为空"); } if (!new File(path).exists()) { throw new FileNotFoundException("[LoadJarImpl:loadJar]要加载的文件不存在,路径-->" + path); } loadPathAllJar(path); return context.getClassloader(); } /** * 通过路径截取,加载该路径下的所有jar包(为了解决jar依赖jar的问题) * @param path 要加载的jar包路径 */ private void loadPathAllJar(String path) { if (classPathMap.containsKey(path)) { return; } int index = path.lastIndexOf("/"); String jarFolder = path.substring(0, index); File jarFolderFile = new File(jarFolder); String[] files = null; if (jarFolderFile.isDirectory()) { files = jarFolderFile.list(new FilenameFilter() { @Override public boolean accept(File dir, String name) { //过滤要解析的文件 if (name.endsWith(".jar") || name.endsWith(".dex") || name.endsWith(".apk") || name.endsWith(".zip") || name.endsWith(".rar")) { return true; } return false; } }); } if (files != null && files.length > 0) { int i = 0; for (; i < files.length; i++) { String jarPath = jarFolder + File.separator + files[i]; //注入外部dex List<String> dexClassPath = DexUtils.loadPatchReturnClassPath(context, jarPath); classPathMap.put(jarPath, dexClassPath); } }else { //注入外部dex List<String> dexClassPath = DexUtils.loadPatchReturnClassPath(context, path); classPathMap.put(path, dexClassPath); } }}
  • 使用到的DexUtils类:
收起
自动换行
深色代码主题
复制

import java.io.File;import java.io.IOException;import java.lang.reflect.Array;import java.util.ArrayList;import java.util.Enumeration;import java.util.List;import com.ttxz.harmonydemo.utils.HiLogUtil;import net.sqlcipher.utils.TextUtils;import ohos.app.Context;import org.joor.Reflect;/** * Dex加载工具类 * */public class DexUtils { private static final String DEX_OPT_DIR = "dex_opt"; public static List<String> loadPatchReturnClassPath(Context context, String dexPath){ if (context == null) { throw new NullPointerException("context is null"); } if (!new File(dexPath).exists()) { throw new NullPointerException(dexPath + " is null"); } File dexOptDir = new File(context.getFilesDir(), DEX_OPT_DIR); dexOptDir.mkdir(); try { return injectDexAtFirstReturnClassPath(dexPath, dexOptDir.getAbsolutePath()); } catch (Exception e) { throw new NullPointerException("inject " + dexPath + " failed"); } } /** * 注入指定路径的dex/包含dex的jar、zip、apk等,并返回该包中的所有类的全路径 * @param dexPath 要注入的dex/包含dex的jar、zip、apk路径 * @param defaultDexOptPath dex优化输出路径 * @return 该包中的所有类的全路径 * @throws NoSuchFieldException * @throws IllegalAccessException * @throws ClassNotFoundException */ public static List<String> injectDexAtFirstReturnClassPath(String dexPath, String defaultDexOptPath) throws NoSuchFieldException, IllegalAccessException, ClassNotFoundException { Object dexClassLoader = Reflect.onClass("dalvik.system.DexClassLoader") .create(dexPath, defaultDexOptPath, dexPath, getPathClassLoader()) .get(); Object baseDexElements = getDexElements(getPathList(getPathClassLoader())); Object newDexElements = getDexElements(getPathList(dexClassLoader)); Object allDexElements = combineArray(newDexElements, baseDexElements); Object pathList = getPathList(getPathClassLoader()); ReflectionUtils.setField(pathList, pathList.getClass(), "dexElements", allDexElements); HiLogUtil.getInstance("@@@").error("dexFile=%{public}s", dexPath); return getDexClassPath(newDexElements); } /** * 获取dex文件下所有的类路径 * * @param dexElements * @return 返回所有类路径的集合 * @throws IOException */ public static List<String> getDexClassPath(Object dexElements) throws NoSuchFieldException, IllegalAccessException { ArrayList<String> classPathList = new ArrayList<>(); Object dexElement = ((Object[])dexElements)[0]; //反射获取DexFile Object dexFile = ReflectionUtils.getField(dexElement, dexElement.getClass(), "dexFile"); Enumeration<String> entries = Reflect.on(dexFile).call("entries").get(); while (entries.hasMoreElements()) { String className = entries.nextElement(); if (TextUtils.isEmpty(className)) { continue; } classPathList.add(className); HiLogUtil.getInstance("@@@").error("className=%{public}s", className); } return classPathList; } /** * 获取当前PathClassLoader * @return 返回PathClassLoader对象 */ private static ClassLoader getPathClassLoader() { ClassLoader pathClassLoader = DexUtils.class.getClassLoader(); return pathClassLoader; } /** * 反射获取ClassLoader中的Elements对象实例 * @param paramObject ClassLoader对象 * @return 返回Elements对象实例 * @throws IllegalArgumentException * @throws NoSuchFieldException * @throws IllegalAccessException */ private static Object getDexElements(Object paramObject) throws IllegalArgumentException, NoSuchFieldException, IllegalAccessException { return ReflectionUtils.getField(paramObject, paramObject.getClass(), "dexElements"); } /** * 反射获取PathList对象实例 * @param baseDexClassLoader 当前PathClassLoader对象 * @return PathList对象实例 * @throws IllegalArgumentException * @throws NoSuchFieldException * @throws IllegalAccessException * @throws ClassNotFoundException */ private static Object getPathList(Object baseDexClassLoader) throws IllegalArgumentException, NoSuchFieldException, IllegalAccessException, ClassNotFoundException { return ReflectionUtils.getField(baseDexClassLoader, Class.forName("dalvik.system.BaseDexClassLoader"), "pathList"); } /** * 合并数组 * @param firstArray 要合并的数组A * @param secondArray 要合并的数组B * @return 新数组 */ private static Object combineArray(Object firstArray, Object secondArray) { Class<?> localClass = firstArray.getClass().getComponentType(); int firstArrayLength = Array.getLength(firstArray); int allLength = firstArrayLength + Array.getLength(secondArray); Object result = Array.newInstance(localClass, allLength); for (int k = 0; k < allLength; ++k) { if (k < firstArrayLength) { Array.set(result, k, Array.get(firstArray, k)); } else { Array.set(result, k, Array.get(secondArray, k - firstArrayLength)); } } return result; }}
  • 由于是从原Android项目迁移过来的,未对代码进行优化,目前只是测试通过,可以在鸿蒙上使用,后续正式使用时,还需要重新封装和验证,以及鸿蒙发布新版本时的验证和研究。同样也期待鸿蒙早日推出动态加载的API。
点赞
2
收藏
2
回复
8
分享
举报
浏览1543 发布于2021-09-23 02:25未知归属地
全部评论
最多点赞
最新发布
最早发布
这方法能用来加载har包里面的类吗
6
2楼回复于2022-06-01 08:56 未知归属地
  • 天天小志
    没有测试har包,只是用来测试安卓apk,当时没有鸿蒙设备安装包测试的需求,可以自己测一下。
    2022-06-07 00:51 未知归属地
  • 李大爷丶回复天天小志
    安卓的dx.bat工具对har包进行转换,转换后的包不包含.dex文件,
    2022-06-07 05:52 未知归属地
  • 天天小志回复李大爷丶
    我没有测试har包,测试的是直接加载的还是dex,或者是zip这种,另外现在鸿蒙系统可能有更新,不知道有没有变化,公司没有需求,后续我就没有再研究了
    2022-06-08 05:49 未知归属地
  • 展开剩余3条回复
厉害了楼主,感谢分享~
1楼回复于2021-09-24 08:15 未知归属地
写回答
新增插入模板功能
一键使用模板,快速填写内容,轻松发帖~
知道了
  • 为了保障您的信息安全,请勿上传您的敏感个人信息(如您的密码等信息)和您的敏感资产信息(如关键源代码、签名私钥、调试安装包、业务日志等信息),且您需自行承担由此产生的信息泄露等安全风险。
  • 如您发布的内容为转载内容,请注明内容来源。

我要发帖子

目录 收起
1. 介绍
2. 生成Dex包
3. 详细使用介绍
4. 相关源码分享
了解社区公约,与您携手共创和谐专业的开发者社区。