多用类型常量,少用#define预处理指令

注:本文整理自《Effective Objective-C 2.0编写高质量iOS 与 OS X代码的52个有效方法》 

编写代码时经常要定义常量。例如,要写一个UI视图类,此视图显示出来之后就播放动画,然后消失。你可能想把播放动画的时间提取为常量。掌握了Objective-C与其C语言基础的人,也许会用这种方法来做:
 

  1. #define ANIMATION_DURATION 0.3 

上述预处理指令会把源代码中的ANIMATION_DURATION字符串替换为0.3。这可能就是你想要的效果,不过这样定义出来的常量没有类型信息。“持续”(duration)这个词看上去应该与时间有关,但是代码中又未明确指出。此外,预处理过程会把碰到的所有ANIMATION_DURATION一律替换成0.3,这样的话,假设此指令声明在某个头文件中,那么所有引入了这个头文件的代码,其ANIMATION_DURATION都会被替换。

要想解决此问题,应该设法利用编译器的某些特性才对。有个办法比用预处理指令来定义常量更好。比方说,下面这行代码就定义了一个类型为NSTimeInterval的常量:
 

  1. static const NSTimeInterval kAnimationDuration = 0.3; 

请注意,用此方式定义的常量包含类型信息,其好处是清楚地描述了常量的含义。由此可知该常量类型为NSTimeInterval,这有助于为其编写开发文档。如果要定义许多常量,那么这种方式能令稍后阅读代码的人更易理解其意图。

还要注意常量名称。常用的命名法是:若常量局限于某“编译单元”(translation unit,也就是“实现文件”,implementation file)之内,则在前面加字母k;若常量在类之外可见,则通常以类名为前缀。第19条详解了命名习惯(naming convention)。

定义常量的位置很重要。我们总喜欢在头文件里声明预处理指令,这样做真的很糟糕,当常量名称有可能互相冲突时更是如此。例如,ANIMATION_DURATION这个常量名就不该用在头文件中,因为所有引入了这份头文件的其他文件中都会出现这个名字。其实就连用static const定义的那个常量也不应出现在头文件里。因为Objective-C没有“名称空间”(namespace)这一概念,所以那样做等于声明了一个名叫kAnimationDuration的全局变量。此名称应该加上前缀,以表明其所属的类,例如可改为EOCViewClassAnimationDuration。本书第19条中深入讲解了一套清晰的命名方案。

若不打算公开某个常量,则应将其定义在使用该常量的实现文件里。比方说,要开发一个使用UIKit框架的iOS应用程序,其UIView子类中含有表示动画播放时间的常量,那么可以这样写:
 

  1. // EOCAnimatedView.h  
  2. #import <UIKit/UIKit.h> 
  3.  
  4. @interface EOCAnimatedView : UIView  
  5. - (void)animate;  
  6. @end  
  7.  
  8. // EOCAnimatedView.m  
  9. #import "EOCAnimatedView.h"  
  10.  
  11. static const NSTimeInterval kAnimationDuration = 0.3;  
  12.  
  13. @implementation EOCAnimatedView  
  14. - (void)animate {  
  15.     [UIViewanimateWithDuration:kAnimationDuration  
  16.                     animations:^(){  
  17.                          // Perform animations  
  18.                     }];  
  19. }  
  20. @end 

变量一定要同时用static与const来声明。如果试图修改由const修饰符所声明的变量,那么编译器就会报错。在本例中,我们正是希望这样:因为动画播放时长为定值,所以不应修改。而static修饰符则意味着该变量仅在定义此变量的编译单元中可见。编译器每收到一个编译单元,就会输出一份“目标文件”(object file)。在Objective-C的语境下,“编译单元”一词通常指每个类的实现文件(以.m为后缀名)。因此,在上述范例代码中声明的kAnimationDuration变量,其作用域仅限于由EOCAnimatedView.m所生成的目标文件中。假如声明此变量时不加static,则编译器会为它创建一个“外部符号”(external symbol)。此时若是另一个编译单元中也声明了同名变量,那么编译器就抛出一条错误消息:
 

  1. duplicate symbol _kAnimationDuration in:  
  2.     EOCAnimatedView.o  
  3.     EOCOtherView.o 

实际上,如果一个变量既声明为static,又声明为const,那么编译器根本不会创建符号,而是会像#define预处理指令一样,把所有遇到的变量都替换为常值。不过还是要记住:用这种方式定义的常量带有类型信息。

