您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

豆瓣 App 模塊化實踐:從代碼治理到組件開源

編輯:iOS 開發基礎

2014 年,豆瓣把分散在各端的移動業務收攏到一起,推出了名為「豆瓣」的綜合性 App。此後幾年,越來越多的業務線被塞進這一個安裝包裡:代碼量膨脹、功能彼此纏繞、包體積節節攀升。為了讓項目重新回到可控狀態,我們啟動了模塊化改造。

需要說清楚的是,這次改造並不是為了配合組織架構而做的工程要求。豆瓣 App 當時依然由單一團隊負責開發,並沒有按業務線拆分團隊。我們出發點很樸素:讓代碼本身更健康。過程中有過陣痛,但回頭看收穫明顯——一個結構更清晰的工程、一批可復用的公共組件,以及幾個真正互相隔離的業務模塊。

順帶产出的開源成果

改造過程中,我們把一些通用能力抽成了獨立庫並開源:

  • FRDIntent:負責頁面跳轉的解耦。

  • FRDModuleManager:輕量的模塊管理庫。

  • Rexxar:移動端混合開發框架。

開源一方面是希望給同行提供一條可借鑑的路徑,另一方面也是用外部視角倒逼自身質量。這些庫都存在不足,歡迎大家直接提意見。

工程環境前提

iOS 端的版本管理使用 Git,所有代碼托管在公司內網搭建的 GitHub Enterprise 上,使用體驗與公有雲版本基本一致,工程師接受度很高。依賴管理則使用 CocoaPods。這兩項工具在本文中介紹的模塊化流程裡是唯一相關的基礎設施。

目標項目結構

我們先把模塊化之後期望得到的結構畫出來,然後朝著它一步步靠攏。

  • Frodo:豆瓣 App 的項目名。豆瓣有用《魔戒》人物命名項目的傳統。

  • Leaf:尚未拆分的業務模塊暫時都放在 Frodo 的 Leaf 目錄下。

  • Timeline / Group / Subjects:最終要拆出去的三個業務模塊,分別對應廣播、小組、條目。

  • Fangorn:公共底層庫,包含業務相關的公共 UI 組件、數據 Model,以及 FrodoRexxar 這類對外部庫的封裝。

  • Library:自研庫與第三方庫的統一收攏處,Rexxar、FRDIntent、FRDModuleManager 都在這裡。

分四步落地

模塊化對項目影響深遠,確定目標後我們制定了一份細節充分的計劃,並嚴格按計劃推進。整個過程分為四個階段。

第一步:文件夾隔離

過去項目按 View / Controller / Model 的水平職責切分文件。改造後改為先按模塊劃分,每個模塊內部再劃出自己的 View / Controller / Model / Network 目錄。此時所有模塊仍在同一個倉庫中,本質上只是目錄隔離,代碼並未真正分離。

這個階段的主要工作是逐個檢查文件的 #import,設法削減業務模塊之間的相互引用;被多個模塊共用的文件則下沉到公共層。

徹底隔離在這一階段是做不到的——依賴梳理依賴工程師逐行閱讀代碼,而代碼還在同一倉庫裡,物理上無法杜絕引用。但這一步不可跳過,原因在於產品迭代不能因為重構而停工。文件夾隔離把「一次性集中爆發的編譯錯誤」攤薄到每個版本的日常開發中,等真正要拆倉時,未解決的依賴已經所剩不多,時間壓力大幅減小。

它同時也是團隊思維轉換的緩衝期:模塊邊界先在全體成員間達成共識,此後新增文件自覺歸位,code review 中也開始出現「不應引用其他業務模塊」的建議。產品開發與模塊化由此得以並行推進。

第二步:抽象出與業務無關的庫

我們同步鼓勵把與業務無關的代碼抽成獨立庫。判斷標準很明確:這些代碼應該在一段時間內保持穩定,不隨業務頻繁變化。這樣做的好處有三:

  • 每個庫有了清晰邊界,代碼不再混雜在工程中互相干擾,項目質量隨之提升;

  • 復用成為可能——新項目可以直接使用,甚至開源給外部開發者,FRDIntent、FRDModuleManager、Rexxar 都源於此;

  • 為拆分公共底層模塊 Fangorn 鋪路。任何模塊要拆出去,都必須先把依賴收斂到「已拆出的組件 + 第三方庫」。

