一、為什麼要讀這份文檔
跳進 iOS 這個坑著實不省心。無論 Swift 還是 Objective-C,都沒有在其他地方被廣泛使用,這個平台幾乎每樣東西都有自己的命名習慣,就連真機調試都滿是坎坷。不管你是剛入門 Cocoa,還是想糾正既有開發習慣的老手,都能從本文獲益。不過以下內容僅為建議,如果你有更妙的方案,儘管去試!
二、入門
Xcode
Xcode 是多數 iOS 開發者的選擇,也是 Apple 唯一官方支持的 IDE。雖然還有 AppCode 之類的選擇且頗有名氣,但除非你是身經百戰的老手,否則就用 Xcode 吧。別計較它那些小毛病,如今它已經相當好用了。
安裝 Xcode 很簡單,從 Mac App Store 下載即可,它會順帶下載最新的 SDK 和模擬器,你也可以在 Preferences > Downloads 裡下載更多內容。
項目初始化
開始 iOS 開發時,一個常見問題是:究竟該用代碼寫所有 view,還是使用 Interface Builder(Storyboards 或 XIB)?兩種方案都各有擁護者,可以從以下幾點權衡:
為什麼選代碼?
Storyboard 因其複雜的 XML 結構容易引發版本沖突,讓代碼合並變得棘手。
用代碼更容易結構化並復用 view,讓代碼更 DRY。
所有信息集中一處,不必在 Interface Builder 裡逐個點開檢查器翻找。
為什麼用 Storyboard?
門檻更低,Storyboard 提供了一種直觀的入門方式,比如直接調顏色或布局約束。但它要求項目已做好配置,且開發者具備一定基礎。
不用構建項目就能看到變化,集成更快。
在 Xcode 6 裡,自定義字體和 UI 元素都能在 storyboard 中可視化呈現,比在代碼裡改方便得多。
從 iOS 8 起,Size Classes 讓你能一次設計多種設備屏幕,省去重複勞動。
忽略文件
把項目納入版本控制時,先準備一份得力的 .gitignore 文件,這樣用戶設置、臨時文件等不必要的內容就不會混進倉庫。所幸 GitHub 已經為 Objective-C 和 Swift 提供了現成模板。
CocoaPods
如果你打算引入外部依賴(比如第三方庫),CocoaPods 提供了一條捷徑:
sudo gem install cocoapods
開始使用,只需在 iOS 項目目錄下執行:
pod init
它會生成一個 Podfile 來管理你所有的依賴。把依賴加進 Podfile 後,執行
pod install
即可安裝第三方庫,並把它們作為 workspace 的一部分——你的 workspace 也會包含自己的項目。通常建議把項目依賴提交進倉庫,而不是讓每個開發者在 checkout 後各自執行 pod install。
注意此後你需要打開 .xcworkspace 而非 .xcproject,否則代碼無法編譯。命令
pod update
會把所有 pod 升級到最新版本,你也可以用相應符號來定義期望的版本需求。
三、項目結構
為了有序管理目錄裡成百上千的源文件,最好依據架構規劃一套文件結構,比如:
├─ Models ├─ Views ├─ Controllers ├─ Stores ├─ Helpers
先在 Xcode 項目導航裡把它們建成 Group(黃色目錄),然後為組內每個文件關聯到真實的文件目錄——打開右側的文件檢查器,點擊那個小小的文件夾圖標,在項目目錄下創建一個與 group 同名的子目錄即可。
本地化
從一開始就該把所有展示給用戶的字符串放進本地化文件。這不只是為了翻譯方便,也便於集中查找用戶可見的文本。你可以在 build Scheme 裡加一個啟動參數來指定語言:
-AppleLanguages (Finnish)
對於更複雜的翻譯場景,比如復數(如 "1 person" 與 "3 people"),應使用 .stringsdict 格式,而非普通的 localizable.strings 文件。這個強大的工具能處理 "one"、"some"、"few"、"many" 等情況,面對俄語、阿拉伯語時就不必抓耳撓腮了。
關於本地化的更多信息,可參考 2012 年 2 月 Helsink iOS 會議的幻燈片,其中大部分內容至今仍適用。
常量
創建一個由 prefix header 引入的 Constants.h 文件。
不要用宏定義(#define),而要用真正的常量:
static CGFloat const XYZBrandingFontSizeSmall = 12.0f; static NSString * const XYZAwesomenessDeliveredNotificationName = @"foo";
常量類型安全、作用域更明確(不會洩露到所有引入該頭文件的地方),不能被重定義,而且可以在調試器中查看。
分支模型
尤其在分發 app(如提交 App Store)時,最好用特別的 tag 來標記分支;而新功能開發會產生大量 commit,也應在獨立分支上進行。git-flow 就是幫你遵循這一約定的工具,它簡潔地封裝了 git 的分支與 tag 命令,幫助維護正確的分支結構。所有開發分支(如 develop)、對應 app 版本的 tag 分支以及合入 master 的操作:
git flow release finish
四、常用庫
總的來說,引入第三方庫前要三思。一個精巧的庫或許能解你當下的燃眉之急,但日後可能陷入維護噩夢——比如下個系統版本改動了某些東西,或某個第三方庫的功能被官方 API 取代。好在只要設計良好,替換實現並不難。能優先用 Apple 廣泛(且優秀)的框架就儘管用。
本節力求精簡。這些庫的價值在於削減模板代碼(如 AutoLayout),或解決那些複雜到需要大量測試的問題(如日期計算)。當你在 iOS 上愈發嫻熟,去挖掘它們的源碼、藉此認識底層的 Apple 框架,你會發現它們能替你幹掉大量體力活。
AFNetworking
99.95% 的 iOS 開發者都在用它。即便 NSURLSession 本身已相當完善,AFNetworking 仍憑藉眾多 app 都需要的請求隊列管理功能屹立不倒。
DateTools 日期工具
總的原則是:別自己寫日期計算。所幸有 DateTools,它採用 MIT 協議、經過充分測試,需要處理日期時可放心使用。
Auto Layout 庫
如果你偏愛用代碼寫界面,應該領教過 Apple 那套笨重的 NSLayoutConstraint 工廠或 Visual Format Language——前者囉嗦,後者基於字符串、不利於編譯器檢查。
Masonry 用自己的 DSL 取代了那些常量,Swift 裡類似的庫是 Cartography,它充分利用了語言豐富的操作符重載特性。若想更保守些,FLKAutoLayout 提供了一個乾淨、少點「魔法」的原生 API 包裝。
Architecture 架構
Model-View-Controller-Store (MVCS)
這是 Apple 的默認架構(MVC),通過擴展增加一個表示 Model 實例的存儲層,負責處理網絡、緩存等。
每個存儲通過 RACSignals 或返回 void 的自定義 block 方法來返回結果。
Model-View-ViewModel (MVVM)
針對「massive view controllers」問題,MVVM 認為 UIViewController 子類是 view 的一部分,應保持精簡,把狀態交給 viewmodel 維持。
對 Cocoa 開發者而言是個新概念,但正逐步獲得認同。
View-Interactor-Presenter-Entity-Routing (VIPER)
當 MVVM 都顯得複雜、且高度重視測試時,大型項目值得一試的架構。
五、事件模式
這裡列舉幾種通知其他對象的常用方式:
Delegation(委托):一對一。Apple 用得很多(甚至太多)。常用於回調,比如 Model View 的回調。
Callback blocks(回調代碼塊):一對一。更為解耦,能把相關代碼段聚在一起,在 sender 眾多時也比委托更具擴展性。
Notification Center(通知):一對多。最常用的向多個觀察者廣播事件的方式,極為解耦——甚至能全局觀察,而無需引用派發對象。
Key-Value Observing(KVO,鍵值編碼):一對多。無需觀察者明確知道發送時機,只要符合觀察的鍵(屬性)即可。通常不推薦,因為它不自然的特性和繁瑣的 API。
Signals(信號):一對多。ReactiveCocoa 的核心,允許鏈接與組合,能有效避免 callback hell。
Models
讓你的 model 保持不可變,並用來改變遠程 API 的語義與類型。GitHub 的 Mantle 是個不錯的選擇。
Views
用 Auto Layout 布局 view 時,記得在父類中加入下面的代碼:
+ (BOOL)requiresConstraintBasedLayout { return YES; }否則當系統沒調用 -updateConstraints 時,你可能會遇到一些莫名其妙的 bug。
Controllers
建議採用依賴注入:把所需對象作為參數傳入,而不是把全部狀態塞進一個單例。後者僅在狀態確實全局時才適用。
+ [[FooDetailsViewController alloc] initWithFoo:(Foo *)foo];
六、網絡
傳統做法:回調 block
// GigStore.h typedef void (^FetchGigsBlock)(NSArray *gigs, NSError *error); - (void)fetchGigsForArtist:(Artist *)artist completion:(FetchGigsBlock)completion // GigsViewController.m [[GigStore sharedStore] fetchGigsForArtist:artist completion:^(NSArray *gigs, NSError *error) { if (!error) { // Do something with gigs } else { // :( } }];這樣能跑,但一旦有多個相互組合的網絡請求,就會陷入回調嵌套的地獄。
Reactive 做法:使用 RAC 信號
如果你已深陷回調地獄,不妨看看 ReactiveCocoa(RAC)。它是一個強大又多用的庫,能改變你寫整個 app 的方式,但你也可以在合適處保守地使用它。
Teehan+Lax 和 NSHipster 上有一些關於 RAC(以及廣義的 FRP)和函數式編程概念的優秀介紹。
// GigStore.h - (RACSignal *)gigsForArtist:(Artist *)artist; // GigsViewController.m [[GigStore sharedStore] gigsForArtist:artist] subscribeNext:^(NSArray *gigs) { // Do something with gigs } error:^(NSError *error) { // :( } ];它允許通過信號與其他信號的組合,在展示前先做一些加工。
七、Assets 資源
Asset catalogs 是管理項目所有可視化資源的最佳方式。它能同時管理通用資源和設備相關資源(iPhone 4-inch、iPhone Retina、iPad 等),並自動按名稱分組。教會設計師怎麼添加它們(Xcode 內置 Git 客戶端)能省下大量時間,否則你會花很多精力從郵件等渠道把資源拷進代碼庫。這樣設計師就能立刻看到資源改動的效果並反覆試驗。
使用位圖圖片
Asset catalogs 只暴露圖片集裡那個抽象的名稱,這能避免資源命名沖突,就像 button_large@2x.png 的命名空間被收攏在它的圖片集裡。遵守一些命名規則會讓日子更好過:
IconCheckmarkHighlighted.png // Universal, non-Retina IconCheckmarkHighlighted@2x.png // Universal, Retina IconCheckmarkHighlighted~iphone.png // iPhone, non-Retina IconCheckmarkHighlighted@2x~iphone.png // iPhone, Retina IconCheckmarkHighlighted-568h@2x~iphone.png // iPhone, Retina, 4-inch IconCheckmarkHighlighted~ipad.png // iPad, non-Retina IconCheckmarkHighlighted@2x~ipad.png // iPad, Retina
後綴 -568h、@2x、~iphone 和 ~ipad 其實可以省略,但保留它們後,把文件拖進 Xcode 時它能正確辨識,避免手動賦值出錯。
使用向量圖
你可以把設計師的原始 vector graphics(PDF)加入 asset catalogs,Xcode 會自動據此生成位圖,從而降低工程複雜度(要管理的文件更少)。
八、代碼風格
命名
儘管命名約定很長,Apple 卻始終在 API 中恪守命名原則。這裡有幾條值得遵循的基本準則:
以動詞開頭的方法表示它有副作用,且不返回任何東西:
- (void)loadView;
- (void)startAnimating;
任何以名詞開頭的方法則沒有副作用,並返回所指的對象:
- (UINavigationItem *)navigationItem;
+ (UILabel *)labelWithText:(NSString *)text;
盡量把兩者分開——不要在操作數據時產生副作用,反之亦然。這能把副作用收攏到代碼更小的粒度裡,否則調試會變得異常困難。
結構
Pragma marks 是組織代碼分組的好幫手,尤其在 view Controller 裡。下面的結構適用於絕大多數 view Controller:
#import "SomeModel.h" #import "SomeView.h" #import "SomeController.h" #import "SomeStore.h" #import "SomeHelper.h" #import static NSString * const XYZFooStringConstant = @"FoobarConstant"; static CGFloat const XYZFooFloatConstant = 1234.5; @interface XYZFooViewController () @property (nonatomic, copy, readonly) Foo *foo; @end @implementation XYZFooViewController #pragma mark - Lifecycle - (instancetype)initWithFoo:(Foo *)foo; - (void)dealloc; #pragma mark - View Lifecycle - (void)viewDidLoad; - (void)viewWillAppear:(BOOL)animated; #pragma mark - Layout - (void)makeViewConstraints; #pragma mark - Public Interface - (void)startFooing; - (void)stopFooing; #pragma mark - User Interaction - (void)foobarButtonTapped; #pragma mark - XYZFoobarDelegate - (void)foobar:(Foobar *)foobar didSomethingWithFoo:(Foo *)foo; #pragma mark - Internal Helpers - (NSString *)displayNameForFoo:(Foo *)foo; @end
最重要的一點,是在你的項目各類中保持風格一致。
其他風格指南
我們公司沒有公司級的代碼風格指南,但翻翻其他開發者的 Objective-C 風格指南很有裨益,即便某些內容帶有公司色彩或過於激進。
GitHub
The New York Times
Ray Wenderlich
Sam Soffes
Luke Redpath
九、診斷
編譯警告
建議盡可能多地開啟編譯警告,並像對待錯誤一樣對待它們。推薦這份 PPT,它講了如何在特定文件或代碼段裡消除相關警告。
簡單說,至少在 "Other Warning Flags" 編譯設置裡定義以下值:
-Wall(增加大量警告)
-Wextra(增加更多警告)
同時開啟 "Treat warnings as errors"。
Clang 靜態分析
Clang 編譯器(Xcode 使用的)自帶一個靜態分析器,能對代碼的控制流和數據流進行分析,檢測許多編譯器發現不了的錯誤。
你可以通過 Xcode 的 Product → Analyze 菜單項手動執行代碼分析。
分析器支持淺或深兩種模式,後者更慢,但能從跨函數的控制流與數據流中挖掘更多問題。
建議:
開啟所有分析器檢查(在 build setting 中打開全部 "Static Analyzer" 選項)
在 release 編譯設置中開啟 "Analyze during 'Build'",讓分析器在構建發布版本時自動運行(省得你記得手動跑)
把 "Mode of Analysis for 'Analyze'" 設為 Shallow(更快)
把 "Mode of Analysis for 'Build'" 設為 Deep
Faux Pas
這是我們的 Ali Rantakari 打造的,是一款極佳的靜態錯誤檢測工具,能分析代碼並揪出那些連你自己都沒察覺的問題。提交 App 到商店前用它跑一遍吧!
調試
當 App 崩潰時,Xcode 默認不會自動跳進調試器。要調試,你需要加一個異常斷點(在 Xcode 的 Debug 導航裡點 "+"),好在異常發生時中斷執行。很多時候,你需要看看究竟是哪些代碼觸發了異常。它會捕捉任何異常,哪怕是已被處理的。如果 Xcode 停在第三方庫裡,比如說,你可以選擇 Edit Breakpoint 並把 Exception 設為 Objective-C。
對於視圖 debug,Reveal 和 Spark Inspector 這兩個強大的可視化檢查工具能幫你省下大量時間,特別是在用 Auto Layout 且想定位出問題或溢出屏幕的視圖時。Xcode 也提供了免費的類似功能,但僅適用於 iOS 8+,且不如它們好用。
分析
Xcode 有一個叫 Instruments 的分析工具,涵蓋內存、CPU、網絡通信、圖形等眾多領域。它有些複雜,但在追蹤內存洩漏時相當直觀:只需在 Xcode 中選擇 Product > Profile,選 Allocations,點 Record 按鈕,再用一些有用的字符串(比如你自己 app 的類名)過濾申請空間信息。它會在固定的列裡統計,並告訴你每個對象有多少實例,到底是哪個類在不斷增加實例導致洩漏。
Instruments 也有自動化工具,能錄製並運行 UI 交互及 JavaScript 文件。UI Auto Monkey 是一個自動隨機點擊、滑動、旋轉 app 的腳本,在壓力測試、滲透測試中頗有用處。
十、統計
強烈建議接入一些統計框架,它們能直觀地告訴你有多少人在用你的應用。X 功能是否提升了用戶量?Y 按鈕是不是太難找?要回答這些問題,你可以把事件、時長等信息發送到一個能聚合並可視化的服務,比如 Google Tag Manager。它比 Google Analytics 更實用的是,能在 app 與統計之間插入一層數據,讓數據邏輯可以通過 web 服務調整,而無需更新 app。
一個好做法是寫一個簡單的 helper 類,比如 XYZAnalyticsHelper,負責把 app 內部的 model 與數據格式(XYZModel、NSTimeInterval……)轉換成以字符串為主的數據層:
- (void)pushAddItemEventWithItem:(XYZItem *)item editMode:(XYZEditMode)editMode { NSString *editModeString = [self nameForEditMode:editMode]; [self pushToDataLayer:@{ @"event": "addItem", @"itemIdentifier": item.identifier, @"editMode": editModeString }]; }這樣做的另一個好處是,必要時你可以整體替換統計框架,而不必改動 app 其他部分。
Crash Logs 崩潰日志
應該讓你的 app 向某個服務發送崩潰日志。你可以通過 PLCrashReporter 加自建後端手動實現,但強烈建議直接用現成服務,比如:
Crashlytics
HockeyApp
Crittercism
Splunk MINTexpress
配置好後,記得為每個發布版本保存相應的 Xcode archive(.xcarchive)。這個歸檔包含構建出的 app 二進制與調試符號(dSYM),你需要用它把各個版本的 Crash 報告符號化。
十一、構建
構建設置
即便是最簡單的 app 也能以多種方式構建,最基本的區分就是 Xcode 提供的 debug 與 release 兩種方案。後者在編譯時有更多優化,可能引出一些需要你額外調試的問題。Apple 建議開發時用 debug、打包時用 release。這是默認的 Scheme(Play 和 Stop 後面的下拉菜單)——Run 時用 debug 設置,Archive 時用 release。
不過對於真正的 app,這樣似乎太簡單了。你通常還會設置多套配置以應對測試、staging 等開發活動,每套可能有各自的 URL、日志級別、bundle ID,好讓它們能共存於同一設備,並各有描述文件。單靠 debug/release 無法區分這些,你可以在項目的 Info 選項卡裡做更多編譯設置。
關於構建設置的 xcconfig 文件
構建設置通常在 Xcode GUI 裡定義,但你也可以用 configuration settings files(.xcconfig 文件),好處是:
你可以寫注釋
你可以 #include 其他構建設置文件,減少重復:
若有些設置適用於所有構建,就加一個 Common.xcconfig,並在其他配置文件裡 #include 它
若你想要一個開啟編譯器優化的 "Debug" 配置文件,只需 #include "MyApp_Debug.xcconfig" 來覆蓋其他設置
沖突解決和合並也更輕松
更多相關信息請看這份 PPT。
Targets
target 是比項目更低一級的概念。一個項目可能有多個 target,並可覆蓋項目設置。簡單說,一個 target 大致相當於一個 app。比如你可能基於同一套代碼,編譯出按國家區分的幾個 app 提交到 App Store。每個都有 development/staging/release 構建,因此最好用構建設置而非 target 來區分。一個 app 只有單個 target 反而是少見的。
Schemes
Scheme 告訴 Xcode 在你點擊 Run、Test、Profile、Analyze 或 Archive 時該如何行事,它把這些操作映射到某個 target 和某套構建設置。你可以傳遞啟動參數,比如指定 app 允許的語言(用來測試本地化)或一些調試用的診斷標志。
一個建議的 Scheme 命名是 MyApp (
MyApp (English) [Development] MyApp (German) [Development] MyApp [Testing] MyApp [Staging] MyApp [App Store]
對大多數環境來說,語言部分並非必需。若 app 以非 Xcode 的方式安裝(如通過 TestFlight),啟動參數會被忽略,此時要測試本地化就得手動設置設備語言。
十二、部署
把軟件部署到 iOS 真機並不直觀,但掌握幾個核心要點後會輕鬆很多。
簽名
要在真機上運行軟件,你得用 Apple 認證的證書來簽名。每張證書都關聯一對公、私密鑰,私鑰保存在你 Mac 的 KeyChain 裡。證書有兩類:
開發證書:每個團隊的開發者都有自己的證書,通過請求獲得。Xcode 能幫你完成,但最好別盲目點 "Fix issue",而是要理解它到底做了什麼。部署開發版本到設備時需要它。
發布證書:可以有多張,但最好每個組織一張,並通過內部渠道共享。提交 App 到 App Store 或企業內部 App Store 時需要它。
描述文件
除了證書,還有描述文件,它把設備與證書關聯起來,同樣分為開發和發布兩類。
Development provisioning profile:開發描述文件,它包含一份能安裝此 app 的設備列表,並關聯一張或多張授權使用的開發者證書。多數開發場景下,用一個通配符描述文件(Apple ID 以星號 (*) 結尾)會特別方便。
Distribution provisioning profile:發布描述文件本身也因用途不同而分多種。每個發布描述文件都鏈接到一張發布證書,並在證書過期時失效。
Ad-Hoc:和開發證書類似,它包含一份可安裝 app 的設備白名單,可用於 beta 測試,每年可測試 100 台設備。若想做更細緻的測試並擴展到 1000 名測試用戶,可用 Apple 新近推出的 TestFlight 服務,Supertop 提供了它優勢與問題的總結。
App Store:這種 profile 不列設備,任何人都能通過蘋果官方渠道安裝,所有上架 App Store 的 App 都需要它。
Enterprise:和 App Store 一樣沒有設備白名單,任何能接入企業內部網絡的人都能從內部「應用商店」安裝,這個商店可能只是一個帶鏈接的網站。此描述文件僅限企業賬號使用。
若想把所有證書與描述文件同步到本機,可去 Xcode 的 Preferences > Accounts,添加你的 Apple ID,然後雙擊團隊名稱,底部會有個刷新按鈕;有時你需要重啟 Xcode 才能讓內容顯示出來。
調試描述文件
偶爾你需要排查描述文件的問題。比如 Xcode 可能拒絕把 app 裝到某台設備上,因為它不在開發或 Ad-Hoc 描述文件的設備列表裡。此時你可以借助 Craig Hockenberry 的 Provisioning 插件,瀏覽 ~/Library/MobileDevice/Provisioning Profiles,選一個 .mobileprovision 文件,按空格鍵調用 Finder 的快速查看,它會告訴你設備、entitlements、證書及 Apple ID 等信息。
上傳
iTunes Connect 是你管理上傳至 App Store 的 App 的後台網站。Xcode 6 需要一個作為開發者賬號的 Apple ID 來簽名並上傳二進制。若你手上有多個開發者賬號要各自上傳,就需要點技巧。由於一個 Apple ID 只能關聯一個 iTunes Connect 賬號,一個變通辦法是為每個 iTunes Connect 賬號新建一個 Apple ID,改用 Application Loader 而非 Xcode 來上傳,這樣就等於把最終 .app 的構建簽名與上傳解耦了。
上傳二進制後耐心等待,可能要花一個小時。等你的 App 出現後,就能關聯到對應版本並提交審核。
十三、應用內購買
驗證 App 內購的 receipt 時,記得做以下檢查:
Authenticity:receipt 確實來自 Apple
Integrity:receipt 未被篡改
App match:receipt 的 App bundle ID 與你的 App 一致
Product match:receipt 裡的產品 ID 與你期望的一致
Freshness:你此前沒驗證過相同的 receipt ID
如果條件允許,把 IAP 銷售相關內容保存在服務器端,並只信任通過上述檢查的合法 receipt。這樣的設計能規避常見的盜竊手段;同時由於驗證在服務器完成,你可以改用 Apple 的 HTTP 驗證服務,而無需自己處理 PKCS #7 / ASN.1 格式。
更多相關內容可參考 Futurice blog: Validating in-app purchases in your iOS app。