三、接口与 API 设计
第15条、用前缀避免命名空间冲突
Objective-C 没有 namespace 机制,避免重复符号冲突(例如,两份代码中都实现了 EOCTheClass 这个类,那么该类及其元类符号各定义了两次)的唯一方法是变相实现匿名空间:为所有名称加上前缀;
除了类名外,分类中实现的方法、纯 C 函数、全局变量、第三方代码库,都需要加上类名前缀;
第16条、提供“全能初始化方法”
创建类的初始化方法不止一种,某个类可能包含了多个初始化方法,需要选定一个作为全能初始化方法,令其他初始化方法都来调用它,这样做的好处是当底层数据存储机制发生改变时,只需要改变此方法的代码即可;
// 全能初始化方法 EOCRectangle
- (id)initWithWidth:(float)width andHeight:(float)height {
if (self = [super init]) {
_width = width;
_height = height;
}
return self;
}
由于继承机制,子类可以调用父类的初始化方法,因此有必要在子类中覆写父类的初始化方法,使用“全能初始化方法”实现;
// 覆写父类初始化方法
- (id)init {
return [self initWithWidth:5.0f andHeight:10.0f];
}
如果子类全能初始化方法与父类不同,那么应该覆写父类的全能初始化方法;
// 全能初始化方法 EOCSquare
- (id)initWithWidth:(float)width andHeight:(float)height {
float dimension = MAX(width, height);
return [super initWithWidth:dimension andHeight:dimension];
}
第17条、实现 description 方法
使用格式字符串 %@ 打印对象时,会调用 description 方法;
- (NSString*)descirption {
return [NSString stringWithFormat:@"<%@: @p, \"%@ %@\">", [self class], self, _firstName, _secondName];
}
// 借助 NSDictionary 打印
- (NSString*)descirption {
return [NSString stringWithFormat:@"<%@: %p, %@>",
[self class],
self,
@{@"title": _title,
@"latitude": _latitude,
@"longitude": _longitude}
];
}
在 debug 程序时,使用 po 命令,会调用 debugDescription 方法,可以考虑将类名和指针地址放入 debugDescription 中;
第18条、尽量使用不可变对象
实践编程中,尽量把对外公布的属性设为只读,在公开接口中,将所有变量设为 readonly,若外部尝试修改属性名,那么编译时会报错,同时在内部将它们重新声明为 readwrite(在外部,仍然能通过 KVC 进行修改);
// .h 文件
@interface EOCPerson: NSObject
@property (nonatomic, strong, readonly) NSString *firstName;
@property (nonatomic, strong, readonly) NSSet *friends;
- (void)addFriend:(EOCPerson*)person;
@end
// .m 文件
@interface EOCPerson()
// 内部重新声明为 readwrite
@property (nonatomic, strong, readwrite) NSString *firstName;
@end
@implementation EOCPerson {
// @implementation 是内部实现的实例变量,该变量只会在本类中使用;
NSMutableSet *_internalFriends;
}
- (NSSet*)friends {
// 返回不可变对象
return [_internalFriends copy];
}
- (void)addFriend:(EOCPerson*)person {
[_internalFriends addObject:person];
}
@end
第19条、使用清晰而协调的命名方式
方法与变量名:驼峰命名法,以小写开头;
类名:前缀大写字母,驼峰命名法,以大写开头;
将 get 前缀留给那些借由 “输出参数” 来保存返回值的方法(返回结果保存到参数中,而不是通过 return 返回);
第20条、为私有方法名加前缀
Objective-C 无法区分公有或私有方法,每个对象都可以响应任意消息,为了区分公有/私有方法,给私有方法加上前缀,例如 “p_”;
私有方法前缀不能使用 “_”,该前缀是预留给官方使用的;
第21条、理解 Objective-C 错误模型
在 Objective-C 中,自动引用计数默认不是“异常安全”的,因为抛出异常时本应在作用域末尾释放的对象不会被释放,因此在 Objective-C 中只在极其罕见的情况下抛出异常,例如,Objective-C 中实现了一个抽象类,在抽象类中子类必须覆写的方法里抛出异常,这样当使用者直接创建抽象基类的方法时会抛出异常;
常见的做法是使用 NSError 或者返回 nil 来表示错误,NSError 包含了三条信息:Error domain,Error code,User info;
常见的 NSError 的用法是通过协议中的方法传给委托对象:
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error;
或是经由输入参数返回给调用者,传入的参数是一个指针,那么该方法可以经由输入参数将 NSError 对象返回给调用者,编译器会将 NSError** 转换为 NSError * __autoreleasing *;
- (BOOL)doSomething:(NSError **)error;
NSError *error = nil;
BOOL ret = [object doSomething:&error];
if (error) {
// excute the error
}
第22条、理解 NSCopying 协议
copy 方法由 NSObject 实现,该方法以默认区为参数来调用 copyWithZone,覆写 copy 方法只需覆写 copyWithZone 即可;
mutableCopy 同理,覆写 mutableCopyWithZone 即可;
若想令自己实现的类具有 copy 和 mutableCopy,实现 NSCopying 和 NSMutableCopying 协议;
若想令自己实现的类具有深拷贝的方法,自己实现 deepCopy 函数即可;
四、协议与分类
第23条、通过委托与数据源协议进行对象间通信
若类要遵守某个协议,一般是在分类中声明;
@implementation EOCDataModel()<EOCNetworkFetcherDelegate>
@end
协议中的方法一般是可选的,所以要在委托对象上调用可选方法时,必须提前使用类型信息查询方法 respondsToSelector 判断该对象能否响应相关选择子,并将查询后的信息缓存到“位段”中;
struct {
// 该字段所占二进制大小只有1位
unsigned int didReceiveData : 1;
unsigned int didFailWithError : 1;
unsigned int didUpdateProgressTo : 1;
} _delegateFlags;
第24条、将类的实现代码分散到便于管理的数个分类之中
将类的实现代码进行分类的理由:易于管理、便于调试;
// EOCPerson.h
@interface EOCPerson:NSObject
@property (nonatomic, copy, readonly) NSString *firstName;
@property (nonatomic, copy, readonly) NSString *lastName;
- (id)initWithFirstName:(NSString *)firstName andLastName:(NSString *)lastName;
@end
// EOCPerson + Friendship
@interface EOCPerson (Friendship)
- (void)addFirend:(EOCPerson *)person;
@end
// EOCPerson + Work
@interface EOCPerson (Work)
- (void)performDaysWork;
@end
// EOCPerson + Play
@interface EOCPerson (Play)
- (void)goToTheCinema;
@end
也可以创建一个名为 Private 的分类,把所有私有方法放入其中,以隐藏实现细节;
第25条、总是为第三方类的分类名称加前缀
在底层实现中,分类实现的方法都是直接加到原始类的方法列表中,若不同分类中实现了多个同名方法,则会发生方法覆写问题,调用同名方法时以最后一个加入的方法为准,解决方法是:为不同分类中的方法加上同名前缀;
在为第三方类中添加分类时,应给分类名称和其中的方法都加上前缀,防止冲突;
第26条、勿在分类中声明属性
分类中无法声明属性,若声明,编译器会报错:不能在分类中为属性合成存取方法;
解决方法为:在分类中声明属性为 @dynamic,并在运行时实现存取方法;使用关联对象;
正确方法为:将所有属性定义在主接口中,将分类视为扩展类的功能的手段,而非用于封装数据;
第27条、使用 Extension 隐藏实现细节
Extension 也称匿名分类,可以在其中声明属性和定义方法,这样做的好处是可以将方法和属性隐藏起来,仅供本类使用;在 Objective-C 与 C++ 混合编译过程中,利用 Extension 的特性,也可将 C++ 声明的对象放在 Extension 中隐藏起来,对外公布的却是 Objective-C 的接口;
声明协议时,尽量将它放入 Extension 里声明,这样做的好处是将协议视为私有,并且在公共接口中隐藏这一信息;
@interface EOCPerson()
// 声明属性和定义方法
@end
第28条、通过协议提供匿名对象
定义属性为 id<NSCopying>,这表明我们不关注属性的类名,因为它使用 id 进行修饰,可以看作是任何类,但是通过协议修饰,保证它能够响应协议中的某些方法,对象类型已无关紧要;