Android組件化：stitch框架

時間 2019-11-16

原文原文鏈接

以前的文章【Android組件化開發框架】從總體上分析了要搭建一個組件化框架的技術原理。歸納性的對組件化進行了簡單的分析。java

stitch 是在項目實踐過程當中結合以前的理論進行完善後組織起來的框架。它完成了組件生命週期、頁面路由、數據路由的基本功能，框架源碼裏也包含了搭建組件化可能須要的腳本示例。android

框架包含3個部分：組件生命週期管理、頁面交互、數據交互。咱們依次對其進行解析。git

依賴

//AS 3.0以前使用
compile 'bamboo.component:stitcher:1.0'
//AS 3.0以後建議使用
implementation 'bamboo.component:stitcher:1.0'
複製代碼

組件生命週期管理

每一個組件至關於1個Module，許多組件的業務是須要在App啓動時進行初始化的，好比運營商支付sdk基本都須要在Application的onCreate方法中進行初始化。github

stitch 框架採用手動配置的方式，組件將本身注入到stitch 框架中，主工程再經過stitch框架對組件生命週期進行統一管理。bash

具體使用方法：app

1. 繼承ComponentApplication

public abstract class ComponentApplication {
    //Application對象注入
    public void setApplication(Application application)； //控制組件的初始化順序，參看ComponentPriority public int level();

    //代理Application的OnCreate方法
    public void onCreate();

    //延遲初始化生命週期，用來注入頁面以及數據交互接口
    public void onCreateDelay(ComponentRouterRegistry routerRegistry, ActivityRouterRegistry activityRouterRegistry)； //代理Application的attachBaseContext方法 public void attachBaseContext(Context baseContext) ;

    //代理Application的onTrimMemory方法
    public void onTrimMemory(int level) ;

    //代理Application的onConfigurationChanged方法
    public void onConfigurationChanged(Configuration newConfig);

    //代理Application的onLowMemory方法
    public void onLowMemory();
}
複製代碼

ComponentApplication是組件生命週期的代理類，代理了Application的經常使用關鍵方法。若是組件在App啓動時進行某些初始化或須要監聽生命週期，經過ComponentApplication便可實現。框架

2. 在Module的AndroidManifest.xml中進行配置

<application>
        ...
        <meta-data
            android:name="bamboo.sample.account.component.AccountComponentApp"
            android:value="ComponentApplication" />
    </application>
複製代碼

特別要注意：meta-data的value是ComponentApplication，name纔是咱們module的代理Application類。不要搞反了。組件化

3. 主工程裏面的自定義Application修改

在主工程Application裏面咱們須要主動調用組件的代理Application的方法，stitcher提供了兩種方式：gradle

1. 直接繼承StitcherApplicationui

public class MainApplication extends StitcherApplication {
}
複製代碼

2. 經過StitcherHelper調用組件的生命週期。 參考StitcherApplication。

public class StitcherApplication{
    public void onCreate() {
        super.onCreate();
        StitcherHelper.onCreate();
    }

    public void onCreateDelay() {
        StitcherHelper.onCreateDelay();
    }

    public void attachBaseContext(Context baseContext) {
        super.attachBaseContext(baseContext);
        StitcherHelper.init(this);
        StitcherHelper.attachBaseContext(baseContext);
    }

    public void onTrimMemory(int level) {
        super.onTrimMemory(level);
        StitcherHelper. onTrimMemory(level);
    }

    public void onLowMemory() {
        super.onLowMemory();
        StitcherHelper.onLowMemory();
    }

    public void onConfigurationChanged(Configuration newConfig) {
        super.onConfigurationChanged(newConfig);
        StitcherHelper.onConfigurationChanged(newConfig);
    }
}
複製代碼

經過上面幾步，就能對組件的生命週期進行管理。

在使用頁面交互以及數據交互以前咱們先思考一個問題，這個問題是：

組件之間不能互相依賴，那若是要獲取數據，咱們就必需要藉助於第三方Module進行中轉。咱們要怎麼設計這個Module更方便呢？

沒錯，咱們確實須要一個額外的Module來作交互中轉，也就是路由Module，若是以開發人員的角度來看，這個Module應該要具有如下幾個因素： 1.方便Module管理本身的接口。 2.其餘Module最好能實時看到咱們的修改。

因此在介紹交互功能以前，咱們須要先來實現這個路由Module的配置。

公用路由Module配置

1. 建立一個Module：sampleouter

2. 修改sampleouter的build.gradle文件，在裏面加入如下代碼：

這一步的目的是爲了把全部Module的projectDir的router文件夾都加入到sampleouter的源碼文件夾中，這樣一來，咱們就能在本身的Module的router文件夾內管理本身對外公開的接口以及頁面。

android {
    ...
    sourceSets {
        main {
            //將全部module裏的router文件夾都做爲路由module的源碼文件夾，方便Module開發時的方便
            ArrayList<String> strings = new ArrayList<String>()
            File[] modules = rootDir.listFiles(new FileFilter() {
                boolean accept(File pathname) {
                    return (pathname.isDirectory()
                            && pathname.name != "gradle"
                            && pathname.name != "build"
                            && !pathname.name.startsWith("."))
                }
            })
            for (File f : modules) {
                strings.add(f.absolutePath + File.separator + "router")
            }
            //不要忘了把原始的源碼目錄添加進來
            strings.addAll(java.srcDirs)
            java.srcDirs = strings
        }
    }
}
複製代碼

