一、前言
上個星期,公司裡有一個小的講座,對外掛化進行了簡單的介紹,因此決定開始研究一下這方面的知識。
在網上查了一些相關的資料,發現了Small
這個開源的外掛化框架,因此打算從它入手,通過它的內部實現,學習一下外掛化的相關原理。這篇文章是個開篇,先從一個簡單的例子開始,把環境給搭建好。先給大家分享一些這幾天查閱的資料,如果大家有比較好的文章也可以留言或者私信我:
Small Github 官網 Small Issues Small 快速入門
Android Small 原始碼分析 (一) 啟動流程 Android Small 原始碼分析 (二) 外掛載入過程
Android Small 外掛化框架 -- 啟動外掛 Activity 原始碼解析(上) Android Small 外掛化框架 -- 啟動外掛 Activity 原始碼解析(下) Android Small 外掛化框架 -- Android 應用類載入機制 Android Small 外掛化框架 -- 類載入實現解析
二、基本示例
2.1 簡要介紹
對於Small
來說,一個最簡單的框架分為三個部分:
- 宿主
- 外掛
bundle.json
,用於宿主和外掛之間的路由。
本文所用的是一個最簡單的例子,因此在程式碼上基本不會有什麼問題,主要是環境上的區別,遇到編譯不過的問題可以多多百度,下面是我所採用的環境:
Android Studio
版本:Android Studio 3.0
Gradle
版本:gradle-3.5-all.zip
compileSdkVersion
:24
buildToolsVersion
:24.0.2
完整的例子可以檢視 github.com/imZeJun/Sma…
2.2 具體實現
整個具體的實現分為五步:
- 新建工程/宿主模組
- 修改專案根目錄下的
build.gradle
檔案,引入Small
外掛 - 新建外掛模組
- 完善宿主模組
- 編譯,安裝
2.2.1 新建工程/宿主模組
這裡比較關鍵的一點,是需要在新建工程/宿主模組的時候,將包名修正為com.demo.small
,這是為了和以後的lib/app
模組形成統一:
2.2.2 修改專案根目錄下的 build.gradle 檔案
對於專案的build.gradle
,修改包含以下三個部分:
- 必選,在
dependencies
節點中引入遠端依賴。 - 必選,通過
apply plugin
應用外掛。 - 可選,配置
Small
程式碼庫版本。
buildscript {
repositories {
maven { url 'https://maven.google.com' }
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.3'
//1.引入Small依賴,必選。
classpath 'net.wequick.tools.build:gradle-small:1.2.0-alpha3'
}
}
allprojects {
repositories {
jcenter()
maven { url 'https://maven.google.com' }
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
//2.應用外掛,必選。
apply plugin: 'net.wequick.small'
//3.配置Small的程式碼庫版本,需要放在第2步的下面,否則會報錯,可選。
small {
aarVersion = '1.2.0-alpha3'
}
複製程式碼
2.2.3 新建外掛模組
這裡用到的外掛模組很簡單,就是位於另一個模組中的Activity
,選擇File -> New -> New Module
:
- 第一部分和宿主模組相同
- 第二部分要根據外掛的型別來決定:
- 如果是
Phone & Tablet Module
:那麼要以app.xxx
結尾 - 如果是
Android Library
,那麼要以lib.xxx
結尾
這裡,我們先演示第一種:
在外掛模組中,我們宣告一個新的PlugActivity
,它的佈局為:
<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="@android:color/white"
tools:context="com.demo.small.app.main.PlugActivity">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:textColor="@android:color/black"
android:text="PlugActivity started success"/>
</FrameLayout>
複製程式碼
2.2.4 完善宿主模組
(a) 配置路由協議
接下來要在宿主模組中進行路由配置,我們在宿主模組上單擊右鍵,新建一個assets
資料夾,之後在assets
資料夾中,新建一個路由檔案,bundle.json
檔案,注意assets
資料夾從Project
檢視上所處的位置如下圖所示,千萬不要放錯地方了:
bundle.json
中,我們宣告外掛模組:
{
"version": "1.0.0",
"bundles": [
{
"uri": "main",
"pkg": "com.demo.small.app.main"
}
]
}
複製程式碼
** (b) 在宿主模組的自定義 Application 中進行預載入**
public class SmallHostApp extends Application {
public SmallHostApp() {
//Small初始化。
Small.preSetUp(this);
}
}
複製程式碼
** (c) 將自定義的 Application 配置到宿主模組的 AndroidManifest.xml 中**
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.demo.small">
<application
android:name=".app.SmallHostApp"
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:supportsRtl="true"
android:theme="@style/AppTheme">
<activity android:name=".LaunchActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
</manifest>
複製程式碼
** (d) 在啟動 Activity 的 onCreate() 方法中載入外掛,點選按鈕後跳轉到外掛的Activity**
public class LaunchActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_launch);
setUp();
}
private void setUp() {
Small.setUp(this, new net.wequick.small.Small.OnCompleteListener() {
@Override
public void onComplete() {
Log.d("LaunchActivity", "onComplete");
}
});
}
public void startPlugActivity(View view) {
Small.openUri("main", LaunchActivity.this);
}
}
複製程式碼
2.2.5 編譯&安裝
最後一步,就是進行編譯和安裝,編譯時:
- 準備基礎庫 & 打包所有元件
./gradlew buildLib -q && ./gradlew buildBundle -q
複製程式碼
- 安裝:
./gradlew assembleDebug && adb install -r app/build/outputs/apk/app-debug.apk
複製程式碼
- 清除基礎庫 & 清除所有元件:
./gradlew cleanLib -q && ./gradlew cleanBundle -q
複製程式碼
2.3 最終效果
更多文章,歡迎訪問我的 Android 知識梳理系列:
- Android 知識梳理目錄:www.jianshu.com/p/fd82d1899…
- 個人主頁:lizejun.cn
- 個人知識總結目錄:lizejun.cn/categories/