第三步:剝離公共底層模塊

Fangorn 承載的是那些被多個業務共用、但與業務關聯較緊、暫時還不值得抽成獨立庫的公共代碼。它沒有復用價值,卻是業務模塊拆分的前置條件——Fangorn 不獨立,業務模塊就無處可依。

拆分 Fangorn 有兩種路徑:

  • 把 Fangorn 細分為若干子模塊,逐個剝離出去;

  • 把 Fangorn 當作一個整體先摘出來,內部子模塊之間暫時沿用文件夾隔離的方式運作,觀察一段時間後再視情況細拆。

第一種更優雅:業務模塊可以按需依賴,不必整體引入 Fangorn。但它也更困難,需要花費大量時間理清 Fangorn 內部的相互依賴。第二種只需處理 Fangorn 與外部模塊的邊界,工作量小得多。為了讓業務模塊更早獨立,我們選擇了第二種。

第四步:業務模塊獨立

經歷了漫長的文件夾隔離、抽出了一批通用庫、並把 Fangorn 剝離出去之後,我們開始按「由易到難」的順序拆業務模塊:先廣播 Timeline,然後小組 Group,最後條目 Subjects。這一步的核心是解除模塊間的相互依賴,讓它們只依賴 Fangorn、已拆出的庫和第三方庫。

最終,三個模塊各自擁有了可獨立運行的 Demo 工程,開發流程隨之改變:先在模塊庫中開發新功能,用自帶 Demo 驗證效果;完成後在主工程 Frodo 中升級模塊版本,做集成驗證。

FRDIntent:讓 ViewController 之間不再互相認識

iOS 有大量頁面跳轉,卻沒有像 Android Intent 那樣統一的跳轉機制。傳統做法下,跳轉方必須知道目標頁面的類以及它的初始化細節,頁面之間因此層層耦合,模塊拆分根本無從談起。FRDIntent 就是為了解決這個問題,並已開源。

項目地址:https://github.com/douban/FRDIntent

它由兩部分組成:FRDIntent/Intent 處理應用內跳轉,FRDIntent/URLRoutes 處理外部應用對本應用的頁面調用。接入之後,ViewController 之間的代碼耦合被乾淨地解除,內外調用也獲得了統一而清晰的實現方式。

FRDIntent/Intent

它是一個用於啟動 UIViewController 的消息傳遞對象,可以理解为對 Android Intent 的簡化模仿——之所以能大幅簡化,是因為使用場景單一:只負責應用內跳轉。

直接使用系統 API 跳轉時,發起方需要掌握目標頁面的創建過程;改為傳遞 Intent 之後,雙方僅通過 FRDIntentReceivable 協議交互,調用者不再依賴任何具體類型。它的主要優勢包括:

  • 充分解耦:任何符合協議的 UIViewController 都可被啟動;

  • 為「打開頁面並取回結果」提供了通用方案,見 startControllerForResult,是對 startActivityForResult 的借鑑與簡化;

  • 支持自定義轉場動畫;

  • 支持傳遞複雜數據對象。

FRDIntent/URLRoutes

這是一個 URL Router,用 URL 即可調起預先註冊的 block。iOS 本身提供了基於 URL scheme 的應用間調用能力,社區中的 URL Router 也不少。我們再造一次輪子,是為了讓 URLRoutes 能與 Intent 天然配合,一體化地解決應用內外兩類頁面調用。

兩者如何協同

URLRoutes 只承擔「暴露外部入口、接收外部請求」的角色,請求進入應用後,仍舊由 Intent 完成真正的頁面啟動。外部調用最終落到內部調用上,是自然的代碼復用;而區分內外調用本身也帶來兩點好處:

  • URL 方案適合跨進程、跨應用的信息傳遞,但拿來做應用內跳轉會處處受限——很難傳遞複雜對象,也難以自定義轉場。Intent 恰好填補了這塊空白。

  • 有了明確的內外之分,我們可以自主決定哪個內部能力要開放給外部,避免把本應私有的調用錯誤地暴露出去。

FRDModuleManager:給 AppDelegate 減負

開發中我們發現,實現了 UIApplicationDelegate 協議的 AppDelegate 越來越臃腫。於是我們寫了一個極簡的模塊管理工具——整個工具只有一個 .m 文件,同樣已開源。

項目地址:https://github.com/lincode/FRDModuleManager

