Objective-C之優雅的命名,objective-c命名
There are only two hard things in Computer Science: cache invalidation and naming things.
在電腦科學中只有兩件難事:緩衝失效和命名。
— Phil Karlton
電腦語言是人和電腦之間通訊的媒介。好的代碼應該是就像人對電腦說話那樣,自然而優雅。命名看上去是一件很簡單的事,而往往越是簡單的事越難做好,否則大師們也不會把命名看成是電腦界的難題了。如何把Objective-C這門電腦語言以優雅的方式“說”出,還是比較考驗工程師對它的理解深度的。在蘋果的SDK中有大量的API,我們可以從這些API中體會到一些命名的藝術。
減少縮寫
命名縮寫只用於通用專業術語,如URL
,不可自創命名縮寫,如Ctr
、Msg
。命名寧可長一些,也不要難於理解。
是否在看別人代碼時各種縮寫而不知其所以然?簡短的名字確實比較好,但不可濫用縮寫導致失去可讀性。
過程化
動作發生之前用Will
,發生之後用Did
,詢問是否發生用Should
。
每個處理都是有一定過程的,這個處理往往會產生一些通知和回調,好的命名必須要明確當前過程中的步驟。命名這些通知和回調時最好提供發生前後兩個版本,如果發生前要回調確認,請用Should
命名該回調,並返回一個BOOL
值。
名字空間
各種全域作用範圍的函數,常量,類,枚舉,結構等命名必須加命名首碼。
Objective-C中沒有C++那樣的名字空間概念,也沒有Java包名的概念,隨著工程代碼的增加,難免會出現名字衝突,因此全域作用範圍的名字必須唯一。比較經典的做法就是加命名首碼。大多數人認為命名首碼只是在類的前面加幾個大寫字母,其實不僅僅如此。
類型(類、枚舉、結構)命名前要加相關模組首碼。
UIViewNSStringCGRect
常量命名要加相互關聯類型名首碼。
UIApplicationDidFinishLaunchingNotificationCGRectZero
函數命名要加相互關聯類型名首碼。
CGRectMakeCGPointMake
枚舉類型命名要加相關類名首碼,並且枚舉值命名要加枚舉類型首碼。
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) { UIViewAnimationTransitionNone, UIViewAnimationTransitionFlipFromLeft, UIViewAnimationTransitionFlipFromRight, UIViewAnimationTransitionCurlUp, UIViewAnimationTransitionCurlDown,};
做到以上幾點幾乎可以做到名字不會衝突。
參數提示
方法命名時,每個參數前要加參數的名稱提示。
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil- (void)performSegueWithIdentifier:(NSString *)identifier sender:(id)sender
對象命名
給一個帶修飾的對象命名時要採用修飾+類型的方式,而不是先指定其類型。
很多人喜歡把對象的類型放在對象的命名前面,從而來標識一個對象是什麼類型,這很不符合Objective-C語言的特點,容易引起歧義,比如一個UILabel對象:
titleLabel //表示標題的label,是UIlabel對象labelTitle //label的標題?似乎是一個NSString?confirmButton //確認按鈕buttonConfirm //不自然的命名,看上去像是按鈕點擊動作。
方法命名符合文法
大部分方法可以分成下面兩類,而這兩類往往被亂用。它們是:
“要什麼”表示取得某個對象,要以名詞作為方法的開頭;“做什麼”表示執行某種操作,要以動詞作為方法開頭。看看下面這個命名方式:
- (XXItem *)itemNamed:(NSString *)name //Good. 意思清晰- (XXItem *)findItemWithName:(NSString *)name //更像是一種操作,而不是返回一個對象。
findItemWithName
這個命名表示一種操作,而無需返回對象,比如它可以用於設定類的內部成員,比如:
- (void)findItemWithName:(NSString *)name{ ... self.foundItem = xxx; ...}
get
“要什麼”往往被胡亂命名為get
開頭的方法。首先get是一個動詞,所以它還是“做什麼”或者說“做的是要什麼”。那麼get方法不要用於返回對象,但它可用於參數中返回。
- (XXItem *)getItemAtIndex:(NSUInteger)index //Bad!! 不規範的命名- (XXItem *)itemAtIndex:(NSUInteger)index //Good, 命名清晰- (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index //比較符合規範,但第二種更好。
可知性
回調時被調用者要知道其調用者
可以在回調方法中第一個參數中加上調用者:
- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions- (void)buttonTapped:(UIButton*)sender
常量還是宏
全域常量不可使用宏定義
我們經常看到一些用宏定義的通知,關鍵字等。其實這麼做是非常危險的,因為宏很可能被重定義,而且引用不同的檔案可能會導致宏的不同,所以盡量使用const
來定義常量。
一些思考
命名的好壞在開發中往往也不怎麼重視,畢竟差的命名也不會影響程式邏輯。
但是不好的命名在大項目中帶來的隱形維護成本是相當高的,這些在項目開始時 可能還很難察覺,而後來會陷入前僕後繼的維護困境中。
我們往往非常重視項目邏輯的複雜性,卻不能好好的把“簡單”的命名做好。
其實,如果簡單的東西都做不好,那麼做出再複雜的東西那也是垃圾。