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

如何接手一個沒有文檔的老舊 iOS 項目

編輯:iOS 開發基礎

作者:點燃那火焰

續命

程序員最崩潰的事是什麼?沒有文檔。

程序員最不願做的事是什麼?寫文檔。

這就是所謂的「程序員的糾結」。而最近,我正好趕上了這件糾結的事。

公司有個項目,姑且叫它「起死回生項目」。兩年前成立、上線,效果不佳被迫下架、團隊解散。人生就是這麼奇妙,兩年後市場突然急需它,於是它起死回生了。然而原班人馬早已各奔東西——沒文檔、沒交接。

誰來接手?領導說是我。我那時正在別的項目組,還掙扎了一下,領導只回了一句:「組織上已經決定了,由你來重啟這個項目。」我心裡默默念了兩句詩,然後就來到了這個項目組——組裡只有我一個人,而我學 iOS 剛滿一年。

迎面而來的問題

先要權限,從服務器拉代碼,結果——跑不起來。一大堆 Warning 和 Error。

不是說已經上線過嗎?翻提交記錄,最後一條是改 build 號、上傳 App Store,怎麼會編譯不過?

仔細看報錯,大多是缺少文件類的:framework、第三方庫。輾轉通過多層關係聯繫上原項目成員,通話中才得知:當年依賴庫管理用的是靜態庫方案。如今大家 pod update 一鍵搞定,但那會兒這個項目沒用 CocoaPods,做法是先建一個輔助工程,把所需組件與庫統統編譯成 CommonLib Frameworks,再導入主工程。

缺少的 Framework

原來是 framework 沒導入。找到那份 framework 的源碼加進來,果然 build success。

順帶發現,項目最低支持版本還停留在 iOS 6.1——在 iOS 10.2 都發布的時候。

最低支持版本

撸起袖子,加油干

吐槽完,活兒還得幹。於是我畫了一張升級遷移的思維導圖,邊做邊補充——就像阿甘說的,你永遠不知道下一個坑在哪裡。

升級遷移計劃

1. 遷移到 CocoaPods

痛點:依賴庫靠人肉管理,痛苦人盡皆知;而且完全沒有版本資訊,想知道當時用的是哪個版本,只能打開工程肉眼分辨。

第一步,依賴庫盤點。打開工程,人肉統計,結果有這麼多:

依賴庫

更麻煩的是,其中一部分根本沒被用到。全局搜索逐一驗證後清理,最終留下約二十個,整理成一份 Podfile。

Podfile

順帶提醒讀者:及時清理無用組件,別把垃圾留給後人。

第二步,切換。先把工程配置裡所有與靜態庫相關的配置項刪乾淨,包括 CommonLibARC 之類的設置:

配置圖 1

配置圖 2

然後建 Podfile、執行 pod install,生成 xcworkspace,此後從 workspace 打開工程,第三方組件統一由 Pods 工程管理。

目錄結構

第三步,確定版本號。這一步會爆出海量 error,因為 Podfile 要指定版本,而沒人知道兩年前用的是哪版,跨版本 API 變動甚至移除,編譯必然失敗。

我的做法:用 pod search 查看可用版本,選一個相對穩定的大版本。比如 MJRefresh 當時最新是 3.1.12,按時間推算原工程肯定是 1.x,但考慮到有必要升級,我最終選了 3.0——用的人多,也不算太舊。

pod search

隨後果然迎來大量方法名變動,只能自己逐個改:

MJRefresh 方法名變動

第四步,error 層出不窮。這是最熬人的階段。連續幾天無法編譯成功,因為編譯器遇到 error 就中止,你修完眼前 3 個再 build,又冒出 5 個——更多是精神上的消耗。而且期間無法提交代碼,只能先 stash 在本地,等編譯通過才能推遠端。

第五步,CocoaLumberjack 與 DDLog。這是個快捷、強大又靈活的日誌框架,我們主要用 DDLog。它需要定義日誌級別,低於該級別的 log 不輸出。原工程在每個用到的地方的 .m 文件裡都重複定義一次,全局搜索會看到大量相同代碼。

大量重複定義

定義日誌級別

我把它挪到 PCH 文件,在 AppDelegate 中定義一次級別,全局通用。

第六步,Crashlytics。非常好用的崩潰統計工具,接入方便,五分鐘搞定,強烈推薦。原項目也在用,但帳號密碼沒移交,我趁機升到最新版。

第七步,過渡方案。有些組件牽扯面太廣,替換成本高。為保證進度,我先讓項目跑起來:這部分暫不交給 CocoaPods 管理,但必須刪掉對應 Framework 以免符號衝突,做法是——直接把組件文件夾拖進工程。粗暴,但有效。

