Objective-C 之优雅的命名-看似简单,实际却很考验开发者的功力

简介: There are only two hard things in Computer Science: cache invalidation and naming things. 在计算机科学中只有两件难事:缓存失效和命名。

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 
  •枚举类型命名要加相关类名前缀,并且枚举值命名要加枚举类型前缀。
 
  1. typedef NS_ENUM(NSInteger, UIViewAnimationTransition) { 
  2.     UIViewAnimationTransitionNone, 
  3.     UIViewAnimationTransitionFlipFromLeft, 
  4.     UIViewAnimationTransitionFlipFromRight, 
  5.     UIViewAnimationTransitionCurlUp, 
  6.     UIViewAnimationTransitionCurlDown, 
  7. }; 
做到以上几点几乎可以做到名字不会冲突。
 
参数提示
方法命名时,每个参数前要加参数的名称提示。
 
  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.     ... 
 
get
“要什么”往往被胡乱命名为get开头的方法。首先get是一个动词,所以它还是“做什么”或者说“做的是要什么”。那么get方法不要用于返回对象,但它可用于参数中返回。
 
  1. - (XXItem *)getItemAtIndex:(NSUInteger)index                  //Bad!! 不规范的命名 
  2. - (XXItem *)itemAtIndex:(NSUInteger)index                     //Good, 命名清晰 
  3. - (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index  //比较符合规范,但第二种更好。 
 
可知性
 
回调时被调用者要知道其调用者
 
可以在回调方法中第一个参数中加上调用者:
 
  1. - (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
  2. - (void)buttonTapped:(UIButton*)sender 
 
常量还是宏
 
全局常量不可使用宏定义
我们经常看到一些用宏定义的通知,关键字等。其实这么做是非常危险的,因为宏很可能被重定义,而且引用不同的文件可能会导致宏的不同,所以尽量使用const来定义常量。
 
一些思考

命名的好坏在开发中往往也不怎么重视,毕竟差的命名也不会影响程序逻辑。但是不好的命名在大项目中带来的隐形维护成本是相当高的,这些在项目开始时可能还很难察觉,而后来会陷入前仆后继的维护困境中。我们往往非常重视项目逻辑的复杂性,却不能好好的把“简单”的命名做好。其实,如果简单的东西都做不好,那么做出再复杂的东西那也是垃圾。


本文转载自cocoachina:http://www.cocoachina.com/applenews/devnews/2014/0816/9395.html

目录
相关文章
|
前端开发 JavaScript Go
2022 软件工程师状况报告:Go 最抢手|开发者最“嫌弃” PHP、Swift、Scala/R/Objective-C
2022 软件工程师状况报告:Go 最抢手|开发者最“嫌弃” PHP、Swift、Scala/R/Objective-C
187 0
2022 软件工程师状况报告:Go 最抢手|开发者最“嫌弃” PHP、Swift、Scala/R/Objective-C
|
程序员 开发工具 iOS开发
Objective C项目的命名有多长
Objective-C程序员一定非常喜欢它详细的描述性命名风格。
262 0
Objective C项目的命名有多长
|
存储 Java 程序员
C++ 开发者快速学习 Objective-C 语言核心语法
本文将讨论 Objective-C 语言的核心语法。这部分开始详述一些具体的语法。正如你期待的一样,涉及到了定义和类。
258 0
|
C++ iOS开发 开发者
C++开发者快速学习Objective-C语言核心语法
  本文将Objective-C讨论了语言的核心语法。这部分开始详述一些具体的语法。正如你期待的一样,涉及到了定义和类。   类并不是特殊的   在Smalltalk中,类是具有一些特性的对象。在Objective-C中也一样。
981 0
|
C++ iOS开发 开发者
C++开发者快速学习Objective-C语言核“.NET研究”心语法
  本文将Objective-C讨论了语言的核心语法。这部分开始详述一些具体的语法。正如你期待的一样,涉及到了定义和类。   类并不是特殊的   在Smalltalk中,类是具有一些特性的对象。在Objective-C中也一样。
960 0
|
自然语言处理 Go iOS开发
iOS开发者知识普及,Swift 挑战 Objective-C,谁会笑到最后?
如果你的公司也正计划跟随 iOS 软件开发,那么你需要作出一个至关重要的决定。你需要为你的产品选择合适的技术组合。你的目标是什么?如果是原生应用开发而不是跨平台软件,你会选用哪种编程语言?久经考验的 Objective-C 还是 Swift?
|
7月前
|
安全 编译器 Swift
IOS开发基础知识: 对比 Swift 和 Objective-C 的优缺点。
IOS开发基础知识: 对比 Swift 和 Objective-C 的优缺点。
420 2
|
5月前
|
开发工具 iOS开发 容器
【Azure Blob】关闭Blob 匿名访问,iOS Objective-C SDK连接Storage Account报错
iOS Objective-C 应用连接Azure Storage时,若不关闭账号的匿名访问,程序能正常运行。但关闭匿名访问后,上传到容器时会出现错误:“Public access is not permitted”。解决方法是将创建容器时的公共访问类型从`AZSContainerPublicAccessTypeContainer`改为`AZSContainerPublicAccessTypeOff`,以确保通过授权请求访问。
【Azure Blob】关闭Blob 匿名访问,iOS Objective-C SDK连接Storage Account报错