
本文為投稿文章,作者:RylanJIN
最近被安排去處理專案的隨機 crash,前前後後修了十來個 issue。回頭歸納,發現這些問題或多或少都跟程式碼習慣與編碼規範有關——可見一個好的 coding 習慣有多重要。趁著休假把自認為值得堅持的一些規範整理出來,並搭配實際遇到的案例分享。
命名規範
Objective-C 的命名有兩大原則:可讀性要高,以及透過前綴防止命名衝突。名稱通常偏長,採用駝峰式命名。判斷標準其實很簡單——看到名字就知道它是什麼、怎麼用。此外,每個模組都應該有自己的前綴,這在對外接口上尤其關鍵,既能標示功能範疇,也能避免不同檔案或類別撞名。例如相簿模組(PhotoGallery)的程式碼都以 PG 開頭:PGAlbumViewController、PGDataManager。
1)常量的命名
常量建議在前面加上小寫 k 作為標記:
static const NSTimeInterval kAnimationDuration = 0.3;
如果這個字串要作為 NSDictionary 的 key 或 Notification 名稱,記得加上 const 防止被改動:
NSString *const UIApplicationDidEnterBackgroundNotification;
補充兩點:
一、若常量的作用域超出編譯單元(也就是要在類別外部可見),請加上 extern,並用類別名作為前綴,例如 extern NSString *const PGThumbnailSize。
二、全域常量(通知名、key 等)盡量用 const 而非巨集。原因有兩個:巨集可能被重新定義,而且不同檔案引入時可能拿到不同的值。(順帶一提,如果還是用 #define,也請加上 k 前綴,這算是我一點小小的強迫症。)
2)列舉的命名
列舉經常能看到這種老式的 C 寫法:
typedef enum : {
CameraModeFront,
CameraModeLeft,
CameraModeRight,
} CameraMode;
每次看到總覺得哪裡怪怪的。既然寫 Objective-C,就該用 Objective-C 的方式。看看 SDK 裡 Apple 怎麼做:
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,
};
重點有兩個:列舉型別名稱要帶相關類別前綴,列舉值名稱要帶列舉型別前綴。
3)變數與物件的命名
替物件命名時,建議用「修飾詞 + 型別」的組合。只用修飾詞會有歧義,例如 title——它到底是 NSString 還是 UILabel?只用型別則少了語意,例如 label——我知道你是 UILabel,但不知道你用來幹嘛。正確的寫法應該像這樣:
titleLabel // 標題用的 label,型別是 UILabel confirmButton // 確認用的 button,型別是 UIButton
BOOL 型別建議加上 is 前綴,例如 - (BOOL)isEqualToString:(NSString *)aString,語意更清楚。如果某方法回傳非屬性的 BOOL,就依語意選 has 或 is 當前綴,例如 - (BOOL)hasPrefix:(NSString *)aString。
小技巧:如果命名本身已經很明確,為了簡潔可以省掉型別名。例如 scores 一看就知道是陣列,不必寫成 scoreArray。
編碼規範
編碼規範的目的,是讓程式碼具備三個特質:可複用、易維護、可擴展。這其實就是物件導向的基本功。
可複用,意思是別寫重複的程式碼,重複的部分要抽成可重用的元件,否則改需求時得滿專案找相同邏輯。易維護,意思是別把邏輯寫成一團,要把複雜流程拆成職責單一的小模組,也就是 Do One Thing——這樣的程式碼好讀也不容易出錯。可擴展則要求寫的時候就想到後續擴充,這屬於架構層面的課題,靠合適的設計模式來支撐,之後有機會再單獨寫一篇。
規範用文字講很抽象,對工程師來說一個範例勝過千言,所以下面直接看程式碼。
1)判斷 nil 或 YES/NO
// Preferred
if (someObject) { ... }
if (!someObject) { ... }
// Not preferred
if (someObject == YES) { ... }
if (someObject != nil) { ... }
寫成 someObject == YES 很容易手滑變成賦值,等於自己給自己挖坑;而 if (someObject) 簡潔得多,何樂不為。
2)條件賦值
// Preferred result = object ?: [self createObject]; // Not preferred result = object ? object : [self createObject];
如果「存在就用自己的值」,那就可以這樣簡寫。
3)初始化集合物件
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018;
好處有兩個:一是簡潔,二是能避免把 nil 塞進容器而引發 crash。
4)定義屬性
// 對外只讀,內部自己改 @property (nonatomic, strong, readonly) NSArray *items; // 有 Mutable 子類型的,一律用 copy @property (nonatomic, copy) NSString *title;
定義屬性時把修飾詞寫齊,尤其想對外唯讀時一定要加 readonly,這是安全性的習慣。內部才用的屬性就宣告成私有,放到 .m 的 class extension 裡。
對於擁有 Mutable 子類型的類別(NSString、NSArray、NSDictionary 等)務必用 copy。原因很直接:如果用 strong,把 NSMutableArray 指派給 array 屬性之後,原始陣列一變,你的屬性也跟著變了。
另外盡量不要在 public interface 暴露 mutable 型別。建議在 .h 宣告唯讀屬性,在 .m 的 getter 裡回傳內部維護的 mutable 變數——同樣是為了安全。
5)BOOL 賦值
讓表達式直接回傳比較結果,而不是用三元運算子包一層:
BOOL isAdult = user.age >= 18;
6)拒絕魔術數字
// Preferred
typedef NS_ENUM(NSUInteger, PGCellHeight) {
PGCellHeightCompact = 44,
PGCellHeightRegular = 88,
};
// Not preferred
if (rowHeight == 88) { ... }
魔術數字一改就容易漏改,散落各處時更是惡夢。定義成列舉或 static 常量,還能把錯誤提前到編譯階段。更別說光看到一個 88,誰知道它代表什麼。
7)複雜的條件判斷
// Preferred
- (BOOL)isVaildName:(NSString *)name {
if (name.length == 0) return NO;
if ([name hasPrefix:@" "]) return NO;
return YES;
}
// Not preferred
- (BOOL)isVaildName:(NSString *)name {
return (name.length > 0 && ![name hasPrefix:@" "]) ? YES : NO;
}
把條件拆開,每一行只做一件事,可讀性立刻不同。
8)避免深層嵌套
// Preferred
- (void)setup {
if (!self.isReady) return;
if (!self.dataSource) return;
[self doSomething];
}
// Not preferred
- (void)setup {
if (self.isReady) {
if (self.dataSource) {
[self doSomething];
}
}
}
一旦發現某個前提不成立就立刻 return,條理清楚,也不用一路往右寫。
9)參數過多
// Preferred
- (void)applyFilter:(PGFilters *)filters;
// Not preferred
- (void)applyFilterWithKey1:(NSNumber *)k1 key2:(NSNumber *)k2 key3:(NSNumber *)k3
key4:(NSNumber *)k4 key5:(NSNumber *)k5;
當你發現某個功能要傳一堆參數,那就是訊號:該收攏成一個 model 類別了。程式碼更整潔,也不容易因為漏傳或傳錯而出問題。
10)回呼方法帶上呼叫者
- (void)requestDidFinish:(PGRequest *)request caller:(id)caller;
回呼時被呼叫方最好知道自己是誰呼叫的,資訊傳遞會順很多,所以建議把呼叫者放在第一個參數。
Block 的循環引用
Block 很好用,但一定要留意循環引用,否則哪天你會發現 dealloc 怎麼都不被呼叫。
常見寫法是先取一個 weak 版本的 self:
__weak typeof(self) weakSelf = self;
self.completionBlock = ^{
[weakSelf handleResult];
};
這樣確實避開了循環引用,但故事還沒結束——block 裡的 self 是弱引用,執行時它可能已經被釋放,於是變成 nil,後續邏輯就跟著出錯。比較嚴謹的寫法是在 block 內做一次「weak 轉 strong」:
__weak typeof(self) weakSelf = self;
self.completionBlock = ^{
__strong typeof(weakSelf) strongSelf = weakSelf;
if (!strongSelf) return;
[strongSelf handleResult];
};
那什麼情況下真的會循環引用?簡單說就是雙向持有:block 是 self 的屬性(self 已經 retain 了 block),而 block 內部又參照了 self,這時必然形成迴圈。
補充一個好用的工具:RAC 提供了 @weakify(self) 與 @strongify(self),省下不少樣板程式碼,值得一試。
那些年遇到的 Crash
多執行緒同步問題
這在執行緒到處亂用的專案裡特別常見。你可以用多執行緒,但得想辦法保護它。資料來源與 model 類別尤其要注意同時存取的情況,個人偏好用 GCD 的序列佇列來同步。
Observer 沒有移除
現在很多邏輯都靠 Observer 監聽狀態再更新 UI。註冊很簡單,問題出在移除:要麼忘了移除,要麼移除時機不對。如果被觀察的物件已經釋放而 observer 還在,結果就是 crash。所以至少在 dealloc 裡補一次移除。
NSArray、NSDictionary 成員判空
在 addObject: 或 insertObject: 之前最好先判空,網路相關邏輯尤其如此。如果接口回傳的 JSON 解析結果是空的,而你仍然硬塞進陣列,那後果自己想像。
最後一點:commit 之前請確保沒有 warning、沒有記憶體洩漏。做法很簡單——上傳前按 Command + Shift + B 跑一次靜態分析,看看有沒有 issue。就先寫到這邊,之後踩到更多坑再回來補充,to be continued。
參考資料