原文鏈接：http://limboy.me/tech/2016/03/10/mgj-components.html

蘑菇街 App 的組件化之路

在組件化之前，蘑菇街 App 的代碼都是在一個(gè)工程里開發(fā)的，在人比較少，業(yè)務(wù)發(fā)展不是很快的時(shí)候，這樣是比較合適的，能一定程度地保證開發(fā)效率。

慢慢地代碼量多了起來，開發(fā)人員也多了起來，業(yè)務(wù)發(fā)展也快了起來，這時(shí)單一工程開發(fā)模式就會(huì)顯露出一些弊端

• 耦合比較嚴(yán)重（因?yàn)闆]有明確的約束，組件間引用的現(xiàn)象會(huì)比較多）
• 容易出現(xiàn)沖突（尤其是使用 Xib，還有就是 Xcode Project，雖說有腳本可以改善）
• 業(yè)務(wù)方的開發(fā)效率不夠高（只關(guān)心自己的組件，卻要編譯整個(gè)項(xiàng)目，與其他不相干的代碼糅合在一起）

為了解決這些問題，就采取了組件化策略。它能帶來這些好處

• 加快編譯速度（不用編譯主客那一大坨代碼了）
• 自由選擇開發(fā)姿勢(shì)（MVC / MVVM / FRP）
• 方便 QA 有針對(duì)性地測(cè)試
• 提高業(yè)務(wù)開發(fā)效率

先來看下，組件化之后的一個(gè)大概架構(gòu)

蘑菇街 App.jpg

組件化顧名思義就是把一個(gè)大的 App 拆成一個(gè)個(gè)小的組件，相互之間不直接引用。那如何做呢？

實(shí)現(xiàn)方式

組件間通信

以 iOS 為例，由于之前就是采用的 URL 跳轉(zhuǎn)模式，理論上頁面之間的跳轉(zhuǎn)只需 open 一個(gè) URL 即可。所以對(duì)于一個(gè)組件來說，只要定義「支持哪些 URL」即可，比如詳情頁，大概可以這么做的

[MGJRouter registerURLPattern:@"mgj://detail?id=:id" toHandler:^(NSDictionary *routerParameters) {
    NSNumber *id = routerParameters[@"id"];
    // create view controller with id
    // push view controller
}];

首頁只需調(diào)用[MGJRouter openURL:@"mgj://detail?id=404"] 就可以打開相應(yīng)的詳情頁。

那問題又來了，我怎么知道有哪些可用的 URL？為此，我們做了一個(gè)后臺(tái)專門來管理。

蘑菇街后臺(tái)管理.jpg

然后可以把這些短鏈生成不同平臺(tái)所需的文件，iOS 平臺(tái)生成 .{h,m} 文件，Android 平臺(tái)生成 .java 文件，并注入到項(xiàng)目中。這樣開發(fā)人員只需在項(xiàng)目中打開該文件就知道所有的可用 URL 了。

目前還有一塊沒有做，就是參數(shù)這塊，雖然描述了短鏈，但真想要生成完整的 URL，還需要知道如何傳參數(shù)，這個(gè)正在開發(fā)中。

還有一種情況會(huì)稍微麻煩點(diǎn)，就是「組件A」要調(diào)用「組件B」的某個(gè)方法，比如在商品詳情頁要展示購(gòu)物車的商品數(shù)量，就涉及到向購(gòu)物車組件拿數(shù)據(jù)。

類似這種同步調(diào)用，iOS 之前采用了比較簡(jiǎn)單的方案，還是依托于 MGJRouter，不過添加了新的方法- (id)objectForURL:，注冊(cè)時(shí)也使用新的方法進(jìn)行注冊(cè)。

[MGJRouter registerURLPattern:@"mgj://cart/ordercount" toObjectHandler:^id(NSDictionary *routerParamters){
    // do some calculation
    return @42;
}];

使用時(shí) NSNumber *orderCount = [MGJRouter objectForURL:@"mgj://cart/ordercount"]這樣就拿到了購(gòu)物車?yán)锏纳唐窋?shù)。

