浅读腾讯插件化框架Shadow

背景

Android发展至今,出现过较多的插件化框架。目前大部分都是使用hook系统的方式来做的。类似通过Hook Instrumentation 类将插件activity替换成占坑activity,在系统回调时,通过hook ActivityThread 的 H再把占坑activity替换成插件activity的VirtualAPK和Atlas。或者通过首先记录占坑 Activity 和 插件Activity 的映射关系,然后在ClassLoader的 load 占坑 Activity 类的的时候,根据之前记录的映射关系, 加载插件Activity的Replugin。
腾讯在2019年开源了零反射无Hack的全动态插件化框架Shadow。

项目的目录结构


├── projects
│  ├── sample // 示例代码
│  │  ├── sample-constant // sample中使用的一些常量
│  │  ├── sample-host // 宿主
│  │  ├── sample-manager // PluginManager的实现
│  │  └── sample-plugin // 插件的实现(sample的loader、runtime、app)
│  ├── sdk // 框架实现代码
│  │  ├── core
│  │  │  ├── common
│  │  │  ├── gradle-plugin // gradle 插件
│  │  │  ├── load-parameters
│  │  │  ├── loader // 负责加载插件
│  │  │  ├── manager // 装载插件,管理插件
│  │  │  ├── runtime // 插件运行时需要,包括占位 Activity,占位 Provider 等等
│  │  │  ├── transform // Transform 实现,用于替换插件 Activity 父类等等
│  │  │  └── transform-kit
│  │  └── dynamic // 插件自身动态化实现,包括一些接口的抽象

sample示例代码

sample-host

1.完成PluginManager的apk和PluginZip文件的初始化(PluginHelper)。
2.实现DynamicPluginManager的初始化(Shadow)。
3.实现PluginProcessService(PluginProcessPPS,通过Binder提供给其他插件调用)。
4.在manifest中注册Service、容器Activity(sample-runtime)、容器ContentProvider等所需资源。

sample-manager

1.实现PluginManager
2.WhiteList,classLoader的白名单
3.实现ManagerFactoryImpl,在buildManager中,完成PluginManager的初始化,供宿主中DynamicPluginManager使用。
WhiteList、ManagerFactoryImpl类名与包名固定,在ManagerImplLoader和其父类ImplLoader中硬编码匹配。

sample-plugin

sample-loader

1.实现PluginLoader
2.WhiteList,classLoader的白名单
3.实现CoreLoaderFactoryImpl,在build中,完成PluginLoader的初始化,供DynamicPluginLoader使用,再通过Binder,供宿主中PluginProcessService和pluginManager使用,此时也会将UuidManager提供给DynamicPluginLoader使用。
WhiteList、ManagerFactoryImpl类名与包名固定,在ManagerImplLoader和其父类ImplLoader中硬编码匹配。

sample-runtime

在sample中实现了default、singleTask和singleInstance三类PluginContainerActivity。

sample-plugin-app

包含了lib的module,加载lib的插件app,以及打包等功能。

实现

plugin打包

关键字:Plugin, Transform

image

初始化

关键字:ClassLoader, Binder

init.png

ApkClassLoader,如果目标类符合构造时传入的包名,则从parent ClassLoader中查找,否则先从自己的dexPath中查找,如果找不到,则再从parent的parent ClassLoader中查找。(PluginManager, DynamicPluginLoader)

@Override
    protected Class loadClass(String className, boolean resolve) throws ClassNotFoundException {
        ……
        //如果在白名单内
        if (isInterface) {
            return super.loadClass(className, resolve);
        } else {
            Class clazz = findLoadedClass(className);

            if (clazz == null) {
                ClassNotFoundException suppressed = null;
                try {
                    clazz = findClass(className);
                } catch (ClassNotFoundException e) {
                    suppressed = e;
                }

                if (clazz == null) {
                    try {
                        clazz = mGrandParent.loadClass(className);
                    } catch (ClassNotFoundException e) {
                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
                            e.addSuppressed(suppressed);
                        }
                        throw e;
                    }
                }
            }

            return clazz;
        }
    }

RuntimeClassLoader(继承自BaseDexClassLoader),使其在原ClassLoader和Parent之间。

private static void hackParentToRuntime(InstalledApk installedRuntimeApk, ClassLoader contextClassLoader) throws Exception {
        RuntimeClassLoader runtimeClassLoader = new RuntimeClassLoader(installedRuntimeApk.apkFilePath, installedRuntimeApk.oDexPath,
                installedRuntimeApk.libraryPath, contextClassLoader.getParent());
        hackParentClassLoader(contextClassLoader, runtimeClassLoader);
    }


    /**
     * 修改ClassLoader的parent
     *
     * @param classLoader          需要修改的ClassLoader
     * @param newParentClassLoader classLoader的新的parent
     * @throws Exception 失败时抛出
     */
    static void hackParentClassLoader(ClassLoader classLoader,
                                              ClassLoader newParentClassLoader) throws Exception {
        Field field = getParentField();
        if (field == null) {
            throw new RuntimeException("在ClassLoader.class中没找到类型为ClassLoader的parent域");
        }
        field.setAccessible(true);
        field.set(classLoader, newParentClassLoader);
    }

PluginClassLoader

override fun loadClass(className: String, resolve: Boolean): Class<*> {
        if (specialClassLoader == null) {//specialClassLoader 为null 表示该classLoader依赖了其他的插件classLoader,需要遵循双亲委派
            return super.loadClass(className, resolve)
        } else if (className.subStringBeforeDot() == "com.tencent.shadow.core.runtime") {
            return loaderClassLoader.loadClass(className)
        } else if (className.inPackage(allHostWhiteList)
                || (Build.VERSION.SDK_INT < 28 && className.startsWith("org.apache.http"))) {//Android 9.0以下的系统里面带有http包,走系统的不走本地的) {
            return super.loadClass(className, resolve)
        } else {
            var clazz: Class<*>? = findLoadedClass(className)

            if (clazz == null) {
                var suppressed: ClassNotFoundException? = null
                try {
                    clazz = findClass(className)!!
                } catch (e: ClassNotFoundException) {
                    suppressed = e
                }
                if (clazz == null) {
                    try {
                        clazz = specialClassLoader.loadClass(className)!!
                    } catch (e: ClassNotFoundException) {
                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
                            e.addSuppressed(suppressed)
                        }
                        throw e
                    }

                }
            }

            return clazz
        }
    }

delegate

关键字:Delegate, Javapoet
以Activity为例,ActivityCodeGenerator通过square公司提供的Javapoet,生成Delegate与Delegator相关的java代码。有两个地方比较有趣,分别是getCustomMethods和getActivityCallbackMethods。例如:

val startWithOnMethods = getActivityMethods(clazz)
                    .filter {
                        java.lang.reflect.Modifier.isPublic(it.modifiers) or
                                java.lang.reflect.Modifier.isProtected(it.modifiers)
                    }.filter {
                        it.name.startsWith("on")
                    }
            callbacks.addAll(startWithOnMethods)
image

TODO

由于依赖腾讯内部后台框架服务,Shadow开源的代码,目前是没有包括版本检查和插件下载。manager只实现了下载插件之后的安装和升级逻辑。

你可能感兴趣的:(浅读腾讯插件化框架Shadow)