浅读腾讯插件化框架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只实现了下载插件之后的安装和升级逻辑。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容