Android 插件化

本人所有文章禁止任何形式的转载

前提

做了一个文件夹管理应用giant-explorer，链接https://github.com/storytellerF/common-ui-list-structure，在完成基础功能之后，希望剩下的功能都通过插件完成。

插件有别于热修复，热修复不希望知道用户感知到进行了热修复，而插件需要用户手动安装或者确认，必要情况下还需要用户同意相关权限和政策。

插件化有三个选择：

1. 安装后的apk

   与正常的app 没有什么区别，不过我们可以做一些特殊操作，让用户主动选择使用某个插件打开，而不是弹出来一个选择器。

2. 未安装的apk

   解析class 后在当前app 进程实例化。本来的想法是加载一个aar文件，不过aar 文件还不能被class loder 加载，遂放弃。

3. 前端插件

   有人会说android 也算是一定的前端了，其实这种问题不太好讨论，Android 也可以开发服务器应用，浏览器也可以执行node.js的代码，所以后面还是使用第几种插件来进行描述。

正题

1. 第一种插件

   在Android 中，不同的app 之间需要进程间通信，因为本来宿主应用就是一个文件管理应用，所以顺其自然就使用了content provider 作为进程间通信的方式。

   宿主应用构建一个uri，传递给插件，插件通过contentResolver.openFileDescriptor(u, "r") 获取fileDescriptor (某些代码中会写作fd，这是Linux 中的概念，相当于id)，然后我们通过这个fd 获取文件内容。比如我们获取图片的fd 然后加载到ImageView 上。

   val fileDescriptor = parcelFileDescriptor?.fileDescriptor ?: return
   val decodeStream = BitmapFactory.decodeFileDescriptor(fileDescriptor)
   findViewById.setImageBitmap(decodeStream)
   

   然后在插件中设置一个Intent Filter，用于宿主应用搜索，标明自己可以作为插件运行。

   <intent-filter>
   
       <action android:name="com.storyteller_f.action.giant_explorer.PLUGIN" />
       <category android:name="android.intent.category.DEFAULT" />
       <data
           android:mimeType="image/*"
           android:scheme="content" />
   </intent-filter>
   
   <meta-data
       android:name="group"
       android:value="view" />
   <meta-data
       android:name="title"
       android:value="@string/app_name" />
   

   下面的meta-data 你可能会比较奇怪，其实他们是用来添加一些额外的信息，因为展示出来的按钮总要有个名字，所以我们需要通过这种方式指明，这样甚至也有i18n 功能，真不错。

   然后是宿主应用搜索

   val activities = requireContext().packageManager.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY or PackageManager.GET_META_DATA)
   activities.forEach {
       val activityInfo = it?.activityInfo ?: return@forEach
       val groups = activityInfo.metaData?.getString("group")?.split("/") ?: return@forEach
       val title = activityInfo.metaData?.getString("title") ?: return@forEach
       this.menu.loopAdd(groups).add(title).setOnMenuItemClickListener {
           intent.setPackage(requireContext().packageName).component = ComponentName(activityInfo.packageName, activityInfo.name)
           startActivity(intent)
           return@setOnMenuItemClickListener true
       }
   }
   
   private fun Menu.loopAdd(strings: List<String>): Menu {
       return strings.fold(this) { t, e ->
           t.addSubMenu(e)
       }
   }
   

   这段代码是从项目中复制的，所以还是挺长的。

   首先第一行获取能够处理相应的mimeType 的activity。PackageManager.GET_META_DATA 是必须的，不然我们不能获得那个meta-data。

   然后是通过loopAdd 迭代添加menu，fold 可以非常方便我们实现迭代功能，但不需要我们自己去写，毕竟函数式编程。第一次的t 是我们传入的this，下一次的t 就不是this 了，而是t.addSubMenu(e) 的返回值，也就是下一个菜单， great👌。

   最后一步

   <queries>
       <intent>
           <action android:name="com.storyteller_f.action.giant_explorer.PLUGIN" />
   
           <category android:name="android.intent.category.DEFAULT" />
   
           <data
               android:mimeType="*/*"
               android:scheme="content" />
       </intent>
   </queries>
   

   谷歌不允许使用<uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"/> 这样的宽泛的权限，必须明确指定我们需要的查询的包。

