外掛化知識梳理(3) Small 框架之宿主分身

澤毛發表於2017-12-21

一、前言

外掛化知識梳理(1) - Small 框架之如何引入應用外掛外掛化知識梳理(2) - Small 框架之如何引入公共庫外掛 前兩篇文章中,我們介紹瞭如何通過Small框架來實現應用外掛及公共庫外掛,今天,我再來介紹一個新的知識點 - 宿主分身。

與應用外掛和公共庫外掛不同,宿主分身會作為宿主的一部分,被編譯到宿主當中,因此它不能被獨立更新,但是它提供了一些外掛所不具備的功能:

  • 外掛模組可以自由訪問其中的程式碼和資源
  • 預留特定的資源、程式碼和AndroidManifest.xml宣告,讓系統可以正常識別
  • 預留穩定的資源、程式碼、第三方庫,減少外掛體積

正如前面介紹的,應用外掛通過app.xxx,公共庫外掛通過lib.xxx的命名方式,讓Small進行識別。而宿主分身則需要以app+xxxx的方式來命名。

除了以上介紹的可選情況,有一些程式碼是必須要放入到宿主分身中的:

  • AndroidManifest.xml的宣告
  • 所有許可權,例如引入網路許可權、讀取儲存等
  • 包含了某些特殊許可權的Activity,如processconfigChanges
  • 任何的provider/receiver/service宣告
  • 資源
  • 轉場動畫
  • 通知欄圖示、自定義檢視
  • 桌面快捷方式圖示

二、具體示例

2.1 建立應用外掛模組

首先,我們建立一個新的外掛模組,建立的方式和 外掛化知識梳理(1) - Small 框架之如何引入應用外掛 中介紹的相同:

外掛化知識梳理(3)   Small 框架之宿主分身
其中,DetailActivity是外掛的入口,而以Stub開頭的四個類分別為Activity/Service/ContentProvider/BroadcastReceiver,我們需要在宿主分身模組中對其進行宣告。

public class StubActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_stub);
    }
}
複製程式碼
public class StubBroadcastReceiver extends BroadcastReceiver {

    @Override
    public void onReceive(Context context, Intent intent) {
        Toast.makeText(context, "StubBroadcastReceiver, onReceive", Toast.LENGTH_SHORT).show();
    }
}
複製程式碼
public class StubContentProvider extends ContentProvider {

    public static final Uri CONTENT_URI = Uri.parse("content://com.demo.small.app.detail.stub.provider");

    @Override
    public boolean onCreate() {
        return false;
    }

    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] strings, @Nullable String s, @Nullable String[] strings1, @Nullable String s1) {
        return null;
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        return null;
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues contentValues) {
        Toast.makeText(getContext(), "StubContentProvider, insert", Toast.LENGTH_SHORT).show();
        return null;
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String s, @Nullable String[] strings) {
        return 0;
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues contentValues, @Nullable String s, @Nullable String[] strings) {
        return 0;
    }
}
複製程式碼
public class StubService extends Service {

    @Override
    public void onCreate() {
        super.onCreate();
    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        Toast.makeText(getApplicationContext(), "StubService, onStartCommand", Toast.LENGTH_SHORT).show();
        return super.onStartCommand(intent, flags, startId);
    }

    @Nullable
    @Override
    public IBinder onBind(Intent intent) {
        return null;
    }
}
複製程式碼

為了方便驗證,我們在回撥函式中彈出Toast

public class DetailActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_detail);
    }

    public void activity(View view) {
        Intent intent = new Intent(this, StubActivity.class);
        startActivity(intent);
    }

    public void service(View view) {
        Intent intent = new Intent(this, StubService.class);
        startService(intent);
    }

    public void contentProvider(View view) {
        ContentValues values = new ContentValues();
        getContentResolver().insert(StubContentProvider.CONTENT_URI, values);
    }

    public void broadcastReceiver(View view) {
        Intent intent = new Intent();
        intent.setAction("com.demo.small.action.stub.broadcast");
        sendBroadcast(intent);
    }
}
複製程式碼

2.2 建立宿主分身模組

建立宿主分身模組時,需要選擇Android Library,並且它的模組名需要為app+xxx的結構,這裡,我們命名為app+detail

外掛化知識梳理(3)   Small 框架之宿主分身
對於宿主分身模組,這裡我們需要在AndroidManifest.xml檔案中,新增必須要的宣告:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.demo.small.appdetail">

    <application
        android:allowBackup="true"
        android:label="@string/app_name">

        <!-- Stub Activity -->
        <activity android:name="com.demo.small.app.detail.StubActivity" android:theme="@style/Theme.AppCompat"/>

        <!-- Stub Service -->
        <service android:name="com.demo.small.app.detail.StubService"/>

        <!-- Stub ContentProvider -->
        <provider
            android:authorities="com.demo.small.app.detail.stub.provider"
            android:name="com.demo.small.app.detail.StubContentProvider"/>

        <!-- Stub BroadcastReceiver -->
        <receiver android:name="com.demo.small.app.detail.StubBroadcastReceiver">
            <intent-filter>
                <action android:name="com.demo.small.action.stub.broadcast"/>
            </intent-filter>
        </receiver>

    </application>

</manifest>
複製程式碼

2.3 修改宿主模組的 bundle.json 檔案

對於宿主分身模組,不需要新增宣告,我們所需要的只是對新增的應用外掛模組app.detail新增宣告:

{
  "version": "1.0.0",
  "bundles": [
    {
      "uri": "lib.utils",
      "pkg": "com.demo.small.lib.utils"
    },
    {
      "uri": "lib.style",
      "pkg": "com.demo.small.lib.style"
    },
    {
      "uri": "main",
      "pkg": "com.demo.small.app.main"
    },
    {
      "uri": "detail",
      "pkg": "com.demo.small.app.detail"
    }
  ]
}
複製程式碼

2.4 結果

外掛化知識梳理(3)   Small 框架之宿主分身
通過分析最後生成的APK檔案,可以發現,只有應用外掛和公共庫外掛模組作為so被打包進入了APK中,而宿主分身模組並沒有生成so
外掛化知識梳理(3)   Small 框架之宿主分身
而我們在宿主分身中的宣告則被加入到了最後的AndroidManifest.xml檔案中:
外掛化知識梳理(3)   Small 框架之宿主分身


更多文章,歡迎訪問我的 Android 知識梳理系列:

相關文章