配置完後，點一下refresh按鈕，在Module裏面建立router文件夾你會看到這樣的效果。

3.在Module中配置samplerouter的依賴

implementation 'bamboo.component:stitcher:1.0'
    implementation project(":samplerouter")
複製代碼

OK，sampleouter Module就配置好了，如今咱們繼續看頁面交互要怎麼實現。

頁面交互

咱們在講述組件的生命週期管理時，可能你已經看到了組件生命週期代理類內有一個方法

//延遲初始化生命週期，用來注入頁面以及數據交互接口
    public void onCreateDelay(ComponentRouterRegistry routerRegistry, ActivityRouterRegistry activityRouterRegistry)；
複製代碼

其中ActivityRouterRegistry就是咱們進行頁面交互的註冊表，咱們只須要將咱們須要公開的頁面注入到這裏面就能夠進行交互了。具體的實現步驟：

1. 在router文件夾裏建立一個TaskInfoPage.class並繼承ActivityPage

package bamboo.sample.tasksrouter;

//每一個對外公開的頁面都對應一個ActivityPage的子類
public class TaskInfoPage extends ActivityPage {
    public final String taskId;
    public TaskInfoPage(Context context, String taskId) {
        super(context);
        this.taskId = taskId;
    }
}
複製代碼

2. 建立一個TasksPageConsumer.class

public class TasksPageConsumer {
    //這個方法將會與TaskInfoPage進行鏈接。
    //全部的TaskInfoPage的頁面交互請求都會最終調用到該方法中。
    public void consume(TaskInfoPage page) {
        Intent intent = new Intent(page.context, TaskInfoActivity.class);
        intent.putExtra("TaskInfoPage", page);
        page.context.startActivity(intent);
    }
}
複製代碼

3. 在Module的ComponentApplication實現類中註冊

public class TasksComponentApp extends ComponentApplication {

    public void onCreateDelay(ComponentRouterRegistry routerRegistry, ActivityRouterRegistry activityRouterRegistry) {
        //將TasksPageConsumer注入到頁面路由註冊表中
        activityRouterRegistry.regiest(new TasksPageConsumer());
    }
複製代碼

4. 交互調用

//在須要調用TaskInfoPage的地方經過StitcherHelper使用
StitcherHelper.start(new TaskInfoPage(this, "taskId"));
StitcherHelper.start(new TaskInfoPage(this, "taskId"),1000/*requestCode*/);
複製代碼

5. 更簡單的使用方式(PageConsumer註解)

實際上咱們還有簡單的方式進行頁面注入，爲何我要先說常規模式呢？由於若是萬一簡單的方式沒辦法知足你的需求的時候，你依然須要使用常規方式進行開發。

咱們在繼承實現ActivityPage時，還能夠經過PageConsumer直接配置Activity或Action來進行Activity<->ActivityPage的鏈接。

@PageConsumer(clasz = "bamboo.sample.tasks.ui.TaskCountActivity")
public class TaskListPage extends ActivityPage {
    public TaskListPage(Context context) {
        super(context);
    }
}
複製代碼

這種方式是不須要在TaskPageConsumer中註冊的，框架會自動搜索。

6. 特殊Intent參數配置

在頁面交互時咱們有時會須要對Intent設置Flag，或須要經過Action或Data方式進行交互，這個時候咱們能夠經過ActivityPage的targetIntent進行傳遞，並暫時關閉ActivityPage的鏈接，stitch會在這種狀況下放棄PageConsumer註解中class的參數連接，直接嘗試啓動Activity。

public void onActionTest(View view) {
        ActionTestPage page = new ActionTestPage(this);
        Intent targetIntent = new Intent();
        targetIntent.setAction("bamboo.sample.actiontest");
        targetIntent.addCategory(Intent.CATEGORY_DEFAULT);
        page.setTargetIntent(targetIntent);
        page.setAutoLink(false);
        StitcherHelper.start(page);
    }
複製代碼

優先級： TaskPageConsumer > unAutolink > PageConsumer

數據交互

組件之間的數據交互與頁面交互原理是類似的。在onCreateDelay方法中的ComponentRouterRegistry就是數據交互的路由註冊表，咱們經過它來進行註冊。具體使用參看如下步驟：

1.在router文件夾定義Module的ComponentOutput

package bamboo.sample.tasksrouter;
public interface ITaskComponent extends ComponentOutput{
    int getTaskCount();
}
複製代碼

2. 在Module 實現該接口

public class TasksComponentOutput implements ITaskComponent {
    public int getTaskCount() {
        return 1000;
    }
複製代碼

3. 在onCreateDelay方法中進行註冊

public class TasksComponentApp extends ComponentApplication {

    public void onCreateDelay(ComponentRouterRegistry routerRegistry, ActivityRouterRegistry activityRouterRegistry) {
        //將TasksComponentOutput注入到數據路由註冊表中
        routerRegistry.regiest(registerComponentOutput，new TasksPageConsumer());
    }
}
複製代碼

4.使用

public class ComponentInput {
    public int getTaskCount() {
        ITaskComponent taskComponent = StitcherHelper.searchComponentOutput(ITaskComponent.class);
        return taskComponent == null ? -1 : taskComponent.getTaskCount();
    }
}

複製代碼

具體的數據交互流程入下圖：