有时候需要对外公开某个常量。比方说,你可能要在类代码中调用NSNotificationCenter以通知他人。用一个对象来派发通知,令其他欲接收通知的对象向该对象注册,这样就能实现此功能了。派发通知时,需要使用字符串来表示此项通知的名称,而这个名字就可以声明为一个外界可见的常值变量(constant variable)。这样的话,注册者无须知道实际字符串值,只需以常值变量来注册自己想要接收的通知即可。

此类常量需放在“全局符号表”(global symbol table)中,以便可以在定义该常量的编译单元之外使用。因此,其定义方式与上例演示的static const有所不同。应该这样来定义:
 

  1. // In the header file  
  2. extern NSString *const EOCStringConstant;  
  3.  
  4. // In the implementation file  
  5. NSString *const EOCStringConstant = @"VALUE"; 

这个常量在头文件中“声明”,且在实现文件中“定义”。注意const修饰符在常量类型中的位置。常量定义应从右至左解读,所以在本例中,EOCStringConstant就是“一个常量,而这个常量是指针,指向NSString对象”。这与需求相符:我们不希望有人改变此指针常量,使其指向另一个NSString对象。

编译器看到头文件中的extern关键字,就能明白如何在引入此头文件的代码中处理该常量了。这个关键字是要告诉编译器,在全局符号表中将会有一个名叫EOCStringConstant的符号。也就是说,编译器无须查看其定义,即允许代码使用此常量。因为它知道,当链接成二进制文件之后,肯定能找到这个常量。

此类常量必须要定义,而且只能定义一次。通常将其定义在与声明该常量的头文件相关的实现文件里。由实现文件生成目标文件时,编译器会在“数据段”(data section)为字符串分配存储空间。链接器会把此目标文件与其他目标文件相链接,以生成最终的二进制文件。凡是用到EOCStringConstant这个全局符号的地方,链接器都能将其解析。

因为符号要放在全局符号表里,所以命名常量时需谨慎。例如,某应用程序中有个处理登录操作的类,在登录完成后会发出通知。派发通知所用的代码如下:
 

  1. // EOCLoginManager.h  
  2. #import <Foundation/Foundation.h> 
  3.  
  4. extern NSString *const EOCLoginManagerDidLoginNotification;  
  5.  
  6. @interface EOCLoginManager : NSObject  
  7. - (void)login;  
  8. @end  
  9.  
  10. // EOCLoginManager.m  
  11. #import "EOCLoginManager.h"  
  12.  
  13. NSString *const EOCLoginManagerDidLoginNotification =  
  14.     @"EOCLoginManagerDidLoginNotification";  
  15.  
  16. @implementation EOCLoginManager  
  17.  
  18. - (void)login {  
  19.     // Perform login asynchronously, then call 'p_didLogin'.  
  20. }  
  21.  
  22. - (void)p_didLogin {  
  23.     [[NSNotificationCenter defaultCenter]  
  24.       postNotificationName:EOCLoginManagerDidLoginNotification  
  25.                    object:nil];  
  26. }  
  27. @end 

注意常量的名字。为避免名称冲突,最好是用与之相关的类名做前缀。系统框架中一般都这样做。例如UIKit就按照这种方式来声明用作通知名称的全局常量。其中有类似UIApplicationDidEnterBackgroundNotification与UIApplicationWillEnterForegroundNotification这样的常量名。

其他类型的常量也是如此。假如要把前例中EOCAnimatedView类里的动画播放时长对外公布,那么可以这样声明:
 

  1. // EOCAnimatedView.h  
  2. extern const NSTimeInterval EOCAnimatedViewAnimationDuration;  
  3.  
  4. // EOCAnimatedView.m  
  5. const NSTimeInterval EOCAnimatedViewAnimationDuration = 0.3; 

这样定义常量要优于使用#define预处理指令,因为编译器会确保常量值不变。一旦在EOCAnimatedView.m中定义好,即可随处使用。而采用预处理指令所定义的常量可能会无意中遭人修改,从而导致应用程序各个部分所使用的值互不相同。

总之,勿使用预处理指令定义常量,而应该借助编译器来确保常量正确,比方说可以在实现文件中用static const来声明常量,也可以声明一些全局常量。

要点

不要用预处理指令定义常量。这样定义出来的常量不含类型信息,编译器只是会在编译前据此执行查找与替换操作。即使有人重新定义了常量值,编译器也不会产生警告信息,这将导致应用程序中的常量值不一致。

在实现文件中使用static const来定义“只在编译单元内可见的常量”(translation-unit-specific constant)。由于此类常量不在全局符号表中,所以无须为其名称加前缀。

在头文件中使用extern来声明全局常量,并在相关实现文件中定义其值。这种常量要出现在全局符号表中,所以其名称应加以区隔,通常用与之相关的类名做前缀。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章