蘋果的 API 之所以讀起來順,很大程度歸功於一套嚴格的命名約定。摸清這套規律,不僅能看懂系統框架,也能讓自己寫的接口更符合 iOS 開發者的習慣。
以 NSString 和 NSMutableString 為例,可以歸納出幾條清晰的規則。
規則 1:如果是「創建新對象」的方法,方法名的第一個部分應該是返回類型。
+ (instancetype)string;
+ (instancetype)stringWithString:(NSString *)string;
+ (instancetype)stringWithCharacters:(const unichar *)characters length:(NSUInteger)length;
規則 2:返回類型之前還可以加修飾詞,用來限定語義。
- (NSString *)substringFromIndex:(NSUInteger)from;
這裡的 sub 就是修飾詞,說明返回的是原串的「一部分」,而不是一個全新的字符串。
規則 3:屬性的存取方法應該以屬性名命名。
- (NSUInteger)length;
讀者看到 length 就能立刻反應出這是個屬性,而不是某個動作。
規則 4:通過輸出參數返回結果的方法,需要加 get 前綴。
- (void)getCharacters:(unichar *)buffer range:(NSRange)range;
get 在這裡的作用是提示調用者:真正的結果不在返回值裡,而在你傳入的緩衝區中。返回值只是 void,這個前綴是必要的語義補償。
規則 5:返回布爾值的方法應該加 is 前綴。
- (BOOL)isEqualToString:(NSString *)aString;
這條規則讓判斷語句讀起來像自然語言:if ([str isEqualToString:other])。
規則 6:如果方法要在當前對象上執行操作,方法名應該包含動詞;有參數時,動詞後面接上一個或多個參數說明。
// NSMutableString
- (void)appendString:(NSString *)aString;
append 是動詞,String 說明操作對象的類型。整句讀下來就是「追加一個字符串」,動作與受體都很明確。
規則 1:類和協議都應該帶前綴。
NSArray、UIView
前綴的作用是避免命名衝突——Objective-C 沒有命名空間,前綴承擔了這個職責。同一個框架內的類應保持一致的前綴。
規則 2:如果是繼承關係,子類名的末尾應該與父類保持一致。
NSArray : NSMutableArray
UIView : UIImageView、UITableView ...
看到 ...Array 就知道它是數組家族的一員,看到 ...View 就知道它是視圖家族的一員。這種「家族姓氏」的設計讓龐大的框架依然可讀。
規則 3:委託協議應該包含委託方的名稱。
UITableView : UITableViewDelegate
協議名 = 委託方名 + Delegate。這樣一了眼就能知道這個協議是服務於哪個類的,在文件中看到 UITableViewDelegate 也不必猜測它適用於哪個視圖。
把這幾條規則貫徹到自己的代碼裡,收穫的不只是「看起來專業」——命名清晰的接口能顯著降低同事的理解成本,也能讓六個月後的自己少罵幾句。