稍微復(fù)雜但更具通用性的方法是使用「協(xié)議」 <-> 「類」綁定的方式，還是以購(gòu)物車為例，購(gòu)物車組件可以提供這么個(gè) Protocol。

@protocol MGJCart <NSObject>
+ (NSInteger)orderCount;
@end

可以看到通過協(xié)議可以直接指定返回的數(shù)據(jù)類型。然后在購(gòu)物車組件內(nèi)再新建個(gè)類實(shí)現(xiàn)這個(gè)協(xié)議，假設(shè)這個(gè)類名為MGJCartImpl，接著就可以把它與協(xié)議關(guān)聯(lián)起來 [ModuleManager registerClass:MGJCartImpl forProtocol:@protocol(MGJCart)]，對(duì)于使用方來說，要拿到這個(gè) MGJCartImpl，需要調(diào)用 [ModuleManager classForProtocol:@protocol(MGJCart)]。拿到之后再調(diào)用 + (NSInteger)orderCount 就可以了。

那么，這個(gè)協(xié)議放在哪里比較合適呢？如果跟組件放在一起，使用時(shí)還是要先引入組件，如果有多個(gè)這樣的組件就會(huì)比較麻煩了。所以我們把這些公共的協(xié)議統(tǒng)一放到了 PublicProtocolDomain.h 下，到時(shí)只依賴這一個(gè)文件就可以了。

Android 也是采用類似的方式。

組件生命周期管理

理想中的組件可以很方便地集成到主客中，并且有跟 AppDelegate 一致的回調(diào)方法。這也是 ModuleManager 做的事情。

先來看看現(xiàn)在的入口方法

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  [MGJApp startApp];

  [[ModuleManager sharedInstance] loadModuleFromPlist:[[NSBundle mainBundle] pathForResource:@"modules" ofType:@"plist"]];
  NSArray *modules = [[ModuleManager sharedInstance] allModules];
  for (id<ModuleProtocol> module in modules) {
      if ([module respondsToSelector:_cmd]) {
          [module application:application didFinishLaunchingWithOptions:launchOptions];
      }
  }
  
  [self trackLaunchTime];
  return YES;
}

其中 [MGJApp startApp] 主要負(fù)責(zé)一些 SDK 的初始化。[self trackLaunchTime] 是我們打的一個(gè)點(diǎn)，用來監(jiān)測(cè)從 main 方法開始到入口方法調(diào)用結(jié)束花了多長(zhǎng)時(shí)間。其他的都由 ModuleManager 搞定，loadModuleFromPlist:pathForResource: 方法會(huì)讀取 bundle 里的一個(gè) plist 文件，這個(gè)文件的內(nèi)容大概是這樣的

plist文件

每個(gè) Module 都實(shí)現(xiàn)了 ModuleProtocol，其中有一個(gè) - (BOOL)applicaiton:didFinishLaunchingWithOptions: 方法，如果實(shí)現(xiàn)了的話，就會(huì)被調(diào)用。

還有一個(gè)問題就是，系統(tǒng)的一些事件會(huì)有通知，比如 applicationDidBecomeActive 會(huì)有對(duì)應(yīng)的 UIApplicationDidBecomeActiveNotification，組件如果要做響應(yīng)的話，只需監(jiān)聽這個(gè)系統(tǒng)通知即可。但也有一些事件是沒有通知的，比如 - application:didRegisterUserNotificationSettings:，這時(shí)組件如果也要做點(diǎn)事情，怎么辦？

一個(gè)簡(jiǎn)單的解決方法是在 AppDelegate 的各個(gè)方法里，手動(dòng)調(diào)一遍組件的對(duì)應(yīng)的方法，如果有就執(zhí)行。

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    NSArray *modules = [[ModuleManager sharedInstance] allModules];
    for (id<ModuleProtocol> module in modules) {
        if ([module respondsToSelector:_cmd]) {
            [module application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
        }
    }
}