2. 第二种插件

   如果activity 没有在manifest 中声明，安卓会抛出一个异常，很显然我们的插件的activity 是没有在manifest 中声明。

   你可能会说我们可以使用hook 欺骗系统，而且有很多的库，都不用自己写，但是使用hook 的方式会使我们的app 变得不稳定，在我看来属于下策，是在没有办法的时候才使用。

   🤔

   那么我们顺且自然就会想到使用Fragment 作为我们的插件载体，即没有hook，也不需要处理生命周期，也不需要让我们插件继承一个奇奇怪怪的activity，完完全全符合谷歌的设计，也符合本人编程原则，岂不美哉。

   使用DexClassLoader 加载一个apk 文件，此class loader 会自动加载dex 文件，即使这个apk 中有多个dex 也能正常工作，great。

   val dexClassLoader = DexClassLoader(file.absolutePath, null, null, classLoader)
   
   val loadClass = dexClassLoader.loadClass("com.storyteller_f.yue_plugin.YueFragment")
   val newInstance = loadClass.newInstance()
   

   然后我们还需要处理resounces，Android 的所有资源都是通过Resources 获取，而且Fragment 是直接使用的宿主activity 的Resources，再一次的great。

   /**
    * Return <code>requireActivity().getResources()</code>.
    */
   @NonNull
   final public Resources getResources() {
       return requireContext().getResources();
   }
   

   我们使用懒加载的方式加载插件的资源。这个资源在apk 中，虽然我们没有安装它。

   private val pluginResources by lazy {
       val packageArchiveInfo = packageManager.getPackageArchiveInfo(File(cacheDir, "app-debug.apk").absolutePath, 0)
       val applicationInfo = packageArchiveInfo?.applicationInfo
       if (applicationInfo != null)
           packageManager.getResourcesForApplication(applicationInfo)
       else null
   }
   

   然后是我们的宿主activity

   override fun getResources(): Resources {
       val stackTrace = Thread.currentThread().stackTrace
       val listOf = listOf("com.storyteller_f.yue_plugin.ImageViewFragment", "com.storyteller_f.yue_plugin.YueFragment")
       if (stackTrace.any {
               listOf.contains(it.className)
           }) {
           return pluginResources!!
       }
       return super.getResources()
   }
   

   我们不需要使用try-catch 的方式在找不到资源时从插件中加载，我们直接判断发起此次调用时插件还是正常的宿主activity，毕竟Android 没有启用切换线程去获取Resources。

   感觉安卓的设计就是为了我今天实现插件功能啊（开个玩笑）。

3. 第三种插件

   安卓的WebView 允许我们使用addJavascriptInterface 让JavaScript 调用安卓的代码，这也是我们第三种插件存在的主要基础。毕竟不能为了一个插件功能把chromium 放进来。

   基础的设置一个WebView 就不讲了。

   val pluginManager = object : GiantExplorerPluginManager {
   
       @JavascriptInterface
       override fun fileInputStream(path: String) = getFileInstance(path, this@WebViewPluginActivity).fileInputStream
   
       @JavascriptInterface
       override fun fileOutputStream(path: String) = getFileInstance(path, this@WebViewPluginActivity).fileOutputStream
   
       @JavascriptInterface
       override fun listFiles(path: String): List<String> {
           return getFileInstance(path, this@WebViewPluginActivity).listSafe().let { filesAndDirectories ->
               filesAndDirectories.files.map {
                   it.fullPath
               } + filesAndDirectories.directories.map {
                   it.fullPath
               }
           }
       }
   
       @JavascriptInterface
       fun base64(path: String): String {
           val readBytes = fileInputStream(path).readBytes()
           return Base64.encodeToString(readBytes, Base64.NO_WRAP)
       }
   
   }
   webView.addJavascriptInterface(pluginManager, "plugin")
   
   

   前三个方法是第二种插件也需要用的，最后一个base64(path: String) 是，第三种插件独有的，用来给JavaScript 发送文件内容。

   演示一下在插件中显示我们的图片：

   <html>
   <body>
   <img id="ci" src="">
   <script>
       document.write(file.fullPath())
       let ele = document.getElementById("ci")
       ele.src = "data:image/png;base64," + plugin.base64(file.fullPath())
   
   </script>
   </body>
   </html>
   

最后

写代码也要有所为，有所不为。写完博客，去看三体，great。