Chapter 3. Interface and API Design
<br />
Item 19: Use Clear and Consistent Naming
<br />
这一节讲的是编程三大难题之一:变量与函数的命名。
其实并没有讲变量的命名...大概是因为变量都是名词,只有我们这种非母语的人才会纠结吧_(:з」∠)_ 这一节内容在文档Coding Guidelines for Cocoa。
OC的方法格式看习惯了还挺喜欢的。非常有人文关怀。长是长了,一看就明白,第一次见也不用查方法是要做什么,各个参数代表什么,这就是我们常说的牺牲空间换时间(误)。文中实力嘲讽了C++和java的方法命名,对比展示OC命名优越性。
具体说来有以下几个注意:
- 不使用简称。
- 不要滥用“get”。然而这一点文中的叙述我并不是特别明白…
- 关于长句子的方法名,有返回值的,返回值所表示的名词放在最前面,后面每个参数,类型声明之前都应该是这个参数代表的名词。不需要写and。动词和介词放在中间。
- init和工厂方法仿照官方来写,基本上是加with。
- 代理方法尽量以本类作为开头。
- 类和代理名都要加前缀,代理名就用类名+delegate。
说起来,命名这种事情,和语言一样,还是得文档看得多了才能比较有感觉吧。
<br />
Item 20: Prefix Private Method Names
<br />
这一节很短,说的是为private method加前缀。
表示惊吓( ⊙ o ⊙ )。我从来没给private method加过前缀…
好处有二:
- 一是在调试中可以清楚地看清哪些方法是private,哪些方法是public。
- 二是知道了是private就明白不会影响外界API,方便改动。而其余的public method改动起来就要更三思。
我觉得这两条其实说的是一回事。
具体添加什么前缀呢。并不是类名那种三个字母的前缀。文中推荐的是子母+下划线的形式,比如’p_’。不要只用一个下划线,以免和官方的方法名相冲突。
<br />
Item 21: Understand the Objective-C Error Model
<br />
这一节主要讲NSError的使用。
开头先说了NSException。NSException是遇到fatal error时才会使用的,抛出异常以后程序也应该直接终止,这样就不用再关心因为抛出异常而无法执行后面释放资源的代码,使得内存泄露的问题了。但如果是比较小的错误,并不希望程序因此退出,所以如果能用NSError处理就不要使用它。
NSError的详细使用参照Error Handling Programming Guide。
常用到的三个属性是code,domain和userInfo,因为初始化方法需要确定的就是这三个参数。三个属性都是readonly的。
domain -> code -> user info 按顺序对错误提供越来越详细的描述。domain可以看到是哪个系统出错,code可以看到错误的具体名字,一般采用enum来定义,看到code已经可以明白是什么错了,或者已经可以复制到搜索栏了...user info是一个字典,里面的信息更加详细。
文中列举了两个常见的使用场景。
一种是作为待处理的传入参数,像这样:
- (void)connection:(NSURLConnection *)connection didFailWithError: (NSError *)error
这种在网络传输相关的函数和block里都很常见。
第二种我还没见过,是作为输出参数回调,像这样:
- (BOOL)doSomethig:(NSError **)error
回调以后的用法:
NSError *error = nil;
BOOL ret = [object doSomething: &error];
if (error){
\\
}
也就是说,方法调用的时候传递的是error的指针,调用完成后通过这个指针就直接能得到error对象和里面的信息了,虽然是作为参数传进去的,作用却类似于返回值。并且,在方法执行完毕后,系统会保证这个error对象可以自动释放。
<br />
Item 22: Understand the NSCopying Protocol
<br />
这一节讲应该怎样为自定义类实现NSCopying协议。
NSCopying协议是针对可以允许copy操作的类。实现这个协议,如果是普通的类,只需要实现一个方法:
- (id)copyWithZone: (NSZone *)zone
而如果是有immutable和mutable两个版本的类,则需要实现两个方法:
- (id)copyWithZone:(NSZone *)zone
- (id)mutableCopyWithZone:(NSZone *)zone
也就是说,当我们调用[someObject copy];
或[someObject mutableCopy]
时,背后调用的就是这两个方法。这里的zone参数编程的时候都不用去管它,交给系统自动完成。
默认习惯是,copy返回的是immutable对象,mutableCopy返回的是mutable对象,不管原对象可变与否,copy出来的新对象都是这个规律。
就方法的具体写法来说,就是创建一个新的对象,把需要copy的值赋值给这个新的对象,然后返回即可。文中有一个EOCPerson的例子,很清晰。
系统的所有collection默认情况下执行的是shallow copy,所以一般我们也是这么做。如果非常想做deepCopy,也可以专门再写一个deepCopy方法,比如系统的NSSet就有专门的深拷贝init方法,在写deepCopy时可以对所需copy的属性调用这个方法,就可以实现整个类的deep copy了。