[Android]Android 插件化 Android 插件化

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。