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包名的概念，随着工程代码的增长，不免会出现名字冲突，所以全局做用范围的名字必须惟一。比较经典的作法就是加命名前缀。大多数人认为命名前缀只是在类的前面加几个大写字母，其实不只仅如此。

 

•类型(类、枚举、结构)命名前要加相关模块前缀。

1 UIView
2 NSString 
3 CGRect 

 

 •常量命名要加相关类型名前缀。

1 UIApplicationDidFinishLaunchingNotification 
2 CGRectZero 

 •函数命名要加相关类型名前缀。

1 CGRectMake 
2 CGPointMake 

 •枚举类型命名要加相关类名前缀，而且枚举值命名要加枚举类型前缀。

typedef NS_ENUM(NSInteger, UIViewAnimationTransition)
{ 
    UIViewAnimationTransitionNone, 
    UIViewAnimationTransitionFlipFromLeft, 
    UIViewAnimationTransitionFlipFromRight, 
    UIViewAnimationTransitionCurlUp, 
    UIViewAnimationTransitionCurlDown, 
}; 

作到以上几点几乎能够作到名字不会冲突。

 

参数提示

方法命名时，每一个参数前要加参数的名称提示。

1 - (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil 
2 - (void)performSegueWithIdentifier:(NSString *)identifier sender:(id)sender 

对象命名

给一个带修饰的对象命名时要采用修饰+类型的方式，而不是先指定其类型。

 

不少人喜欢把对象的类型放在对象的命名前面，从而来标识一个对象是什么类型，这很不符合Objective-C语言的特色，容易引发歧义，好比一个 UILabel 对象：

1 titleLabel      //表示标题的label，是UIlabel对象 
2 labelTitle      //label的标题？彷佛是一个NSString？ 
3  
4 confirmButton   //确认按钮 
5 buttonConfirm   //不天然的命名，看上去像是按钮点击动做。 

 

方法命名符合语法

 

大部分方法能够分红下面两类，而这两类每每被乱用。它们是：

•要什么

•作什么

 

“要什么”表示取得某个对象，要以名词做为方法的开头；“作什么”表示执行某种操做，要以动词做为方法开头。看看下面这个命名方式：

1 - (XXItem *)itemNamed:(NSString *)name           //Good. 意思清晰 
2 - (XXItem *)findItemWithName:(NSString *)name    //更像是一种操做，而不是返回一个对象。 

 

findItemWithName 这个命名表示一种操做，而无需返回对象，好比它能够用于设置类的内部成员，好比：

1 - (void)findItemWithName:(NSString *)name{ 
2     ... 
3     self.foundItem = xxx; 
4     ... 
5 } 

 

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来定义常量。

 

一些思考

命名的好坏在开发中每每也不怎么重视，毕竟差的命名也不会影响程序逻辑。可是很差的命名在大项目中带来的隐形维护成本是至关高的，这些在项目开始时可能还很难察觉，然后来会陷入前仆后继的维护困境中。咱们每每很是重视项目逻辑的复杂性，却不能好好的把“简单”的命名作好。其实，若是简单的东西都作很差，那么作出再复杂的东西那也是垃圾。