一、概述
Objective-C 公用庫的使用場景相當常見:iOS SDK 本身就是公用庫的集合;一些開放平台為了方便開發者開發第三方 App,會提供對應平台的 SDK;還有一個場景是,比較大的公司往往有多個甚至幾十個 App,各 App 之間難免有重複的邏輯,為了「提升效率」「安全性」或達成業務指標,就會推一些公用庫供內部各 App 使用。
公用庫本質上就是一些可重用邏輯的集合,是「分而治之」的一種途徑,其存在形式可以是原始碼,也可以是二進位檔。
公用庫也需要理清自己的依賴關係,比如依賴系統 SDK 的哪些庫、哪些接口(這決定了公用庫適用的系統版本),依賴哪些第三方庫。不過,你要是想把一個東西拿出去給別人用,那就得想方設法減少不必要的依賴。
作為公用庫的開發者,在把公用庫提供給他人使用時,需要站在使用者的角度思考問題——公用庫的接口以及接入使用的繁簡,體現的是作者的職業道德與素養。
二、設計與實現
第一步當然是明確公用庫的目標:要做什麼、不做什麼,一二三四列出來,並在後續實現中盡可能地堅持目標原則。
專案的構建也有幾種選擇:
使用 Xcode 的「Cocoa Touch Static Library」專案模板新建專案,target 為一個靜態庫;
安裝 iOS Universal Framework 後,在 Xcode 中透過其提供的「Static iOS Framework」模板新建專案,其 target 為 framework 庫。
此外,你可以在上述基礎上,透過 CocoaPods 來管理你自己公用庫的依賴。
實現時,公用庫自身的原始碼要全部放到某個目錄或其子目錄中(指的是那些可以直接拷貝出去使用的原始碼,不包括自身編譯所依賴的檔案,比如 prefix.pch)。
標頭檔只暴露那些必須的;能在實現檔中引入的,就在實現檔中引入。如果在需要暴露的標頭檔中引入了另一個標頭檔,那麼那個標頭檔也必須要暴露出來。
另一個常見問題,是接口的方法聲明不遵循 Objective-C 的語言規範,給人以山寨的感覺。建議公用庫的實現最好有一位熟悉當前語言的老手帶著做,熟悉語言的規範與常用範式,比如何時使用 delegate、何時使用 block。
還有就是在實現時盡可能少地引入第三方依賴。如果確實需要引入,那麼編譯時千萬別把公用庫自身依賴的第三方內容當成自己的一部分;如果你非要把它們變成自己的一部分,那至少得修改這些依賴相關類的類名、靜態變量名,若是 category,還得修改其方法名。
最後,你得堅持良好的註釋與文檔。某個方法若有需要特別注意的地方,就要註釋說明;你還得提供一個 README 檔,用於描述當前庫的目的,以及各個接口的使用範例。
三、分發與集成
其實在公用庫構建的初期,你就得想好分發的方式——一種好的分發方式,能大大降低公用庫集成使用的成本。
一個公用庫要給別人用,無非兩種形式:原始碼或二進位格式(額外提供標頭檔、資源檔)。原始碼形式方便使用者調試,二進位格式則適用於那些不方便公開原始碼的公用庫。
先談原始碼形式,原始碼一般放在某個版本控制庫中:
以前很多人直接下載下來,把相關類拷貝進自己的工程裡使用。這樣的壞處是無法明確知道公用庫的版本,而且一旦作者做了更新,你還得手動再拷貝一次,比較麻煩。
後來開始用 git 的 submodule,主工程無需把公用庫原始碼放進自己的 git 庫,而且第三方庫能方便地更新、切換分支等。這種情況下最好讓主工程依賴此第三方庫編譯出來的 target(比如靜態庫),這樣當公用庫有檔案增刪時,無需改動主工程專案檔。
最近我比較推薦 CocoaPods 的方式,它的主要優點就是依賴關係的管理,本質上也是把公用庫編譯成靜態庫,再讓主工程依賴這個靜態庫。
二進位形式要談的東西更多,一般有兩種方式:
一種是簡單的靜態庫,也就是常見的 xxx.a 檔,使用時需要額外提供標頭檔或資源檔(資源檔通常以 bundle 形式提供)。Xcode 預設就是這種方式,只不過你建立公用庫專案時編譯出的靜態庫只支援特定的一種硬件架構,若想生成一個 Universal 的靜態庫,就得透過工具把多個靜態庫合併起來。
另一種是 framework 方式,此方式 Xcode 預設並不支援。你在 iOS 開發中應該接觸過不少 framework 庫,那些都是系統自帶、供系統中所有 App 共享使用的庫。framework 庫的好處是不但可以包含二進位檔,還能包含標頭檔、資源檔,甚至支援多個版本。各 App 所使用的公用庫最終都需要 link 進可執行檔,所以本質上仍是靜態庫。因此有一些第三方方案(比如 iOS Universal Framework)能幫你用 Xcode 編譯出 framework 庫,但其中還是有不少坑:比如 Xcode 並不識別 framework 中的資源檔,於是有了 Embedded Framework 方案;雖然 framework 最終只是一個 bundle(一個按規定目錄結構組織文件的文件夾),但對 Xcode 而言,這樣的 target 還是有真假(Real/Fake)之分,只有真的情況下,主工程在添加依賴時才能選中此公用庫專案的 framework target。
CocoaPods 也支援管理二進位格式,可以在 podspec 中透過 vendored_frameworks 或 vendored_libraries 來指定你要分發的庫。
無論你用何種方式分發公用庫,都得明確聲明它適用的系統版本、依賴哪些系統 SDK 框架或靜態庫、依賴哪些第三方庫及對應版本——這既是對自己負責,也是對別人負責。
使用公用庫時,Xcode 都是透過 header search path 來尋找靜態庫的標頭檔、透過 framework search path 來尋找 framework 的;而當用 CocoaPods 管理時,這些環境變量的設定都會由它自動完成,寫在其生成的 xcconfig 檔中。
四、和庫相關的幾個指令
下面幾個指令都和二進位庫相關。這些二進位檔可以叫做物件檔,在 Mac 或 iOS 平台上用的都是 Mach-O(Mach Object),所以這些指令其實都是讀取或操作 Mach Object 的,你可以透過 man 查看相應的用戶手冊。
nm
display name list (symbol table),其實就是把物件檔中的相關符號標識都列出來。
otool
otool,顧名思義就是 object tool,相比 nm 功能更強大,可以查看物件檔的方方面面,比如展示物件檔的 Mach Header、用到了哪些共享庫(shared libraries),或者資料段內容等。
lipo
create or operate on universal files,此指令主要幫你查看或建立支援多平台的靜態庫,比如把兩台不同平台的靜態庫進行合併。