它把散落在 AppDelegate 各個回調中的模塊掛鉤統一收攏管理。模塊若在啟動時需要初始化,過去只能在 application:didFinishLaunchingWithOptions: 裡不斷追加調用,模塊越多代碼越腫。FRDModuleManager 提供統一接口讓各模塊感知應用生命周期,AppDelegate 因此得以瘦身。

嚴格來說,AppDelegate 除了轉發生命周期事件之外不該承擔其他職責。最常見的壞用法是把全局變量掛在它身上——這會讓 AppDelegate 變成依賴中心:它可以依賴即將拆出的模塊,而那些模塊卻因為要訪問全局變量而反向依賴了 AppDelegate,形成無法拆分的死結。

解法分兩步。先把全局變量從 AppDelegate 上剝離:各類自行提供全局訪問入口,最簡單的實現就是單例;變量也可以掛到一個專門的全局訪問對象上,但這個對象不能是 AppDelegate。然後,把 AppDelegate 僅剩的生命周期通知職責交給 FRDModuleManager 統一管理。兩步之後,AppDelegate 不再是依賴中心,模塊化道路上的這塊石頭被搬開了。

Rexxar:混合開發帶來的意外收益

我們在混合開發上投入不少,主要產出 Rexxar 已開源。推進混合開發的初衷是提升工程效率,但它在模塊化過程中意外地幫了忙:Rexxar 頁面完全由 Web 技術實現,與項目其餘 Native 代碼天然隔離,除了 Rexxar 本身之外不依賴任何 Native 實現。前端使用 React,其組件化特性也讓前端代碼內部保持了不錯的模塊化程度。

普通對象之間的解耦

FRDIntent 解決了頁面跳轉這類大頭,但模塊之間還有大量非跳轉場景的依賴:比如其他模塊想展示一條廣播,或者想知道某個用戶發佈了多少條廣播。這些能力在廣播模塊內部早已實現,該如何對外提供?

我們最初採取了兩種略顯粗糙但有效的做法:

  • 如果實現完全一致且多個模塊都用得到,就把它下沉到公共底層模塊 Fangorn,各模塊依賴公共層而非彼此;

  • 如果並不完全一致,就複製一份並重命名類以避免衝突。在模塊化背景下,一定程度的代碼冗余是值得付出的代價。

更通用的方案是引入依賴注入容器,類似 Java 社區的 Spring:所有依賴在容器中註冊,業務對象只依賴接口而不依賴具體類型,對象的創建與依賴注入交由容器動態完成。但我們最終沒有引入——這意味著項目中大量對象的創建方式都要改寫,屬於基礎性變更,需要格外慎重;何況在移動平台上尋找或自研一個足够堅實的容器,我們並不樂觀。

路上踩過的坑:Swift

項目中使用了不少 Swift,也遇到兩個現實問題:

  • 語言本身仍在演進。Swift 2 到 Swift 3 的變化幅度不小,即便有 Xcode 的自動轉換工具,仍需投入精力做檢查與回歸。大型項目裡穩定與安全優先,引入仍在快速變化的語言本身就是風險。但 iOS 開發者的選擇並不多:Objective-C 是過去,Swift 是未來,問題只是何時切、如何切。我們的經驗是小塊試點、謹慎推進,每次升級只轉換一小塊代碼,絕不一次性全量遷移。

  • 系統版本門檻。包含 Swift 代碼的庫必須以動態庫形式引入,而動態庫要求 iOS 8 及以上。我們在 iOS 10 發佈時放棄了 iOS 7 支持,這才具備了使用條件。若項目仍需支持更老的系統,暫時就無法引入含 Swift 的庫。配置方式很簡單:開啟 CocoaPods 的 !use_framework 標識即可。

總體感受是:Swift 在工程效率上確實優於 Objective-C,用更少、更清晰的代碼完成同樣的功能;混用帶來的額外成本真實存在,但可以克服。核心權衡在於——是堅持純 Objective-C 換取簡單,還是容忍一些不便以換取效率。

結語

回顧整個過程,我們最大的體會是:模塊化不必等到有完美條件才開始。文件夾隔離這樣的過渡手段,讓重構得以與業務開發並行;抽象通用庫與剝離公共底層,則為業務模塊的真正獨立鋪平了道路。希望這些經驗和開源工具能給正在成長中的移動團隊帶來參考,也期待更多反饋。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved