编写代码时经常要定义常量。例如,要写一个UI视图类,此视图显示之后要播放动画,然后消失。你可能想把播放动画的时间提取为常量,掌握Objective-C与其C语言基础的人,也许会选择这种做法来做:
#define ANIMATION_DRUATION 0.3
上述预处理指令会把源代码中的ANIMATION_DRUATION字符串替换为0.3,这可能就是你想要的效果,不过这样定义出来的常量没有类型信息,“持续”(druation)这个词看上去与时间有关,但是代码中又未明确指明。预处理这个过程会把碰到的所有ANIMATION_DRUATION一律替换成0.3,这样的话,假设此指令声明在某个头文件中,那么引入了这个头文件的代码,其ANMIATION_DRUATION都会被替换。
要想解决此问题,需要想办法利用编译器的某些特性才行。有个办法比预处理指令来定义常量更好。比方说,下面这行代码就定义了一个类型为NSTimeInterval的常量:
static const NSTimeInterval kAnimationDuration = 0.3
请注意,此方式定义的常量包含类型信息,其好处是清楚描述了常量的含义。由此可知该类型常量为NSTimeInterval,这有助于其编写开发文档。如果定义许多常量,那么这种方式能令稍后阅读代码的人更容易理解去意图。
还要注意常量名称,常量的命名方法是:若常量局限于某“编译单元”(translation unit,也就是实现文件 implementation file)之内,则在之前加上字母k,若常量在类之外可见,则通常以类名为前缀。
定义常量的位置很重要。我们总喜欢在头文件里面声明预处理指令,这样做真的很糟糕,当常量名称有可能互相冲突时更是如此。例如ANMIATION_DURATION这个常量就不应该用在头文件中,因为所有引入这份头文件的其他文件中都会出现这个名字。其实就连 static const 定义的那个常量都不应该出现在头文件中。因为Objective-C没有“命名空间”(namespace)这一概念,所以那样做等于声明了一个kAnimationDuration的全局变量,此名称应该加上前缀,以表明所属的类,例如可改为EOCViewClassAnimationDuration。
弱不打算工改某个常量,则应将其定义在使用该常量的实现文件里。比方说,要开发一个使用UIKit框架的iOS应用程序,其UIView的子类含有表示动画播放时间的常量,那么可以这样写:
// EOCAnimatedView.h
#import <UIKit/UIKit.h>
@interface EOCAnimatedView : UIView
- (void)animate;
@end
//EOCAnimatedView.m
#import "EOCAnimatedView.h"
static const NSTimeInterval kAnimationDuration = 0.3;
@implementation EOCAnimatedView
- (void)animate{
[UIView animateWithDuration:kAnimationDuration animations:^{
//perform animations;
}];
}
@end
变量一定要同时用static const来声明。如果试图修改有static修饰符所声明的变量,编译器会报错。在本例中,我们正是希望这样:因为动画播放时长为定值,所以不应修改。而static修饰符意味着次变量仅在定义此变量的编译单元中可见。编译器每收到一个编译单元,就是输出一份“目标文件”(object file)。在Objective-C语境下,“编译单元”(translation unit)一词通常指每个类的实现文件(以.m为后缀名)。因此,在上述示例代码中声明的kAnimationDuration变量,其作用域仅局限于EOCAnimatedView.m所生成的目标文件中。假如声明此变量是不加static,则编译器会为他创建一个“外部符号”(external symbol),此时,若另一个编译单元也声明了同名变量,那么编译器就会抛出这样一个错误:
duplicate symbol _kAnimationDuration in:
/Users/suchao/Library/Developer/Xcode/DerivedData/textAAA-gmmodsxqupjwwparrkowvdkbobfc/Build/Intermediates.noindex/textAAA.build/Debug-iphonesimulator/textAAA.build/Objects-normal/x86_64/SecondViewController.o
/Users/suchao/Library/Developer/Xcode/DerivedData/textAAA-gmmodsxqupjwwparrkowvdkbobfc/Build/Intermediates.noindex/textAAA.build/Debug-iphonesimulator/textAAA.build/Objects-normal/x86_64/FirstViewController.o
ld: 1 duplicate symbol for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation)
实际上,如果一个变量既声明为static,有声明为const,那么编译器根本不会创建符号,而是想#define预处理指令一样,把所有遇到的变量都替换为常值。不过还是要记住,用这种方式定义的常量含有类型信息。
有时需要对外公开某个常量。比方说,你可能要在类代码中调用NSNotificationCenter通知其他人。用一个对象来派发通知,令其他与接收的对象向该对象注册,这样就能实现此功能了。派发通知时,需要使用字符串来表示此项通知的名称,而这个名字就可以声明为一个外部可见的一个“常值变量”(constant variable)。这样的话,注册这无需知道实际字符串值,只需以常值变量来注册自己想要接收的通知即可。
此类变量需要放在“全局符号表中”(global symbol table),以便可以在定义该常量的编译单元之外使用。因此,其定义方式与上例演示的static const有所不同。应该这样来定义:
// In the header file
extern NSString *const EOCStringConstant;
// In the Implementation file
NSString *const EOCStringConstant = @"VALUE";
这个常量在头文件中“声明”,且在实现文件中“定义”。注意const修饰符在常量类型中的位置。常量定义应从右至左解读,所以在本例中,EOCStringConstant就是“一个常量,而且这个常量是指针,指向NSString对象”。这与需求相符,我们不希望有人改变此指针常量,使其指向另一个NSString对象。
编译器看到头文件中extern关键字,就能明白如何在引入此头文件的代码中处理该常量了。这个关键字就是要告诉编译器,在全局符号表中将会有一个名叫EOCStringConstant符号。也就是说,编译器无需查看其定义,即允许代码使用此常量。因此他知道,在链接成二进制文件之后,肯定能找到该常量。
此常量必须要定义,而且只能定义一次。通常将其定义在与声明该常量头文件相关的实现文件里,由实现文件生成目标文件时,编译器会在“数据段”(data section)为字符串分配内存空间。链接器会把此目标文件与其他目标文件相连接,生成最终的二进制文件。凡是用到EOCStringConstant这个全局符号的地方,链接器都能将其解析。
因为符号要放到全局符号表里,所以命名常量时需要谨慎。例如,某个应用程序中有个处理登录操作的类,在登录完成之后会发出通知。派发通知的代码如下:
// EOCLoginManager.h
#import "Foundation/Foundation.h"
extern NSString *const EOCLoginManagerDidLoginNotification;
@interface EOCLoginManager : NSObject
- (void)login;
@end
// EOCLoginManager.m
#import "EOCLoginManager.h"
NSString *const EOCLoginManagerDidLoginNotification = @"EOCLoginManagerDidLoginNotification";
#implementation EOCLoginManager
- (void)login{
//perform login asynchronously, then call "p_didLogin"
}
- (void) p_didLogin{
[[NSNotification defaultCenter] postNotificationName: EOCLoginManagerDidLoginNotification object:nil];
}
@end
注意常量的名字。为避免命名冲突,最好使用与之相关的类名做前缀。系统框架一般都是这样做的,例如UIKit就按照这种方式来声明用作通知名称的全局变量。其中有类似UIApplicationDidEnterBackgroundNotification与UIApplicationWillEnterForegroundNotification这样的常量名。
其他类型常量也是如此。假如要把前例中的EOCAnimatedView类里的动画时长对外公布,那么可以这样声明:
// EOCAnimatedView.h
extern const NSTimeInterval EOCAnimatedViewAnimationDuration;
//EOCAnimatedView.m
const NSTimeInterval EOCAnimatedViewAnimationDuration = 0.3;
这样的定义常量优于#define预处理指令,因为编译器会确保常量值不变,一旦在EOCAnimate的View中定义好,可随处使用。而采用#define预处理的指令所定义的常量可能会无意遭人修改,从而导致应用程序各个部分所使用的值互不相同。
总之,勿使用预处理指令定义常量,而应借助编译器来确保常量值正确,比方说可以再实现文件中用static const来声明常量。也可以声明一些全局常量。
要点:
不要用预处理指令来定义常量,这样定义出来的常量不含类型信息。编译器只会在编译前据执行查找与替换操作。及时有人重新定义了常量值,编译器也不会产生警告信息,这导致应用程序中的常量值不一致。
在实现文件中使用 static const 来定义“只在编译单元内可见的常量”(translation-unit-spacifIc constant)。由此常量不会再全局符号表中。所以无需为其名称加前缀。
在头文件用extern来声明全局常量,并在相关实现文件中定义其值。这种常量会出现在全局符号表中。所以其名称应加以区隔,通常用与之相关的类名做前缀。
此文章是读《Effective Objective-C 2.0 编写高质量iOS与OS X代码的52个有效方法》学习笔记:
第四条:多用类型常量,少用#define预处理指令