Objective-C 是一門動態的、面向對象的 C 語言擴展。它被設計得易讀易用,同時支持複雜的面向對象設計,是 Mac OS X 與 iPhone 平台上開發新應用的主要語言。Cocoa 則是 Mac OS X 上一個主要的應用框架,以 Objective-C 類集合的形式提供快速開發能力。
Apple 已經為 Objective-C 編寫了一本優秀且被广泛接受的編碼指南,Google 也為 C++ 寫過類似的文檔。本文這份指南,相當於把 Apple 的建議與 Google 的一般性建議做了自然組合。閱讀之前,建議先讀過 Apple 的 Cocoa Coding Guidelines 與 Google 的 C++ Style Guide。
需要特別注意:所有在 Google C++ 指南中被禁用的規則,在 Objective-C++ 中同樣適用,除非本文另有說明。此外,這份文檔描述的是編碼規範與實踐,並不是 Objective-C 教程 —— 它假定讀者已對這門語言相當熟悉。
先來看一個頭文件,展示 @interface 的正確注釋與間距:
#import <Foundation/Foundation.h>
// A sample class demonstrating good Objective-C style. All interfaces,
// categories, and protocols (read: all top-level declarations in a header)
// MUST be commented. Comments must also be adjacent to the object they're
// documenting.
//
// (no blank line between this comment and the interface)
@interface Foo : NSObject {
@private
NSString *_bar;
NSString *_bam;
}
// Returns an autoreleased instance of Foo. See -initWithBar: for details
// about |bar|.
+ (id)fooWithBar:(NSString *)bar;
// Designated initializer. |bar| is a thing that represents a thing that
// does a thing.
- (id)initWithBar:(NSString *)bar;
// Gets and sets |_bar|.
- (NSString *)bar;
- (void)setBar:(NSString *)bar;
// Does some work with |blah| and returns YES if the work was completed
// successfully, and NO otherwise.
- (BOOL)doWorkWithBlah:(NSString *)blah;
@end
源文件示例,同時包含 getter、setter、init、dealloc 的參考實現:
#import "Foo.h"
@implementation Foo
+ (id)fooWithBar:(NSString *)bar {
return [[[self alloc] initWithBar:bar] autorelease];
}
// Must always override super's designated initializer.
- (id)init {
return [self initWithBar:nil];
}
- (id)initWithBar:(NSString *)bar {
if ((self = [super init])) {
_bar = [bar copy];
_bam = [[NSString alloc] initWithFormat:@"hi %d", 3];
}
return self;
}
- (void)dealloc {
[_bar release];
[_bam release];
[super dealloc];
}
- (NSString *)bar {
return _bar;
}
- (void)setBar:(NSString *)bar {
[_bar autorelease];
_bar = [bar copy];
}
- (BOOL)doWorkWithBlah:(NSString *)blah {
// ...
return NO;
}
@end
@interface、@implementation 與 @end 前後的空行是可選的。如果 interface 聲明了實例變量,右括號之後需要一個空行。除非 interface 或 implementation 很短(比如只定義幾個私有方法或一個橋接類),否則添加空行通常更有利於可讀性。
空格與制表符:只用空格,每級縮進 2 個空格,不使用 tab。
行寬:盡量控制在 80 字符以內。
方法聲明與定義:-(或 +)與返回值類型之間要有一個空格;參數列表中除參數之間外不加多餘間距。
方法調用:格式應與聲明保持一致。有多種寫法可選時,沿用當前源文件中已有的風格。
訪問修飾符:@public 與 @private 之後要有一個空格。
異常:@try、@catch、@finally 各自獨立一行,標簽與後面的花括號之間留一個空格。
協議:類型標識符與尖括號包裹的協議名之間不加空格。
Block:創建回調時優先使用 block 而非 target-selector 模式,可讀性更好。block 內部代碼縮進 4 個空格。
命名規則對可維護性至關重要。Objective-C 的方法名往往很長,但這換來的是「像讀散文一樣」的閱讀體驗,同時也省下了大量解釋性注釋。
編寫純 Objective-C 代碼時遵循標準的 Objective-C 命名規範即可。這套規範與 C++ 差異不小:Google C++ 規範建議變量名用下劃線分隔單詞,而 Objective-C 社區的標準做法是駝峰命名。
類名:首字母大寫駝峰式,如 MyClass。
分類(Category)名:以 2 到 3 個字母的前綴開頭,用於標識所屬項目或表明是公開擴展,並結合被擴展類的名字。
方法名:首字母小寫駝峰式,每個命名參數也以小寫字母開頭。
變量名:首字母小寫駝峰式;實例變量以下劃線前綴,如 myLocalVariable 與 _myInstanceVariable。
縮略詞:類名、方法名、變量名中的首字母縮略詞一律大寫,蘋果官方的例子包括 URL、TIFF、EXIF。
文件名:應反映其中包含的類名,大小寫風格與項目約定一致。
Objective-C++ 的衝突處理:很多項目會用 C++ 寫後端、用 Cocoa 寫前端來實現跨平台 API,這會導致兩套命名規範正面衝突。的解決辦法是依據當前所在的實現方式決定風格:在 @implementation 塊內遵循 Objective-C 規範;在 C++ 類中實現方法時遵循 C++ 規範。這樣就避免了同一函數內實例變量與局部變量命名規則混用的尷尬。
寫注釋雖然痛苦,但對代碼可讀性至關重要。不過要記住:最好的代碼是自解釋的 —— 給變量和類型起一個有意義的名字,遠比用晦澀的名字再費力解釋要好。
寫注釋時要把讀者設想成「下一個要讀懂這段代碼的人」。多寫一點吧,那個人很可能就是幾個月後的你自己。C++ 規範中的所有規則在此同樣生效,此外還有幾點補充:
文件注釋:可以在文件開頭選擇性地寫一段內容概述。
聲明注釋:每個接口、分類、協議的聲明都應有伴隨注釋,說明其作用與在整體架構中的位置。
實現注釋:豎向對齊引用變量名與符號,不要擠成一整行。
所有權說明:當指針所有權模型超出常見 Objective-C 用法時,描述得越明確越好。
私有實例變量:聲明在頭文件中的變量必須標記為 @private。
標識初始化器:要清楚標識哪個是 designated initializer,並確保重寫父類的 designated initializer。
重寫 NSObject 方法:建議放在 @implementation 的靠上位置。
初始化:不要在 init 中把變量顯式初始化為 0 或 nil,這是多餘的。
避免 new:不要調用 new,也不要重寫它;用 init 系列方法完成實例化。
保持公有 API 精簡:沒必要公開的方法就用 private 藏起來,避免公有頭文件變得雜亂。
#import 與 #include:引入 Objective-C 頭文件用 #import,引入 C/C++ 頭文件用 #include。
用后即釋:臨時對象在創建那一行附近就銷毀釋放,比在同一方法內先創建一批再統一釋放更好。
避免在 init/dealloc 中調用訪問器:這兩個方法執行期間子類狀態可能尚不完整。
dealloc 順序:釋放實例變量的順序應與 @interface 中的聲明順序一致,方便審查者核對。
NSString setter 必須 copy:防止外部傳入可變字符串後被修改。
不要主動拋出異常:但應準備好捕獲來自第三方或系統調用的異常。
nil 檢查:只在邏輯流確實需要時才做 nil 判斷。
BOOL 陷阱:把普通整型轉為 BOOL 時要小心,避免直接與 YES 比較 —— 任何非 0 值都是真,但並不一定等於 YES(也就是 1)。
@property 是 Objective-C 2.0 的特性,只在 iPhone 與 Mac OS X 10.5(Snow Leopard)及以上版本可用。點語法也僅在聲明了 @property 的情況下才允許使用。
接口中除空大括號外,不應再聲明任何實例變量 —— 現代 Objective-C 支持自動合成實例變量,無需顯式聲明。編寫的代碼若必須支持更早的編譯工具鏈(Xcode 4.3 或更早、GCC),則需顯式寫 @synthesize。
由於項目通常基於 Xcode 4.2 及以上版本,運行環境為 64 位 Mac OS X 10.7 與 iOS 5.0 及以上,ARC 是優先選擇。手動引用計數在支持早期環境的零弱化指針時才會用到。
幾條 ARC 相關約定:
使用 ARC 的類應加入預處理指令,防止被誤用 MRC 方式編譯。
所有權限定符(如 __unsafe_unretained、__weak)寫在變量名之前。變量無需指定 __strong(默認即為 strong),但屬性應始終顯式聲明 strong,不要依賴編譯器默認值。
NSNumber 字面值語法(@42)在 Xcode 4.4 及以上可用,但會降低代碼對其他工具鏈的可移植性。
委派對象不應被保留。delegate 一律聲明為 weak 或 assign,否則極易形成循環引用。
MVC 分離。模型與視圖分離,控制器與視圖、模型分離。回調類 API 用 @protocol 聲明。
實例變量命名曾經採用後綴下劃線(如 bar_),如今主流做法已改為前綴下劃線(_bar)。遇到老代碼時不必強行統一,但新代碼應遵循前綴風格。
最後提醒一句:這份指南基於 MRC 時代編寫,其中的 autorelease、release、dealloc 等內容在 ARC 項目中已不適用。但間距、命名、注釋、MVC 分層等約定至今仍然是判斷 Objective-C 代碼質量的重要標準。