《禪與 Objective-C 編程藝術》歸納了大量能提升程式碼品質與可讀性的實務慣例。本篇筆記整理其中的條件語句、case 語句、命名規範與類別設計等重點,並搭配推薦與不推薦的對照範例,幫助你寫出更優雅、更一致的 Objective-C 程式碼。
條件語句的主體應總是被大括號包圍,即使只有一行內容也一樣。這樣可避免一個常見錯誤:日後新增第二行程式碼時,誤以為它屬於 if 主體;更危險的是,若把 if 主體裡唯一的程式碼註解掉,下一行程式碼會在不知不覺中變成 if 的一部分。
推薦寫法:
if (!error) {
return success;
}
尤達表達式(Yoda conditions)是指拿常量去和變量比較,而不是變量和常量比較。它讀起來像是「藍色是不是天空的顏色」,而非自然的「天空是不是藍的」。這種寫法應避免。
推薦:
if ([myValue isEqual:@42]) { ... }
不推薦:
if ([@42 isEqual:myValue]) { ... }
檢查時使用感嘆號來判斷即可。由於 nil 會被解讀為 NO,沒必要在條件式中將它與其他值比較;同時也不要直接和 YES 比較,因為 YES 的定義是 1,而 BOOL 本質上是 8 位元的 char 型別。
推薦:
if (someObject) { ... }
if (![someObject boolValue]) { ... }
if (!someObject) { ... }
不推薦:
if (someObject == YES) { ... } // 錯誤
if (myRawValue == YES) { ... } // 切勿如此
if ([someObject boolValue] == NO) { ... }
撰寫條件語句時,左側程式碼的縮排應該是一條平整的「黃金大道」或「快樂大道」。也就是說,盡量避免巢狀的 if 語句,多個 return 是可以接受的。這樣能降低圈複雜度(Cyclomatic Complexity),讓程式碼更易讀,因為方法的核心邏輯不會被埋沒在層層分支裡。
推薦:
- (void)someMethod {
if (![someOther boolValue]) {
return;
}
// 執行重要邏輯
}
不推薦:
- (void)someMethod {
if ([someOther boolValue]) {
// 執行重要邏輯
}
}
當 if 子句較為複雜時,應把它們各自提取並賦值給 BOOL 變量,讓邏輯更清晰、每個子句的意義也更明確:
BOOL nameContainsSwift = [sessionName containsString:@"Swift"];
BOOL isCurrentYear = [sessionDateComponents year] == 2014;
BOOL isSwiftSession = nameContainsSwift && isCurrentYear;
if (isSwiftSession) {
// 執行某些很酷的操作
}
三元運算符 ? 只應用於能讓程式碼更清晰的場合。條件式中的各個變量應事先完成求值,若同時計算多個條件子句,反而會讓語句難以理解。
推薦:
result = a > b ? x : y;
不推薦:
result = a > b ? x = c > d ? c : d : y;
當三元運算符的回傳值與條件中檢查的物件相同時,可用更簡潔的寫法:
推薦:
result = object ?: [self createObject];
不推薦:
result = object ? object : [self createObject];
當方法回傳一個錯誤參數的參考時,應檢查回傳值,而非錯誤變量本身。
推薦:
NSError *error = nil;
if (![self trySomethingWithError:&error]) {
// 處理錯誤
}
此外,部分 Apple API 在成功的情況下會對 error 參數(若非 NULL)寫入垃圾值(garbage values),因此若去檢查 error 的值,反而可能導致錯誤甚至崩潰。
除非編譯器強制要求,case 語句中的括號並非必要;但當某個 case 包含多行程式碼時,就需要加上括號。有時可使用 fall-through(移除 break 讓程式往下執行)在不同 case 中共用相同邏輯。當 switch 中使用的變量是列舉型別時,default 並非必要;如此一來,若日後往 enum 新增了值卻未處理,編譯器便會立即發出警告。
Enumeration value 'ZOCEnumValue3' not handled in switch.
使用 enum 時,建議採用固定底層型別的定義,因為它具備更強的型別檢查與程式碼補全能力。SDK 提供了 NS_ENUM() 巨集來鼓勵這種寫法:
typedef NS_ENUM(NSUInteger, ZOCMachineState) {
ZOCMachineStateNone,
ZOCMachineStateIdle,
ZOCMachineStateRunning,
ZOCMachineStatePaused
};
盡可能遵循 Apple 的命名約定,尤其是與記憶體管理規則(NARC)相關的部分。推薦使用長而具描述性的方法與變量名稱。
推薦:
UIButton *settingsButton;
不推薦:
UIButton *setBut;
常量應使用駝峰命名法,並加上相關的類別名稱作為前綴以求清晰。
推薦:
static const NSTimeInterval ZOCSignInViewControllerFadeOutAnimationDuration = 0.4;
不推薦:
static const NSTimeInterval fadeOutTime = 0.4;
常量應以 static 宣告,避免使用 #define(除非它確實是作為巨集使用)。將常用值定義為常量,便於復用與快速修改,無須查找取代。推薦:
static NSString * const ZOCCacheControllerDidClearCacheNotification = @"ZOCCacheControllerDidClearCacheNotification";
static const CGFloat ZOCImageThumbnailHeight = 50.0f;
不推薦:
#define CompanyName @"Apple Inc."
#define magicNumber 42
常量應在介面檔中宣告:extern NSString *const ZOCCacheControllerDidClearCacheNotification;,並在實作檔中給出定義。只有公開的常量才需要加上命名空間前綴。
方法簽名中,在方法型別(-/+ 符號)之後應有一個空格,各方法段之間也應有空格(以符合 Apple 規範)。參數名稱之前應總是帶有描述性的關鍵詞。「and」的使用需謹慎,它不應用來暗示有多個參數,例如 initWithWidth:height: 這樣的寫法。
推薦:
- (void)setExampleText:(NSString *)text image:(UIImage *)image;
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;
不推薦:
- (void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height; // 切勿如此
建立不可變實例時,應使用 NSString、NSDictionary、NSArray、NSNumber 的字面值語法。特別注意 nil 不能放進 NSArray 與 NSDictionary,否則會導致崩潰。
推薦:
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018;
不推薦:
NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys:
@"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];
NSNumber *buildingZIPCode = [NSNumber numberWithInteger:10018];
至於可變副本,則建議直接使用明確的 NSMutableArray、NSMutableString 等類別,而避免 [@[] mutableCopy] 這類寫法——它既浪費效能(多了一個立即被丟棄的不可變物件),也影響可讀性。
類別名稱應加上三個大寫字母作為前綴(兩個字母的前綴保留給 Apple),用以緩解 Objective-C 缺乏命名空間的問題。建立子類別時,應把描述性部分放在前綴與父類別名稱之間。例如若已有 ZOCNetworkClient,其子類別應命名為 ZOCTwitterNetworkClient(Twitter 位於 ZOC 與 NetworkClient 之間);同理,UIViewController 的子類別會是 ZOCTimelineViewController。
推薦的程式碼組織方式:把 dealloc 放在實作檔最前面(緊接 @synthesize 與 @dynamic 之後),init 則放在 dealloc 之後。若有多個初始化方法,designated initializer 應放在第一位,secondary initializer 緊隨其後。即便有了 ARC、dealloc 幾乎不需實作,把 init 與 dealloc 放在一起仍能在視覺上強調兩者的對應關係——通常在 init 中做的事,往往需要在 dealloc 中撤銷。
init 方法應採用如下結構:
- (instancetype)init {
self = [super init]; // 呼叫 designated initializer
if (self) {
// 自訂的初始化邏輯
}
return self;
}
為何要將 self 設為 [super init] 的回傳值?這牽涉到 Objective-C 的「兩步建立」(two-step creation):alloc 負責分配記憶體(配置足夠的空間、寫入 isa 指標、初始化 retain 計數、將實例變量歸零),init 則負責把物件置於可用狀態(通常是把實例變量賦予合適的值)。
designated initializer 提供所有參數;secondary initializer 則是補上預設值後去呼叫 designated initializer。一個類別應有且只有一個 designated initializer,其他初始化方法都應呼叫它。
@implementation ZOCEvent
- (instancetype)initWithTitle:(NSString *)title
date:(NSDate *)date
location:(CLLocation *)location {
self = [super init];
if (self) {
_title = title;
_date = date;
_location = location;
}
return self;
}
- (instancetype)initWithTitle:(NSString *)title date:(NSDate *)date {
return [self initWithTitle:title date:date location:nil];
}
- (instancetype)initWithTitle:(NSString *)title {
return [self initWithTitle:title date:[NSDate date] location:nil];
}
@end
定義新類別時有三種情況:不需重載任何初始化方法、重載父類的 designated initializer、或定義全新的 designated initializer。若選擇第三種,應遵循三個步驟以確保正確性:
許多開發者忽略了後兩步,這不僅粗心,更違反了框架的規則,可能導致不確定的行為與 bug。正確實作如下:
@implementation ZOCNewsViewController
- (id)initWithNews:(ZOCNews *)news {
// 呼叫直接父類的 designated initializer
self = [super initWithNibName:nil bundle:nil];
if (self) {
_news = news;
}
return self;
}
// 重載直接父類的 designated initializer
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
// 呼叫新的 designated initializer
return [self initWithNews:nil];
}
@end
你可以透過兩個編譯器屬性來強化這套規則:以 __attribute__((objc_designated_initializer)) 標記 designated initializer,編譯器便會在你未正確呼叫父類實作時發出警告;以 __attribute__((unavailable("..."))) 讓不適用的初始化方法失效,一旦有人呼叫便會產生編譯錯誤。頭文件可寫成:
@interface ZOCNewsViewController : UIViewController
- (instancetype)initWithNews:(ZOCNews *)news ZOC_DESIGNATED_INITIALIZER;
- (instancetype)initWithNibName:(NSString *)nibNameOrNil
bundle:(NSBundle *)nibBundleOrNil ZOC_UNAVAILABLE_INSTEAD(initWithNews:);
- (instancetype)init ZOC_UNAVAILABLE_INSTEAD(initWithNews:);
@end
對於工廠方法或構造器方法,建議使用 instancetype 作為回傳型別。它能提示編譯器進行正確的型別檢查,而且更重要的是,這對其子類別同樣適用。
@interface ZOCPerson
+ (instancetype)personWithName:(NSString *)name;
@end
對於所有回傳類別實例的類別方法與實例方法(尤其是 alloc 與 init),都強烈建議使用 instancetype。
類簇(Class Cluster):善用類簇能消除大量條件語句。經典場景是同一個 UIViewController 子類別,在 iPad 與 iPhone 上呈現不同行為:
@implementation ZOCKintsugiPhotoViewController
- (id)initWithPhotos:(NSArray *)photos {
// 避免在子類別中重載初始化方法導致無限遞迴
if ([self isMemberOfClass:ZOCKintsugiPhotoViewController.class]) {
self = nil;
if ([UIDevice isPad]) {
self = [[ZOCKintsugiPhotoViewController_iPad alloc] initWithPhotos:photos];
} else {
self = [[ZOCKintsugiPhotoViewController_iPhone alloc] initWithPhotos:photos];
}
return self;
}
return [super initWithNibName:nil bundle:nil];
}
@end
單例(Singleton):如果可能的話,請盡量以依賴注入取代單例。若確實需要使用,請採用執行緒安全的建立方式。在 GCD 環境下,dispatch_once() 就是最佳選擇:
+ (instancetype)sharedInstance {
static id sharedInstance = nil;
static dispatch_once_t onceToken = 0;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
屬性應盡可能描述性地命名,避免縮寫,並以小寫字母開頭的駝峰命名。
推薦:
NSString *text;
不推薦:
NSString* text;
NSString * text;
你應總是透過 getter 與 setter 存取屬性,原因包括:
而傾向於使用 getter 的理由則有:對未來變更有擴展性、允許子類化、便於 debug、意圖更清晰(避免在 block 中直接存取 ivar 而無意間 retain self)、自動產生 KVO 通知,以及訊息分發帶來的開銷微不足道。
請注意:在 init(及其他初始化方法)與 dealloc 中,絕不可呼叫 getter/setter,而應直接存取實例變量。因為在初始化完成前,子類別可能重載了存取器並嘗試呼叫尚未就緒的其他方法或屬性;一個物件只有在 init 回傳後,才算真正進入可用狀態。存取屬性時應一律使用點語法。
推薦:
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;
不推薦:
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;
推薦依下列格式定義屬性:
@property (nonatomic, readwrite, copy) NSString *name;
屬性參數的順序應為:原子性、讀寫、記憶體管理。如此一來,屬性更易於正確修改,也更易讀。除非有特殊需求,否則應一律使用 nonatomic——在 iOS 中,atomic 帶來的鎖會明顯影響效能。若屬性要保存程式碼區塊(block),必須使用 copy,因為 block 最初建立在堆疊上,copy 會將它複製到堆上以延長生命週期。
若要實作「公開唯讀、私有可寫」,應在介面中宣告為 readonly,並在類別擴展中重新定義為 readwrite:
@interface MyClass : NSObject
@property (nonatomic, readonly) NSObject *object;
@end
@implementation MyClass ()
@property (nonatomic, readwrite, strong) NSObject *object;
@end
若 BOOL 屬性名稱本身已具描述性,可省略「is」,但要在 getter 中明確指定名稱:
@property (assign, getter=isEditable) BOOL editable;
如今 Xcode 已自動合成存取器,無須再手動撰寫 @synthesize。私有屬性應放在實作檔的類別擴展(class extension)中,而非具名的 category。
任何可能被設為可變物件(如 NSString、NSArray、NSURLRequest)的屬性,其記憶體管理型別必須是 copy,以確保寫入時發生複製、避免值在不知不覺中被竄改。同時應避免在公開介面暴露可變物件,以免外部得以改動你的內部表示、破壞封裝。可提供唯讀屬性回傳不可變副本:
/* .h */
@property (nonatomic, readonly) NSArray *elements;
/* .m */
- (NSArray *)elements {
return [self.mutableElements copy];
}
可選擇重載屬性的 getter 來做惰性初始化,常見模板如下:
- (NSDateFormatter *)dateFormatter {
if (!_dateFormatter) {
_dateFormatter = [[NSDateFormatter alloc] init];
NSLocale *enUSPOSIXLocale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"];
[_dateFormatter setLocale:enUSPOSIXLocale];
[_dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSSSS"];
}
return _dateFormatter;
}
參數斷言:當方法要求某些參數必須滿足特定條件(如不可為 nil)時,最好使用 NSParameterAssert() 斷言條件是否成立或拋出例外。
私有方法:切勿在私有方法名稱前加上底線 _ 前綴,這是 Apple 保留的命名空間,以免不小心覆寫了 Apple 的私有方法。
你需要同時實作 isEqual: 與 hash 方法。若兩個物件被 isEqual 判定為相等,它們的 hash 就必須回傳相同的值;反之,hash 相同並不代表兩者相等。這個約定之所以重要,是因為當物件被存入 NSDictionary、NSSet 等以雜湊表為底層的容器時,會依賴 hash 來查找。切记 hash 不可回傳常量,否則會導致雜湊表近乎 100% 碰撞、嚴重影響效能。相等性檢查建議以 isEqualTo<ClassName>: 的格式實作,讓型別檢查優先呼叫它。
- (BOOL)isEqual:(id)object {
if (self == object) {
return YES;
}
if (![object isKindOfClass:[ZOCPerson class]]) {
return NO;
}
return [self isEqualToPerson:(ZOCPerson *)object];
}
- (BOOL)isEqualToPerson:(ZOCPerson *)person {
if (!person) {
return NO;
}
BOOL namesMatch = (!self.name && !person.name) || [self.name isEqualToString:person.name];
BOOL birthdaysMatch = (!self.birthday && !person.birthday) || [self.birthday isEqualToDate:person.birthday];
return namesMatch && birthdaysMatch;
}
一個物件實例的 hash 計算結果必須是確定的。當它被加入容器(如 NSArray、NSSet、NSDictionary)時這尤其重要,否則行為將無法預測。因此,應以不可變屬性來計算 hash,或者更好的做法是讓物件保持不可變。
這些看似細節的慣例,背後都指向同一個目標:讓程式碼更易讀、更安全、更易維護。養成這些習慣,不僅能減少潛在的 bug,也能讓你在團隊協作時,寫出與 Apple 生態一致且專業的 Objective-C 程式碼。