2. 升級到 iOS 8.0

最低版本

項目終於跑起來了,但它依然停留在 iOS 6.1。查蘋果官網的版本佔比,8.0 以下合計只剩 6% 左右,可以大膽往上抬。

iOS 版本佔比

為什麼是 8.0 而不是更激進?步子大了容易扯著。

Warning 主要集中在以下幾類:

2.1 方法已廢棄(Method Deprecation)——系統 API 換代,提示你改用新接口。這個項目裡最多的是 UILabel 計算文字尺寸的方法:

deprecated warning

deprecated warning

2.2 格式化字符串問題(Format String Issue)——這類大多能讓系統自動修復。

Format String Issue

2.3 返回類型衝突(Conflicting Return Type)——同屬 API 升級的連帶影響,按提示改即可。

Conflicting Return Type

2.4 缺失 [super awakeFromNib]——純粹是代碼風格遺留。項目裡所有 cell 都沒調 super。工程實踐中我們通常會有 RootTableViewCell,在裡面統一做全局初始化,子類漏掉 super 就等於丟失了父類設置。二話不說,補上。

missing [super awakeFromNib]

missing [super awakeFromNib]

2.5 一個 ARC 的隱藏 Bug

現象很典型:Debug 運行一切正常,打包安裝到真機就閃退。調試時抓不到 Crash,這時 Crashlytics 就派上用場了。登錄後台可以看到清晰的崩潰日誌,原因是 unrecognized selector sent to instance——某個 NSDictionary 收到了 objectAtIndex: 消息。

Crashlytics 崩潰日誌

日誌還指出崩潰在第 305 行:

問題代碼

代碼確實調了 objectAtIndex,而這個屬性聲明的是 NSArray,怎麼會變成字典?

數組屬性聲明

仔看才發現,這個屬性的修飾符是 assign。assign 只用於非指針的基礎類型,不會增加引用計數,於是數組創建後立刻被釋放,野指針被 reused 成了別的對象,才報出莫名其妙的 selector 錯誤。改成 strong 即可。

改成 strong

至此,整個項目 build success。

3. 補充日誌

項目能跑了,但我對它的業務邏輯一無所知。文檔缺失的情況下,只能靠自己把玩 App、逐頁點擊。為了加速理解,必須補日誌——而原工程幾乎沒有任何 log。

3.1 頁面生命週期。所幸所有 VC 都繼承自同一個 RootController,於是在基類中打印 viewDidLoad 與 viewWillAppear,Debug 時一操作就知道當前是哪個頁面:

#ifdef DEBUG
    DDLogInfo(@"%@ viewDidLoad", [self class]);
#endif
#ifdef DEBUG
    DDLogInfo(@"%@ viewWillAppear", [self class]);
#endif

3.2 網絡請求。打印 URL、Method(GET/POST)、參數和 Header。特別打印 Header,是因為其中帶 access token,這樣就能直接用 Postman 調試需要登錄的接口,不必在 App 裡反覆點擊觸發請求。

網絡日誌

Postman,網絡調試利器

3.3 數據庫路徑。打印 database 文件路徑,模擬器調試時可以直接打開運行中 App 的庫文件。

4. 移除無效代碼

日誌齊了,可以安心梳理業務。與需求方溝通後確認部分功能可以下線,於是進入刪代碼環節——依然是體力活。

5. 工程整理

5.1 模塊化目錄。採用最主流的 MVC 結構:

目錄結構

5.2 網絡層。用的是 AFNetworking,需要整理三件事:確認 Dev / Stg / Pro 三套服務器地址;依賴 Network Log 補全接口文檔;閱讀代碼理解原網絡層的組織方式(這部分可以稍後再說)。

5.3 數據庫。依賴庫是 FMDB,我用 MesaSQLite 作為客戶端。這部分需要他人配合,暫且擱置。

6. storyboard 臃腫

原項目把所有 ViewController 都塞在同一個 storyboard 裡。打開它需要等待——大約三分鐘,注意下圖我已經縮放到 6.25%:

storyboard

這部分我還沒動手,先記錄兩個方案:

方案一:Storyboard References。iOS 9 引入的能力,允許在 segue 中引用其他 storyboard 的 viewController,天然支持模塊化拆分,體積變小、易於管理,團隊協作時合併衝突也少。但我們項目還在 8.0,要先權衡是否升到 9.0。

方案二:拆成 xib。storyboard 的優點是能一眼看清頁面跳轉關係,缺點是撐不起龐大項目。改成「一個 ViewController 對應一個 xib」擴展性極好,但原 storyboard 裡三十多個 VC 的遷移本身就是個不小的工程。

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