前面已经介绍了Android平台上的几种ClassLoader,这几种ClassLoader都有各自的使用场景,有了这些基础知识之后,才能更好地理解以及探究Android热修复技术。首先我们来探究怎么动态加载外部资源。
1. 动态加载外部资源
在Android中,资源文件一般指定义在res资源文件夹中的各种文件,常用到的有字符串资源strings.xml、颜色资源colors.xml、drawable文件等。动态加载外部资源的目标,是从一个外部的apk文件中加载资源文件,该apk文件可以是从网络下载的,可以是存在于手机存储目录中的等等。
可以想象这样一种使用场景,当你的APP需要具有换肤功能,用户只需要下载符合你规范的apk文件(包含皮肤的资源图片文件等),使用动态加载资源的方式,加载你下载的apk文件中的资源图片文件,就能轻松实现换肤功能,这样用户不需要升级APP,只需要下载他喜欢的皮肤apk文件就可以了,极大地提高了应用的灵活性。
2. 实现思路
PathClassLoader只能加载手机里已经安装的apk文件,只有DexClassLoader能加载任意目录(有读写权限)的apk文件。所以我们考虑先使用DexClassLoader来加载外部的apk文件,再通过该ClassLoader去加载特定的类,最后通过反射来调用类里的方法,从而获取外部资源
3. 实现案例
首先,我们需要有2个工程:一个是宿主工程,用来加载外部资源;另一个是插件工程,用来提供外部资源。
3.1 插件工程
我们定义一个字符串资源、一个颜色资源、一个图片资源,然后创建一个类来读取这些资源。
- 字符串资源定义
插件APK资源里的文本内容
- 颜色资源定义
#66
- 在图片文件夹里放一个名为test.png的图片
- 创建读取资源文件的类及方法
package com.hjy.plugin;
import android.content.Context;
import android.graphics.drawable.Drawable;
public class Utils {
/**
* 直接返回文本字符串
*
* @return
*/
public static String getTextFromPlugin() {
return "插件APK类里的文本内容";
}
/**
* 读取资源文件里的文本字符串
*
* @param context
* @return
*/
public static String getTextFromPluginRes(Context context) {
return context.getResources().getString(R.string.content_plugin);
}
public static Drawable getDrawableFromPlugin(Context context) {
return context.getResources().getDrawable(R.mipmap.test);
}
public static int getColorFromPlugin(Context context) {
return context.getResources().getColor(R.color.color_from_plugin);
}
}
该类提供了几个静态方法,分别来读取包里的字符串、颜色、图片。
编译好该插件工程后,我们将生成的apk文件命名为plugin-debug.apk,将该apk文件复制到手机SD卡根目录,可使用命令"adb push plugin-debug.apk /mnt/sdcard/plugin-debug.apk
"。不一定要放到SD卡根目录,可以是手机上的任何存储目录,只要具有读写权限即可,我这里只是为了演示方便而已,下面都将以该目录为准。
3.2 宿主工程
我们创建一个宿主工程,加载插件工程生成的apk文件,并显示出插件里的资源。
public class MainActivity extends AppCompatActivity {
private Button mBtnTest;
private TextView mTvText1;
private TextView mTvText2;
private ImageView mIvImg;
private DexClassLoader mCustomClassLoader;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mBtnTest = findViewById(R.id.btn_test);
mTvText1 = findViewById(R.id.tv_text1);
mTvText2 = findViewById(R.id.tv_text2);
mIvImg = findViewById(R.id.iv_image);
//优化后的dex文件输出目录,应用必须具备读写权限
String optimizedDirectory = getDir("dex", MODE_PRIVATE).getAbsolutePath();
mCustomClassLoader = new DexClassLoader("/mnt/sdcard/plugin-debug.apk", optimizedDirectory, null, getClassLoader());
mBtnTest.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
loadResFromPluginApk();
}
});
}
private void loadResFromPluginApk() {
try {
Class clazz = mCustomClassLoader.loadClass("com.hjy.plugin.Utils");
//加载插件里类中定义的字符串资源
Method method = clazz.getMethod("getTextFromPlugin", new Class[]{});
String text = (String) method.invoke(null);
mTvText1.setText(text);
//加载插件里的字符串资源
method = clazz.getMethod("getTextFromPluginRes", Context.class);
text = (String) method.invoke(null, MainActivity.this);
mTvText2.setText(text);
//加载插件里的颜色资源
method = clazz.getMethod("getColorFromPlugin", Context.class);
int color = (int) method.invoke(null, MainActivity.this);
mTvText2.setTextColor(color);
//加载插件里的图片资源
method = clazz.getMethod("getDrawableFromPlugin", Context.class);
Drawable drawable = (Drawable) method.invoke(null, MainActivity.this);
mIvImg.setImageDrawable(drawable);
} catch (Exception e) {
e.printStackTrace();
}
}
}
代码很简单,就是自己构造了一个DexClassLoader对象,通过该ClassLoader去加载插件里Utils类,然后通过反射调用Utils类里的各个方法。其中/mnt/sdcard/plugin-debug.apk对应的就是插件apk在手机中的存储地址,根据实际情况而定。
3.3 执行效果
我们先运行插件工程,将插件apk传入手机里面。然后再运行宿主工程,点击测试按钮开始动态加载资源。很遗憾的是,这并没有达到我们的预期效果,你只会看到第一个TextView有文本显示,其内容为"插件APK类里的文本内容",第二个TextView显示的文本并不是插件工程里定义的,第三个ImageView的内容为空,并且控制台可以看到抛出了android.content.res.Resources$NotFoundException异常,也就是资源未找到。
3.4 异常分析
从执行结果中可以看到,在宿主工程中反射调用Utils类的方法时,只有第一个方法返回成功,后面几个方法执行都出现异常,到这里是不是有点沮丧了,第一个方法能正确返回内容,这说明插件apk已经被正确的加载了,但是为什么后面的几个都失败了呢?
别急,我们来看看第一个方法与其他的有什么差别。第一个方法为getTextFromPlugin(),没带任何参数,直接返回的是一个固定的字符串,第二个方法为getTextFromPluginRes(Context context),带有一个参数Context,通过Context去获取资源,由此我们断定问题是不是就出在这里。
在Android中,apk中的资源都是通过Resources对象来获取的,我们在反射调用后面几个方法时,Context参数传入的是MainActivity.this,这个是宿主工程的Context,因此加载插件apk资源用的实际是宿主的Resources对象,但是宿主的Resources对象目前并不能访问插件apk的资源,所以会出现资源找不到的异常。
4. 访问外部资源的正确姿势
上面这个例子中可以分析出,从宿主工程中的Context对象获取到的Resources对象,无法加载插件apk中的资源文件,只需要解决该问题,那么我们的动态加载资源就大功告成了。
通过Context.getResources()方法,可以获取到Resources对象,所以我们需要重写宿主工程的getResources()方法,重新创建一个能读取插件apk资源的Resources对象,在宿主工程的MainActivity类中,需要完善的代码如下:
/**
* 1.重新创建一个AssetManager资源管理器,通过反射调用addAssetPath()方法,可以加载插件apk中的资源。
*
* 2.依赖第一步创建的AssetManager,重新创建一个Resources对象,该Resources对象包含了插件apk中的资源。
*
* 3.插件apk中的资源是通过Context.getResources()来获取的,因此需要重写Context的getResources()方法,返回前面创建的Resources对象。
*
* @param dexPath 插件路径
*/
protected void loadPluginResource(String dexPath) {
try {
AssetManager assetManager = AssetManager.class.newInstance();
Method method = assetManager.getClass().getMethod("addAssetPath", String.class);
method.invoke(assetManager, dexPath);
mAssetManager = assetManager;
} catch (Exception e) {
e.printStackTrace();
}
Resources resource = getResources();
mResources = new Resources(mAssetManager, resource.getDisplayMetrics(), resource.getConfiguration());
mTheme = mResources.newTheme();
mTheme.setTo(super.getTheme());
}
@Override
public AssetManager getAssets() {
return mAssetManager != null ? mAssetManager : super.getAssets();
}
@Override
public Resources getResources() {
return mResources != null ? mResources : super.getResources();
}
@Override
public Resources.Theme getTheme() {
return mTheme != null ? mTheme : super.getTheme();
}
在onCreate()中加入初始化代码:
loadPluginResource("/mnt/sdcard/plugin-debug.apk");
这里的关键代码是用了AssetManager的addAssetPath()方法,这是一个隐藏的方法,所以需要采用反射来调用。重新运行宿主工程,一切OK,插件apk中的字符串、颜色、图片都能正确加载了,动态加载资源到此就初步完成了。
5. 其他问题
5.1 宿主工程能正确加载自己工程里的资源吗?
答案是否定的,原因是宿主工程MainActivity类中的Resources对象是我们新建的,它只绑定了插件apk中的资源,可以写段测试代码试试看:
System.out.println(getString(R.string.app_name));
你会发现打印出来的是插件apk的app_name,访问本工程其他的资源文件也会出现异常。到这里是不是很头疼,本来以为能动态加载外部apk的资源文件了,结果发现本工程的资源文件无法正常加载,本末倒置了,那怎么解决这个问题呢?既然我们知道资源文件是通过Resources对象来加载,那我们只需要在插件工程里,将Context参数改成Resources,然后在宿主工程反射调用插件apk的方法时,只传入自己构造的Resources参数即可,完全没必要重写宿主工程MainActivity类里的getResources()方法,这样避免了宿主工程原本的Resources被污染破坏。
5.2 通过反射获取插件工程的资源id
我们这个例子中,插件工程的几个方法是获取固定的资源文件,如果有很多资源文件,那岂不是要写很多对应的方法,这显然不是我们想要的,同样我们可以通过反射来获取资源的id,这要宿主工程调用插件工程的方法时,只需要传入资源名称即可。
/**
* 通过资源名反射获取资源id
*
* @param pkgName 包名
* @param type 资源类型,如:string, mipmap, drawable等
* @param resName 资源名称
* @return 资源id
*/
private int getResId(String pkgName, String type, String resName) {
//构造R文件内部类的类名
String className = pkgName + ".R$" + type;
try {
Class clazz = mCustomClassLoader.loadClass(className);
Field field = clazz.getField(resName);
field.setAccessible(true);
Integer id = (Integer) field.get(null);
return id;
} catch (ClassNotFoundException e) {
e.printStackTrace();
} catch (NoSuchFieldException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return 0;
}
通过反射获取插件apk里的字符串资源content_plugin,代码如下:
int resId = getResId("com.hjy.plugin","string", "content_plugin");
System.out.println(mResources.getString(resId));
这样是不是灵活了很多。
6. 小结
本文只是初步探究了怎么去动态加载外部资源,但这是管中窥豹,有很多问题还没有解决,不过当了解这些之后,谈到这些话题的时候就不会觉得那么高深莫测了。
参考文章
Android应用程序资源管理器(Asset Manager)的创建过程分析