殼工程

既然已經(jīng)拆出去了，那拆出去的組件總得有個(gè)載體，這個(gè)載體就是殼工程，殼工程主要包含一些基礎(chǔ)組件和業(yè)務(wù)SDK，這也是主工程包含的一些內(nèi)容，所以如果在殼工程可以正常運(yùn)行的話，到了主工程也沒什么問題。不過這里存在版本同步問題，之后會(huì)說到。

遇到的問題

組件拆分

由于之前的代碼都是在一個(gè)工程下的，所以要單獨(dú)拿出來作為一個(gè)組件就會(huì)遇到不少問題。首先是組件的劃分，當(dāng)時(shí)在定義組件粒度時(shí)也花了些時(shí)間討論，究竟是粒度粗點(diǎn)好，還是細(xì)點(diǎn)好。粗點(diǎn)的話比較有利于拆分，細(xì)點(diǎn)的話靈活度比較高。最終還是選擇粗一點(diǎn)的粒度，先拆出來再說。

假如要把詳情頁遷出來，就會(huì)發(fā)現(xiàn)它依賴了一些其他部分的代碼，那最快的方式就是直接把代碼拷過來，改個(gè)名使用。比較簡(jiǎn)單暴力。說起來比較簡(jiǎn)單，做的時(shí)候也是挺有挑戰(zhàn)的，因?yàn)檎５臉I(yè)務(wù)并不會(huì)因?yàn)椤附M件化」而停止，所以開發(fā)同學(xué)們需要同時(shí)兼顧正常的業(yè)務(wù)和組件的拆分。

版本管理

我們的組件包括第三方庫(kù)都是通過 Cocoapods 來管理的，其中組件使用了私有庫(kù)。之所以選擇 Cocoapods，一個(gè)是因?yàn)樗容^方便，還有就是用戶基數(shù)比較大，且社區(qū)也比較活躍（活躍到了會(huì)時(shí)不時(shí)地觸發(fā) Github 的 rate limit，導(dǎo)致長(zhǎng)時(shí)間 clone 不下來··· 見此），當(dāng)然也有其他的管理方式，比如 submodule / subtree，在開發(fā)人員比較多的情況下，方便、靈活的方案容易占上風(fēng)，雖然它也有自己的問題。主要有版本同步和更新/編譯慢的問題。

假如基礎(chǔ)組件做了個(gè) API 接口升級(jí)，這個(gè)升級(jí)會(huì)對(duì)原有的接口做改動(dòng)，自然就會(huì)升一個(gè)中位的版本號(hào)，比如原先是 1.6.19，那么現(xiàn)在就變成 1.7.0 了。而我們?cè)?Podfile 里都是用 ~ 指定的，這樣就會(huì)出現(xiàn)主工程的 pod 版本升上去了，但是殼工程沒有同步到，然后群里就會(huì)各種反饋編譯不過，而且這個(gè)編譯不過的長(zhǎng)尾有時(shí)能拖上兩三天。

然后我們就想了個(gè)辦法，如果不在殼工程里指定基礎(chǔ)庫(kù)的版本，只在主工程里指定呢，理論上應(yīng)該可行，只要不出現(xiàn)某個(gè)基礎(chǔ)庫(kù)要同時(shí)維護(hù)多個(gè)版本的情況。但實(shí)踐中發(fā)現(xiàn)，殼工程有時(shí)會(huì)莫名其妙地升不上去，在 podfile 里指定最新的版本又可以升上去，所以此路不通。

還有一個(gè)問題是 pod update 時(shí)間過長(zhǎng)，經(jīng)常會(huì)在 Analyzing Dependency 上卡 10 多分鐘，非常影響效率。后來排查下來是跟組件的 Podspec 有關(guān)，配置了 subspec，且依賴比較多。

然后就是 pod update 之后的編譯，由于是源碼編譯，所以這塊的時(shí)間花費(fèi)也不少，接下去會(huì)考慮 framework 的方式。

持續(xù)集成

在剛開始，持續(xù)集成還不是很完善，業(yè)務(wù)方升級(jí)組件，直接把 podspec 扔到 private repo 里就完事了。這樣最簡(jiǎn)單，但也經(jīng)常會(huì)帶來編譯通不過的問題。而且這種隨意的版本升級(jí)也不太能保證質(zhì)量。于是我們就搭建了一套持續(xù)集成系統(tǒng)，大概如此

持續(xù)集成

每個(gè)組件升級(jí)之前都需要先通過編譯，然后再?zèng)Q定是否升級(jí)。這套體系看起來不復(fù)雜，但在實(shí)施過程中經(jīng)常會(huì)遇到后端的并發(fā)問題，導(dǎo)致業(yè)務(wù)方要么集成失敗，要么要等不少時(shí)間。而且也沒有一個(gè)地方可以呈現(xiàn)當(dāng)前版本的組件版本信息。還有就是業(yè)務(wù)方對(duì)于這種命令行的升級(jí)方式接受度也不是很高。

網(wǎng)頁端

基于此，在經(jīng)過了幾輪討論之后，有了新版的持續(xù)集成平臺(tái)，升級(jí)操作通過網(wǎng)頁端來完成。

大致思路是，業(yè)務(wù)方如果要升級(jí)組件，假設(shè)現(xiàn)在的版本是 0.1.7，添加了一些 feature 之后，殼工程測(cè)試通過，想集成到主工程里看看效果，或者其他組件也想引用這個(gè)最新的，就可以在后臺(tái)手動(dòng)把版本升到 0.1.8-rc.1，這樣的話，原先依賴 ~> 0.1.7 的組件，不會(huì)升到 0.1.8，同時(shí)想要測(cè)試這個(gè)組件的話，只要手動(dòng)把版本調(diào)到 0.1.8-rc.1 就可以了。這個(gè)過程不會(huì)觸發(fā) CI 的編譯檢查。

當(dāng)測(cè)試通過后，就可以把尾部的 -rc.n 去掉，然后點(diǎn)擊「集成」，就會(huì)走 CI 編譯檢查，通過的話，會(huì)在主工程的 podfile 里寫上固定的版本號(hào) 0.1.8。也就是說，podfile 里所有的組件版本號(hào)都是固定的。

組件版本

周邊設(shè)施

基礎(chǔ)組件及組件的文檔 / Demo / 單元測(cè)試

無線基礎(chǔ)的職能是為集團(tuán)提供解決方案，只是在蘑菇街 App 里能 work 是遠(yuǎn)遠(yuǎn)不夠的，所以就需要提供入口，知道有哪些可用組件，并且如何使用，就像這樣（目前還未實(shí)現(xiàn)）

文檔

這就要求組件的負(fù)責(zé)人需要及時(shí)地更新 README / CHANGELOG / API，并且當(dāng)發(fā)生 API 變更時(shí)，能夠快速通知到使用方。

公共 UI 組件

組件化之后還有一個(gè)問題就是資源的重復(fù)性，以前在一個(gè)工程里的時(shí)候，資源都可以很方便地拿到，現(xiàn)在獨(dú)立出去了，也不知道哪些是公用的，哪些是獨(dú)有的，索性都放到自己的組件里，這樣就會(huì)導(dǎo)致包變大。還有一個(gè)問題是每個(gè)組件可能是不同的產(chǎn)品經(jīng)理在跟，而他們很可能只關(guān)注于自己關(guān)心的頁面長(zhǎng)什么樣，而忽略了整體的樣式。公共 UI 組件就是用來解決這些問題的，這些組件甚至可以跨 App 使用。（目前還未實(shí)現(xiàn)）

公共UI組件

小結(jié)

「組件化」是 App 膨脹到一定體積后的解決方案，能一定程度上解決問題，在提高開發(fā)效率的過程中，采坑是難免的，希望這篇文章能夠帶來些幫助。