Objective-C 的编程艺术(上)

253 阅读38分钟

条件语句

条件语句体应该总是被大括号包围来避免错误,即使可以不用(比如,只有一行内容)。这些错误包括多加了第二行,并且误以为它是 if 语句体里面的。此外,更危险的可能是,如果把 if 语句体里的一行注释掉了,之后的一行代码会不知不觉成为 if 语句里的代码。

推荐:

if (!error) {
    return success;
}

不推荐:

if (!error)
    return success;

或者

if (!error) return success;

在 2014年2月 苹果的 SSL/TLS 实现里面发现了知名的 goto fail 错误。

代码在这里:

static OSStatus
SSLVerifySignedServerKeyExchange(SSLContext *ctx, bool isRsa, SSLBuffer signedParams,
                                 uint8_t *signature, UInt16 signatureLen)
{
  OSStatus        err;
  ...

  if ((err = SSLHashSHA1.update(&hashCtx, &serverRandom)) != 0)
    goto fail;
  if ((err = SSLHashSHA1.update(&hashCtx, &signedParams)) != 0)
    goto fail;
    goto fail;
  if ((err = SSLHashSHA1.final(&hashCtx, &hashOut)) != 0)
    goto fail;
  ...

fail:
  SSLFreeBuffer(&signedHashes);
  SSLFreeBuffer(&hashCtx);
  return err;
}

显而易见,这里有没有括号包围的2行连续的 goto fail; 。我们当然不希望写出上面的代码导致出现错误。

此外,在其他条件语句里面也应该按照这种风格统一,这样更便于检查。

尤达表达式

不要使用尤达表达式。尤达表达式是指,拿一个常量去和变量比较而不是拿变量去和常量比较。它就像是在表达 “蓝色是不是天空的颜色” 或者 “高个是不是这个男人的属性” 而不是 “天空是不是蓝的” 或者 “这个男人是不是高个子的”

(译者注:名字起源于星球大战中尤达大师的讲话方式,总是用倒装的语序)

推荐:

if ([myValue isEqual:@42]) { ...

不推荐:

if ([@42 isEqual:myValue]) { ...

nil 和 BOOL 检查

On a similar note of the Yoda conditions, also the nil check has been at the centre of debates. Some notous libraries out there use to check for an object to be or not to be nil as so:

【疑问】 类似于 Yoda 表达式,nil 检查的方式也是存在争议的。一些 notous 库 像这样检查对象是否为 nil:

if (nil == myValue) { ...

或许有人会提出这是错的,因为在 nil 作为一个常量的情况下,这样做就像 Yoda 表达式了。 但是一些程序员这么做的原因是为了避免调试的困难,看下面的代码:

if (myValue == nil) { ...

如果程序员敲错成这样:

if (myValue = nil) { ...

这是合法的语句,但是即使你是一个丰富经验的程序员,即使盯着眼睛瞧上好多遍也很难调试出错误。但是如果把 nil 放在左边,因为它不能被赋值,所以就不会发生这样的错误。 如果程序员这样做,他/她就可以轻松检查出可能的原因,比一遍一遍查看敲下的代码要好很多。

为了避免这些奇怪的问题,途径是使用感叹号来判断。因为 nil 是 解释到 NO 所以没必要在条件语句里面把它和其他值比较。同时,不要直接把它和 YES 比较,因为YES的定义是 1 而 BOOL 是 8 位的,实际上是 char 类型。

推荐:

if (someObject) { ...
if (![someObject boolValue]) { ...
if (!someObject) { ...

不推荐:

if (someObject == YES) { ... // Wrong
if (myRawValue == YES) { ... // Never do this.
if ([someObject boolValue] == NO) { ...

这样同时也能提高一致性,以及提升可读性。

黄金大道

当编写条件语句的时候,左边的代码间距应该是一个“黄金”或者“快乐”的大道。 这是说,不要嵌套if语句。多个 return 语句是OK的。这样可以避免 Cyclomatic 复杂性,并且让代码更加容易阅读。因为你的方法的重要的部分没有嵌套在分支上,你可以很清楚地找到相关的代码。

推荐:

- (void)someMethod {
  if (![someOther boolValue]) {
      return;
  }

  //Do something important
}

不推荐:

- (void)someMethod {
  if ([someOther boolValue]) {
    //Do something important
  }
}

复杂的表达式

当你有一个复杂的 if 子句的时候,你应该把它们提取出来赋给一个 BOOL 变量,这样可以让逻辑更清楚,而且让每个子句的意义体现出来

BOOL nameContainsSwift  = [sessionName containsString:@"Swift"];
BOOL isCurrentYear      = [sessionDateCompontents year] == 2014;
BOOL isSwiftSession     = nameContainsSwift && isCurrentYear;

if (isSwiftSession) {
    // Do something very cool
}

三元运算符

三元运算符 ? 应该只用在它能让代码更加清楚的地方。 一个条件语句的所有的变量应该是已经被求值了的。计算多个条件子句通常会让语句更加难以理解,就像if语句的情况一样,或者把它们重构到实例变量里面。

推荐:

result = a > b ? x : y;

不推荐:

result = a > b ? x = c > d ? c : d : y;

当三元运算符的第二个参数(if 分支)返回和条件语句中已经检查的对象一样的对象的时候,下面的表达方式更灵巧:

推荐:

result = object ? : [self createObject];

不推荐:

result = object ? object : [self createObject];

错误处理

当方法返回一个错误参数的引用的时候,检查返回值,而不是错误的变量。

推荐:

NSError *error = nil;
if (![self trySomethingWithError:&error]) {
    // Handle Error
}

此外,一些苹果的 API 在成功的情况下会对 error 参数(如果它非 NULL)写入垃圾值(garbage values),所以如果检查 error 的值可能导致错误 (甚至崩溃)。

Case语句

除非编译器强制要求,括号在 case 语句里面是不必要的。但是当一个 case 包含了多行语句的时候,需要加上括号。

switch (condition) {
    case 1:
        // ...
        break;
    case 2: {
        // ...
        // Multi-line example using braces
        break;
       }
    case 3:
        // ...
        break;
    default: 
        // ...
        break;
}

有时候可以使用 fall-through 在不同的 case 里面执行一样的代码。一个 fall-through 是指移除 case 语句的 “break” 然后让下面的 case 继续执行。

switch (condition) {
    case 1:
    case 2:
        // code executed for values 1 and 2
        break;
    default: 
        // ...
        break;
}

当在 switch 语句里面使用一个可枚举的变量的时候,default 是不必要的。比如:

switch (menuType) {
    case ZOCEnumNone:
        // ...
        break;
    case ZOCEnumValue1:
        // ...
        break;
    case ZOCEnumValue2:
        // ...
        break;
}

此外,为了避免使用默认的 case,如果新的值加入到 enum,程序员会马上收到一个 warning 通知

Enumeration value 'ZOCEnumValue3' not handled in switch.

Enumerated Types 枚举类型

当使用 enum 的时候,建议使用新的固定的基础类型定义,因它有更强大的的类型检查和代码补全。 SDK 现在有一个 宏来鼓励和促进使用固定类型定义 - NS_ENUM()

*例子: **

typedef NS_ENUM(NSUInteger, ZOCMachineState) {
    ZOCMachineStateNone,
    ZOCMachineStateIdle,
    ZOCMachineStateRunning,
    ZOCMachineStatePaused
};

命名

通用的约定

尽可能遵守 Apple 的命名约定,尤其是和 内存管理规则 (NARC) 相关的地方。

推荐使用长的、描述性的方法和变量名

推荐:

UIButton *settingsButton;

不推荐:

UIButton *setBut;

Constants 常量

常量应该使用驼峰命名法,并且为了清楚,应该用相关的类名作为前缀。

推荐:

static const NSTimeInterval ZOCSignInViewControllerFadeOutAnimationDuration = 0.4;

不推荐:

static const NSTimeInterval fadeOutTime = 0.4;

常量应该尽量使用 in-line 的字符串字面值或者数字,这样便于经常用到的时候复用,并且可以快速修改而不用查找和替换。 常量应该用 static声明,并且不要使用 #define,除非它就是明确作为一个宏来用的。

推荐:

static NSString * const ZOCCacheControllerDidClearCacheNotification = @"ZOCCacheControllerDidClearCacheNotification";
static const CGFloat ZOCImageThumbnailHeight = 50.0f;

不推荐:

#define CompanyName @"Apple Inc."
#define magicNumber 42

常量应该在 interface 文件中这样被声明:

extern NSString *const ZOCCacheControllerDidClearCacheNotification;

并且应该在实现文件中实现它的定义。

你只需要为公开的常量添加命名空间前缀。即使私有常量在实现文件中可能以不同的模式使用,你也不需要坚持这个规则了。

方法

对于方法签名,在方法类型 (-/+符号)后应该要有一个空格。方法段之间也应该有一个空格(来符合 Apple 的规范)。在参数名称之前总是应该有一个描述性的关键词。

使用“and”命名的时候应当更加谨慎。它不应该用作阐明有多个参数,比如下面的initWithWidth:height: 例子:

推荐:

- (void)setExampleText:(NSString *)text image:(UIImage *)image;
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

不推荐:

- (void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height;  // Never do this.

字面值

NSString,NSDictionary,NSArray, 和 NSNumber 字面值应该用在任何创建不可变的实例对象。特别小心 nil 不能放进 NSArrayNSDictionary里,这会导致 Crash。

例子:

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal", @"Mobile Web" : @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018;

不要这样做:

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];
NSNumber *buildingZIPCode = [NSNumber numberWithInteger:10018];

对于那些可变的副本,我们推荐使用明确的如 NSMutableArray, NSMutableString这些类。

下面的例子 应该被避免:

NSMutableArray *aMutableArray = [@[] mutableCopy];

上面的书写方式存在效率以及可读性的问题。效率方面,一个不必要的不可变变量被创建,并且马上被废弃了;这并不会让你的 App 变得更慢(除非这个方法会被很频繁地调用),但是确实没必要为了少打几个字而这样做。对于可读性来说,存在两个问题:第一个是当浏览代码并且看见@[]的时候你的脑海里马上会联系到 NSArray 的实例,但是在这种情形下你需要停下来思考下。另一个方面,一些新手看到后可能会对可变和不可变对象的分歧感到不舒服。他/她可能对创造一个可变对象的副本不是很熟悉(当然这并不是说这个知识不重要)。当然,这并不是说存在绝对的错误,只是可用性(包括可读性)有一些问题。

类名

类名应加上 三 个大写字母作为前缀(两个字母的为 Apple 的类保留)。虽然这个规范看起来难看,但是这样做是为了减少 objective-c 没有命名空间所带来的问题。

一些开发者在定义 Model 对象时并不遵循这个规范(对于 Core Data 对象,我们更应该遵循这个规范)。我们建议在定义 Core Data 对象时严格遵循这个约定,因为你最后可能把你的 Managed Object Model 和其他(第三方库)的 Managed Object Model 合并。

你可能注意到了,这本书里的类的前缀(其实不仅仅是类)是ZOC

另一个类的命名规范:当你创建一个子类的时候,你应该把说明性的部分放在前缀和父类名的在中间。举个例子:如果你有一个 ZOCNetworkClient 类,子类的名字会是ZOCTwitterNetworkClient (注意 "Twitter" 在 "ZOC" 和 "NetworkClient" 之间); 按照这个约定, 一个UIViewController 的子类会是 ZOCTimelineViewController.

Initializer 和 dealloc 初始化

推荐的代码组织方式:将dealloc 方法放在实现文件的最前面(直接在 @synthesize 以及 @dynamic 之后),init 应该放在 dealloc 之后。如果有多个初始化方法, designated initializer 应该放在第一个,secondary initializer 在之后紧随,这样逻辑性更好。 如今有了 ARC,dealloc 方法几乎不需要实现,不过把 init 和 dealloc 放在一起可以从视觉上强调它们是一对的。通常,在 init方法中做的事情需要在 dealloc 方法中撤销。

init 方法应该是这样的结构:

- (instancetype)init
{
    self = [super init]; // call the designated initializer
    if (self) {
        // Custom initialization
    }
    return self;
}

为什么设置 self[super init] 的返回值,以及中间发生了什么呢?这是一个十分有趣的话题。

让我们后退一步:我们曾经写了类似 [[NSObject alloc] init]的表达式,allocinit 区别慢慢褪去 。一个 Objective-C 的特性叫 两步创建 。 这意味着申请分配内存和初始化是两个分离的操作。

  • alloc表示对象分配内存,这个过程涉及分配足够的可用内存来保存对象,写入isa指针,初始化 retain 的计数,并且初始化所有实例变量。
  • init 是表示初始化对象,这意味着把对象放到了一个可用的状态。这通常是指把对象的实例变量赋给了可用的值。

alloc 方法会返回一个合法的没有初始化的实例对象。每一个发送到实例的信息会被翻译为名字是selfalloc返回的指针的参数返回的 objc_msgSend()的调用。这样之后self已经可以执行所有方法了。为了完成两步创建,第一个发送给新创建的实例的方法应该是约定俗成的 init 方法。注意 NSObjectinit 实现中,仅仅是返回了self

关于 init 有一个另外的重要的约定:这个方法可以(并且应该)在不能成功完成初始化的时候返回nil;初始化可能因为各种原因失败,比如一个输入的格式错误,或者未能成功初始化一个需要的对象。 这样我们就理解了为什么需要总是调用self = [super init]。如果你的超类没有成功初始化它自己,你必须假设你在一个矛盾的状态,并且在你的实现中不要处理你自己的初始化逻辑,同时返回nil。如果你不是这样做,你看你会得到一个不能用的对象,并且它的行为是不可预测的,最终可能会导致你的 app 发生 crash。

重新给self 赋值同样可以被 init 利用为在被调用的时候返回不同的实例。一个例子是 类簇 或者其他的返回相同的(不可变的)实例对象的 Cocoa 类。

Designated 和 Secondary Initializers

Objective-C 有 designated 和 secondary 初始化方法的观念。 designated 初始化方法是提供所有的参数,secondary 初始化方法是一个或多个,并且提供一个或者更多的默认参数来调用 designated 初始化方法的初始化方法。

@implementation ZOCEvent

- (instancetype)initWithTitle:(NSString *)title
                         date:(NSDate *)date
                     location:(CLLocation *)location
{
    self = [super init];
    if (self) {
        _title    = title;
        _date     = date;
        _location = location;
    }
    return self;
}

- (instancetype)initWithTitle:(NSString *)title
                         date:(NSDate *)date
{
    return [self initWithTitle:title date:date location:nil];
}

- (instancetype)initWithTitle:(NSString *)title
{
    return [self initWithTitle:title date:[NSDate date] location:nil];
}

@end

initWithTitle:date:location:就是 designated 初始化方法,另外的两个是 secondary 初始化方法。因为它们仅仅是调用类实现的 designated 初始化方法

Designated Initializer

一个类应该又且只有一个 designated 初始化方法,其他的初始化方法应该调用这个 designated 的初始化方法(虽然这个情况有一个例外)

这个分歧没有要求那个初始化函数需要被调用。

在类继承中调用任何 designated初始化方法都是合法的,而且应该保证所有的designatedinitializer在类继承中是是从祖先(通常是 NSObject)到你的类向下调用的。实际上这意味着第一个执行的初始化代码是最远的祖先,然后从顶向下的类继承,所有类都有机会执行他们特定的初始化代码。这样,你在你做你的特定的初始化工作前,所有你从超类继承的东西是不可用的状态。即使它的状态不明确,所有 Apple 的框架的 Framework 是保证遵守这个约定的,而且你的类也应该这样做。

当定义一个新类的时候有三个不同的方式:

  1. 不需要重载任何初始化函数
  2. 重载 designated initializer
  3. 定义一个新的 designated initializer

第一个方案是最简单的:你不需要增加类的任何初始化逻辑,只需要依照父类的designatedinitializer。当你希望提供额外的初始化逻辑的时候你可以重载 designatedinitializer。你只需要重载你的直接的超类的designatedinitializer并且确认你的实现调用了超类的方法。 你一个典型的例子是你创造UIViewController子类的时候重载 initWithNibName:bundle:方法。

@implementation ZOCViewController

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{
    // call to the superclass designated initializer
    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
    if (self) {
        // Custom initialization
    }
    return self;
}

@end

UIViewController 子类的例子里面如果重载 init 会是一个错误,这个情况下调用者会尝试调用 initWithNib:bundle 初始化你的类,你的类实现不会被调用。着同样违背了它应该是合法调用任何 designated initializer 的规则。

在你希望提供你自己的初始化函数的时候,你应该遵守这三个步骤来保证正确的性:

  1. 定义你的 designated initializer,确保调用了直接超类的 designated initializer
  2. 重载直接超类的 designated initializer。调用你的新的 designated initializer.
  3. 为新的 designated initializer 写文档

很多开发者忽略了后两步,这不仅仅是一个粗心的问题,而且这样违反了框架的规则,而且可能导致不确定的行为和bug。 让我们看看正确的实现的例子:

@implementation ZOCNewsViewController

- (id)initWithNews:(ZOCNews *)news
{
    // call to the immediate superclass's designated initializer
    self = [super initWithNibName:nil bundle:nil];
    if (self) {
        _news = news;
    }
    return self;
}

// Override the immediate superclass's designated initializer (重载直接父类的  designated initializer)
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{
    // call the new designated initializer
    return [self initWithNews:nil];
}

@end

你没重载initWithNibName:bundle:而且调用者决定用这个方法初始化你的类(这是完全合法的)。initWithNews:永远不会被调用,所以导致了不正确的初始化流程,你的类特定的初始化逻辑没有被执行。

即使可以推断那个方法是 designateinitializer它,但是最好清晰地明确(未来的你或者其他开发者在改代码的时候会感谢你的)。你应该考虑来用这两个策略(不是互斥的):第一个是你在文档中明确哪一个初始化方法是designated的,但是最好你可以用编译器的指令 __attribute__((objc_designated_initializer)) 来标记你的意图。用这个编译指令的时候,编译器回来帮你。如果你的新的 designate initializer 没有调用你超类的 designated initializer,上编译器会发出警告。然而,当没有调用类的designated initializer 的时候(并且依次提供必要的参数),并且调用其他父类中的designatedinitialize的时候,会变成一个不可用的状态。参考之前的例子,当实例化一个ZOCNewsViewController展示一个新闻而那条新闻没有展示的话,就会毫无意义。这个情况下你应该只需要让其他的 designatedinitializer失效,来强制调用一个非常特别的designatedinitializer。通过使用另外一个编译器指令__attribute__((unavailable("Invokethedesignatedinitializer")))来修饰一个方法,通过这个属性,会让你在试图调用这个方法的时候产生一个编译错误。

这是之前的例子相关的实现的头文件(这里使用宏来让代码没有那么啰嗦)

@interface ZOCNewsViewController : UIViewController

- (instancetype)initWithNews:(ZOCNews *)news ZOC_DESIGNATED_INITIALIZER;
- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil ZOC_UNAVAILABLE_INSTEAD(initWithNews:);
- (instancetype)init ZOC_UNAVAILABLE_INSTEAD(initWithNews:);

@end

上述的一个推论是:你应该永远不从 designated initializer 里面调用一个 secondary initializer (如果secondary initializer 遵守约定,它会调用designatedinitializer)。如果这样,调用很可能会调用一个子类重写的init方法并且陷入无限递归之中。

然而一个意外是一个对象是否遵守NSCoding协议,并且它通过方法initWithCoder:初始化。我们应该区别超类是否符合NSCoding的情况。 如果符合,如果你只是调用[superinitWithCoder:]你会可能有一个共享的初始化代码在designatedinitializer里面,一个好的方法是吧这些代码放在私有方法里面(比如p_commonInit)。当你的超类不符合NSCoding协议的时候,推荐把initWithCoder:作为 secondary initializer 来对待,并且调用 self的 designated initializer。 注意这是违反 Apple 的Archivesand Serializations Programming Guide 上面写的:

the object should first invoke its superclass's designated initializer to initialize inherited state (对象总是应该首先调用超类的 designated initializer 来初始化继承的状态)

如果你的类不是 NSObject 的直接子类,这样做的话,会导致不可预测的行为。

Secondary Initializer

正如之前的描述么,secondary initializer是一种方便提供默认值、行为到designatedinitializer的方法。也就是说,你不应该强制很多初始化操作在这样的方法里面,并且你应该一直假设这个方法不会得到调用。我们保证的是唯一被调用的方法是designated initializer。 这意味着你的 designated initializer 总是应该调用其他的 secondary initializer 或者你 self 的 designated initializer。有时候,因为错误,可能打成了super,这样会导致不符合上面提及的初始化顺序(在这个特别的例子里面,是跳过当前类的初始化)

References 参考

instancetype

我们经常忽略 Cocoa 充满了约定,并且这些约定可以帮助编译器变得更加聪明。无论编译器是否遭遇alloc或者init方法,他会知道,即使返回类型都是id,这些方法总是返回接受到的类类型的实例。因此,它允许编译器进行类型检查。(比如,检查方法返回的类型是否合法)。Clang的这个好处来自于relatedresulttype, 意味着:

messages sent to one of alloc and init methods will have the same static type as the instance of the receiver class (发送到 alloc 或者 init 方法的消息会有同样的静态类型检查是否为接受类的实例。)

更多的关于这个自动定义相关返回类型的约定请查看 Clang Language Extensions guide 的appropriate section

一个相关的返回类型可以明确地规定用instancetype关键字作为返回类型,并且它可以在一些工厂方法或者构造器方法的场景下很有用。它可以提示编译器正确地检查类型,并且更加重要的是,这同时适用于它的子类。

@interface ZOCPerson
+ (instancetype)personWithName:(NSString *)name;
@end

虽然如此,根据 clang 的定义,id可以被编译器提升到instancetype。在alloc或者init中,我们强烈建议对所有返回类的实例的类方法和实例方法使用instancetype 类型。

在你的 API 中要构成习惯以及保持始终如一的,此外,通过对你代码的小调整你可以提高可读性:在简单的浏览的时候你可以区分哪些方法是返回你类的实例的。你以后会感谢这些注意过的小细节的。

参考

初始化模式

类簇 (class cluster)

类簇在Apple的文档中这样描述:

an architecture that groups a number of private, concrete subclasses under a public, abstract superclass.(一个在共有的抽象超类下设置一组私有子类的架构)

如果这个描述听起来很熟悉,说明你的直觉是对的。Classcluster是Apple对抽象工厂设计模式的称呼。

class cluster 的想法很简单,你经常有一个抽象类在初始化期间处理信息,经常作为一个构造器里面的参数或者环境中读取,来完成特定的逻辑并且实例化子类。这个"public facing" 应该知晓它的子类而且返回适合的私有子类。

这个模式非常有用,因为它减少了构造器调用中的复杂性,只需要知道接口如何与对象通信,而不需要知道怎么实现。

Class clusters 在 Apple 的Framework 中广泛使用:一些明显的例子比如 NSNumber 可以返回不同哦给你的子类,取决于 数字类型如何提供 (Integer, Float, etc...) 或者 NSArray 返回不同的最优存储策略的子类。

这个模式的精妙的地方在于,调用者可以完全不管子类,事实上,这可以用在设计一个库,可以用来交换实际的返回的类,而不用去管相关的细节,因为它们都遵从抽象超类的方法。

我们的经验是使用类簇可以帮助移除很多条件语句。

一个经典的例子是如果你有为 iPad 和 iPhone 写的一样的 UIViewController 子类,但是在不同的设备上有不同的行为。

比较基础的实现是用条件语句检查设备,然后执行不同的逻辑。虽然刚开始可能不错,但是随着代码的增长,运行逻辑也会趋于复杂。 一个更好的实现的设计是创建一个抽象而且宽泛的 view controller 来包含所有的共享逻辑,并且对于不同设备有两个特别的子例。

通用的 view controller 会检查当前设备并且返回适当的子类。

@implementation ZOCKintsugiPhotoViewController

- (id)initWithPhotos:(NSArray *)photos
{
    if ([self isMemberOfClass:ZOCKintsugiPhotoViewController.class]) {
        self = nil;

        if ([UIDevice isPad]) {
            self = [[ZOCKintsugiPhotoViewController_iPad alloc] initWithPhotos:photos];
        }
        else {
            self = [[ZOCKintsugiPhotoViewController_iPhone alloc] initWithPhotos:photos];
        }
        return self;
    }
    return [super initWithNibName:nil bundle:nil];
}

@end

之前的代码的例子展示了如何创建一个类簇。首先,[self isMemberOfClass:ZOCKintsugiPhotoViewController.class] 来避免在子类中重载初始化方法,来避免无限的递归。当 [[ZOCKintsugiPhotoViewController alloc]initWithPhotos:photos]得到调用的时候之前的检查会变成trueself=nil是用来移除所有到ZOCKintsugiPhotoViewController实例的引用的,它会被释放,按照这个逻辑来检查哪个类应该被初始化。让我们假设在iPhone上运行了这个代码,ZOCKintsugiPhotoViewController_iPhone 没有重载initWithPhotos:,在这个情况下,当执行self=[[ZOCKintsugiPhotoViewController_iPhonealloc]initWithPhotos:photos];的时候,ZOCKintsugiPhotoViewController会被调用,并且当第一次检查的时候,这样不会让 ZOCKintsugiPhotoViewController 检查会变成false 调用return [super initWithNibName:nil bundle:nil]; ,这会让 继续初始化执行正确的初始化之前的会话。

单例

如果可能,请尽量避免使用单例而是依赖注入。 然而,如果一定要用,请使用一个线程安全的模式来创建共享的实例。 对于GCD,用 dispatch_once() 函数就可以咯。

+ (instancetype)sharedInstance
{
   static id sharedInstance = nil;
   static dispatch_once_t onceToken = 0;
   dispatch_once(&onceToken, ^{
      sharedInstance = [[self alloc] init];
   });
   return sharedInstance;
}
使用dispatch_once(),来控制代码同步,取代了原来老的约定俗成的用法。

+ (instancetype)sharedInstance
{
    static id sharedInstance;
    @synchronized(self) {
        if (sharedInstance == nil) {
            sharedInstance = [[MyClass alloc] init];
        }
    }
    return sharedInstance;
}

dispatch_once()的优点是,它更快,而且语法上更干净,因为dispatch_once()的意思就是”把一些东西执行一次“,就像我们做的一样。 这样同时可以避免possibleandsometimesprolificcrashes.

经典的可以接受的单例对象的例子是一个设备的GPS以及动作传感器。即使单例对象可以被子类化,这个情况可以十分有用。这个接口应该证明给出的类是趋向于使用单例的。然而,经常使用一个单独的公开的sharedInstance类方法就够了,并且不可写的属性也应该被暴露。

把单例作为一个对象的容器来在代码或者应用层面上共享是糟糕和丑陋的,这是一个不好的设计。

属性

属性应该尽可能描述性地命名,避免缩写,并且是小写字母开头的驼峰命名。我们的工具可以很方便地帮我们自动补全所有东西(嗯。。几乎所有的,Xcode 的Derived Data 会索引这些命名)。所以没理由少打几个字符了,并且最好尽可能在你源码里表达更多东西。

例子 :

NSString *text;

不要这样 :

NSString* text;
NSString * text;

(注意:这个习惯和常量不同,这是主要从常用和可读性考虑。 C++ 的开发者偏好从变量名中分离类型,作为类型它应该是 NSString*(对于从堆中分配的对象,同事对于C++是不能从栈上分配的)格式。)

使用属性的自动同步 (synthesize)而不是手动的@synthesize语句,除非你的属性是protocol的一部分而不是一个完整的类。如果 Xcode 可以自动同步这些变量,就让它来做吧。否则只会让你抛开 Xcode 的优点,维护更冗长的代码。

你应该总是使用 setter 和 getter方法访问属性,除了initdealloc方法。通常,使用属性让你增加了在当前作用域之外的代码块的可能所以可能带来更多副作用

你总应该用 getter 和 setter 因为:

  • 使用 setter 会遵守定义的内存管理语义(strong,weak,copyetc...)这回定义更多相关的在ARC是钱,因为它始终是相关的。举个例子,copy 每个时候你用 setter 并且传送数据的时候,它会复制数据而不用额外的操作

  • KVO 通知(willChangeValueForKey, didChangeValueForKey) 会被自动执行

  • 更容易debug:你可以设置一个断点在属性声明上并且断点会在每次getter/setter方法调用的时候执行,或者你可以在自己的自定义 setter/getter 设置断点。

  • 允许在一个单独的地方为设置值添加额外的逻辑。

你应该倾向于用 getter:

  • 它是对未来的变化有扩展能力的(比如,属性是自动生成的)
  • 它允许子类化 更简单的debug(比如,允许拿出一个断点在 getter 方法里面,并且看谁访问了特别的 getter
  • 它让意图更加清晰和明确:通过访问 ivar _anIvar 你可以明确的访问 self->_anIvar.这可能导致问题。在 block 里面访问 ivar (你捕捉并且 retain 了 sefl 即使你没有明确的看到 self 关键词)
  • 它自动产生KVO 通知
  • 在消息发送的时候增加的开销是微不足道的。更多关于新年问题的介绍你可以看 Should I Use a Property or an Instance Variable?

Init 和 Dealloc

有一个例外:你永远不能在 init (以及其他初始化函数)里面用 getter 和 setter 方法,并且你直接访问实例变量。事实上一个子类可以重载sette或者getter并且尝试调用其他方法,访问属性的或者 ivar 的话,他们可能没有完全初始化。记住一个对象是仅仅在 init 返回的时候,才会被认为是初始化完成到一个状态了。

同样在 dealloc 方法中(在 dealloc 方法中,一个对象可以在一个 不确定的状态中)这是同样需要被注意的。

此外,在 init 中使用 setter 不会很好执行 UIAppearence 代理(参见 UIAppearance for Custom Views 看更多相关信息).)

点符号

当使用 setter getter 方法的时候尽量使用点符号。应该总是用点符号来访问以及设置属性

例子:

view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;

不要这样:

[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;

使用点符号会让表达更加清晰并且帮助区分属性访问和方法调用

属性定义

推荐按照下面的格式来定义属性

@property (nonatomic, readwrite, copy) NSString *name;

属性的参数应该按照下面的顺序排列: 原子性,读写 和 内存管理。 这样做你的属性更容易修改正确,并且更好阅读。

你必须使用 nonatomic,除非特别需要的情况。在iOS中,atomic带来的锁特别影响性能。

属性可以存储一个代码块。为了让它存活到定义的块的结束,必须使用 copy(block 最早在栈里面创建,使用 copy让 block 拷贝到堆里面去)

为了完成一个共有的 getter 和一个私有的 setter,你应该声明公开的属性为readonly并且在类扩展总重新定义通用的属性为 readwrite 的。

@interface MyClass : NSObject
@property (nonatomic, readonly) NSObject *object
@end

@implementation MyClass ()
@property (nonatomic, readwrite, strong) NSObject *object
@end

如果 BOOL 属性的名字是描述性的,这个属性可以省略 "is" ,但是特定要在 get 访问器中指定名字,如:

@property (assign, getter=isEditable) BOOL editable;

文字和例子是引用 Cocoa NamingGuidelines.

为了避免 @synthesize的使用,在实现文件中,Xcode已经自动帮你添加了。

私有属性

私有属性应该在类实现文件的类拓展(class extensions,没有名字的 categories 中)中。有名字的 categories(如果 ZOCPrivate)不应该使用,除非拓展另外的类。

例子:

@interface ZOCViewController ()
@property (nonatomic, strong) UIView *bannerView;
@end

可变对象

【疑问】

任何可以用来用一个可变的对象设置的((比如NSString,NSArray,NSURLRequest))属性的的内存管理类型必须是 copy 的。

这个是用来确保包装,并且在对象不知道的情况下避免改变值。

你应该同时避免暴露在公开的接口中可变的对象,因为这允许你的类的使用者改变你自己的内部表示并且破坏了封装。你可以提供可以只读的属性来返回你对象的不可变的副本。

/* .h */
@property (nonatomic, readonly) NSArray *elements

/* .m */
- (NSArray *)elements {
  return [self.mutableElements copy];
}

懒加载

当实例化一个对象可能耗费很多资源的,或者需要只配置一次并且有一些配置方法需要调用,而且你还不想弄乱这些方法。

在这个情况下,我们可以选择使用重载属性的 getter 方法来做 lazy 实例化。通常这种操作的模板像这样:

- (NSDateFormatter *)dateFormatter {
  if (!_dateFormatter) {
    _dateFormatter = [[NSDateFormatter alloc] init];
        NSLocale *enUSPOSIXLocale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"];
        [dateFormatter setLocale:enUSPOSIXLocale];
        [dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSSSS"];
  }
  return _dateFormatter;
}

即使在一些情况下这是有益的,但是我们仍然建议你在决定这样做之前经过深思熟虑,事实上这样是可以避免的。下面是使用 延迟实例化的争议。

  • getter 方法不应该有副作用。在使用getter方法的时候你不要想着它可能会创建一个对象或者导致副作用,事实上,如果调用 getter 方法的时候没有涉及返回的对象,编译器就会放出警告:getter 不应该产生副作用
  • 你在第一次访问的时候改变了初始化的消耗,产生了副作用,这回让优化性能变得困难(以及测试)
  • 这个初始化可能是不确定的:比如你期望属性第一次被一个方法访问,但是你改变了类的实现,访问器在你预期之前就得到了调用,这样可以导致问题,特别是初始化逻辑可能依赖于类的其他不同状态的时候。总的来说最好明确依赖关系。
  • 这个行为不是 KVO 友好的。如果 getter 改变了引用,他应该通过一个 KVO 通知来通知改变。当访问 getter 的时候收到一个改变的通知很奇怪。

方法

参数断言

你的方法可能要求一些参数来满足特定的条件(比如不能为nil),在这种情况下啊最好使用 NSParameterAssert() 来断言条件是否成立或是抛出一个异常。

私有方法

永远不要在你的私有方法前加上_ 前缀。这个前缀是 Apple 保留的。不要冒重载苹果的私有方法的险。

相等性

当你要实现相等性的时候记住这个约定:你需要同时实现isEqualand thehash方法。如果两个对象是被isEqual认为相等的,它们的 hash方法需要返回一样的值。但是如果hash 返回一样的值,并不能确保他们相等。

这个约定是因为当被存储在集合(如NSDictionaryNSSet在底层使用hash表数据的数据结构)的时候,如何查找这些对象。

@implementation ZOCPerson

- (BOOL)isEqual:(id)object {
    if (self == object) {
        return YES;
    }

    if (![object isKindOfClass:[ZOCPerson class]]) {
        return NO;
    }

    // check objects properties (name and birthday) for equality
    ...
    return propertiesMatch;
}

- (NSUInteger)hash {
    return [self.name hash] ^ [self.birthday hash];
}

@end

一定要注意 hash 方法不能返回一个常量。这是一个典型的错误并且会导致严重的问题,因为使用了这个值作为 hash 表的 key,会导致 hash 表 100%的碰撞

你总是应该用isEqualTo<#class-name-without-prefix#>:这样的格式实现一个相等性检查方法。如果你这样做,会优先调用这个方法来避免上面的类型检查。

一个完整的 isEqual* 方法应该是这样的:

- (BOOL)isEqual:(id)object {
    if (self == object) {
      return YES;
    }

    if (![object isKindOfClass:[ZOCPerson class]]) {
      return NO;
    }

    return [self isEqualToPerson:(ZOCPerson *)object];
}

- (BOOL)isEqualToPerson:(Person *)person {
    if (!person) {
        return NO;
    }

    BOOL namesMatch = (!self.name && !person.name) ||
                       [self.name isEqualToString:person.name];
    BOOL birthdaysMatch = (!self.birthday && !person.birthday) ||
                           [self.birthday isEqualToDate:person.birthday];

  return haveEqualNames && haveEqualBirthdays;
}

一个对象实例的 hash计算结果应该是确定的。当它被加入到一个容器对象(比如NSArray, NSSet, 或者 NSDictionary)的时候这是很重要的,否则行为会无法预测(所有的容器对象使用对象的 hash 来查找或者实施特别的行为,如确定唯一性)这也就是说,应该用不可变的属性来计算 hash 值,或者,最好保证对象是不可变的。

Categories

虽然我们知道这样写很丑, 但是我们应该要在我们的 category 方法前加上自己的小写前缀以及下划线,比如- (id)zoc_myCategoryMethod。 这种实践同样被苹果推荐

这是非常必要的。因为如果在扩展的 category 或者其他 category 里面已经使用了同样的方法名,会导致不可预计的后果。实际上,实际被调用的是最后被实现的那个方法。

如果想要确认你的分类方法没有覆盖其他实现的话,可以把环境变量 OBJC_PRINT_REPLACED_METHODS 设置为 YES,这样那些被取代的方法名字会打印到 Console 中。现在 LLVM 5.1 不会为此发出任何警告和错误提示,所以自己小心不要在分类中重载方法。

一个好的实践是在 category 名中使用前缀。

例子

`` @interface NSDate (ZOCTimeExtensions)

  • (NSString *)zoc_timeAgoShort; @end `` 不要这样做
@interface NSDate (ZOCTimeExtensions)
- (NSString *)timeAgoShort;
@end

分类可以用来在头文件中定义一组功能相似的方法。这是在 Apple的 Framework 也很常见的一个实践(下面例子的取自NSDate 头)。我们也强烈建议在自己的代码中这样使用。

我们的经验是,创建一组分类对以后的重构十分有帮助。一个类的接口增加的时候,可能意味着你的类做了太多事情,违背了类的单一功能原则。

之前创造的方法分组可以用来更好地进行不同功能的表示,并且把类打破在更多自我包含的组成部分里。


@interface NSDate : NSObject <NSCopying, NSSecureCoding>

@property (readonly) NSTimeInterval timeIntervalSinceReferenceDate;

@end

@interface NSDate (NSDateCreation)

+ (instancetype)date;
+ (instancetype)dateWithTimeIntervalSinceNow:(NSTimeInterval)secs;
+ (instancetype)dateWithTimeIntervalSinceReferenceDate:(NSTimeInterval)ti;
+ (instancetype)dateWithTimeIntervalSince1970:(NSTimeInterval)secs;
+ (instancetype)dateWithTimeInterval:(NSTimeInterval)secsToBeAdded sinceDate:(NSDate *)date;
// ...
@end

Protocols

在 Objective-C 的世界里面经常错过的一个东西是抽象接口。接口(interface)这个词通常指一个类的 .h 文件,但是它在 Java 程序员眼里有另外的含义: 一系列不依赖具体实现的方法的定义。

在 Objective-C 里是通过 protocol 来实现抽象接口的。因为历史原因,protocol (作为 Java 接口使用)并没有在 Objective-C 社区里面广泛使用。一个主要原因是大多数的 Apple 开发的代码没有包含它,而几乎所有的开发者都是遵从 Apple 的模式以及指南的。Apple 几乎只是在委托模式下使用 protocol。

但是抽象接口的概念很强大,它计算机科学的历史中就有起源,没有理由不在 Objective-C 中使用。

我们会解释 protocol 的强大力量(用作抽象接口),用具体的例子来解释:把非常糟糕的设计的架构改造为一个良好的可复用的代码。

这个例子是在实现一个 RSS 订阅的阅读器(它可是经常在技术面试中作为一个测试题呢)。

要求很简单明了:把一个远程的 RSS 订阅展示在一个 tableview 中。

一个幼稚的方法是创建一个UITableViewController 的子类,并且把所有的检索订阅数据,解析以及展示的逻辑放在一起,或者说是一个 MVC (Massive View Controller)。这可以跑起来,但是它的设计非常糟糕,不过它足够过一些要求不高的面试了。

A minimal step forward would be to follow the Single Responsibility Principle and create at least 2 components to do the different tasks:

最小的步骤是遵从单一功能原则,创建至少两个组成部分来完成这个任务:

  • 一个 feed 解析器来解析搜集到的结果
  • 一个 feed 阅读器来显示结果

这些类的接口可以是这样的:


@interface ZOCFeedParser : NSObject

@property (nonatomic, weak) id <ZOCFeedParserDelegate> delegate;
@property (nonatomic, strong) NSURL *url;

- (id)initWithURL:(NSURL *)url;

- (BOOL)start;
- (void)stop;

@end

@interface ZOCTableViewController : UITableViewController

- (instancetype)initWithFeedParser:(ZOCFeedParser *)feedParser;

@end

ZOCFeedParser 用一个 NSURL 来初始化来获取 RSS 订阅(在这之下可能会使用 NSXMLParser 和 NSXMLParserDelegate 创建有意义的数据),ZOCTableViewController 会用这个 parser 来进行初始化。 我们希望它显示 parser 接受到的指并且我们用下面的 protocol 实现委托:

@protocol ZOCFeedParserDelegate <NSObject>
@optional
- (void)feedParserDidStart:(ZOCFeedParser *)parser;
- (void)feedParser:(ZOCFeedParser *)parser didParseFeedInfo:(ZOCFeedInfoDTO *)info;
- (void)feedParser:(ZOCFeedParser *)parser didParseFeedItem:(ZOCFeedItemDTO *)item;
- (void)feedParserDidFinish:(ZOCFeedParser *)parser;
- (void)feedParser:(ZOCFeedParser *)parser didFailWithError:(NSError *)error;
@end

用合适的 protocol 来来处理 RSS 非常完美。view controller 会遵从它的公开的接口:

@interface ZOCTableViewController : UITableViewController <ZOCFeedParserDelegate>

最后创建的代码是这样子的:

NSURL *feedURL = [NSURL URLWithString:@"http://bbc.co.uk/feed.rss"];

ZOCFeedParser *feedParser = [[ZOCFeedParser alloc] initWithURL:feedURL];

ZOCTableViewController *tableViewController = [[ZOCTableViewController alloc] initWithFeedParser:feedParser];
feedParser.delegate = tableViewController;

到目前你可能觉得你的代码还是不错的,但是有多少代码是可以有效复用的呢?view controller 只能处理ZOCFeedParser 类型的对象: 从这点来看我们只是把代码分离成了两个组成部分,而没有做任何其他有价值的事情。

view controller 的职责应该是“从上显示一些内容”,但是如果我们只允许传递ZOCFeedParser的话就不是这样的了。这就表现了需要传递给 View controller 一个更泛型的对象的需求。

We modify our feed parser introducing the ZOCFeedParserProtocol protocol (in the ZOCFeedParserProtocol.h file where also ZOCFeedParserDelegate will be).

我们使用 ZOCFeedParserProtocol 这个 protocol (在 ZOCFeedParserProtocol.h 文件里面,同时文件里也有 ZOCFeedParserDelegate)


@protocol ZOCFeedParserProtocol <NSObject>

@property (nonatomic, weak) id <ZOCFeedParserDelegate> delegate;
@property (nonatomic, strong) NSURL *url;

- (BOOL)start;
- (void)stop;

@end

@protocol ZOCFeedParserDelegate <NSObject>
@optional
- (void)feedParserDidStart:(id<ZOCFeedParserProtocol>)parser;
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didParseFeedInfo:(ZOCFeedInfoDTO *)info;
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didParseFeedItem:(ZOCFeedItemDTO *)item;
- (void)feedParserDidFinish:(id<ZOCFeedParserProtocol>)parser;
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didFailWithError:(NSError *)error;
@end

注意这个代理 protocol 现在处理响应我们新的 protocol 而且 ZOCFeedParser 的接口文件更加精炼了:


@interface ZOCFeedParser : NSObject <ZOCFeedParserProtocol>

- (id)initWithURL:(NSURL *)url;

@end

因为 ZOCFeedParser实现了 ZOCFeedParserProtocol,它需要实现所有需要的方法。 从这点来看 view controller 可以接受任何实现这个新的 protocol 的对象,确保所有的对象会响应从startstop的方法,而且它会通过 delegate 的属性来提供信息。所有的 view controller 只需要知道相关对象并且不需要知道实现的细节。

@interface ZOCTableViewController : UITableViewController <ZOCFeedParserDelegate>

- (instancetype)initWithFeedParser:(id<ZOCFeedParserProtocol>)feedParser;

@end

上面的代码片段的改变看起来不多,但是有了一个巨大的提升。view controller 是面向一个协议而不是具体的实现的。这带来了以下的优点:

  • view controller 可以通过 delegate 属性带来的信息的任意对象,可以是 RSS 远程解析器,或者本地解析器,或是一个读取其他远程或者本地数据的服务
  • ZOCFeedParserZOCFeedParserDelegate 可以被其他组成部分复用
  • ZOCViewController (UI逻辑部分)可以被复用
  • 测试更简单了,因为可以用 mock 对象来达到 protocol 预期的效果

当实现一个 protocol 你总应该坚持里氏替换原则。这个原则让你应该取代任意接口(也就是Objective-C里的的"protocol")实现,而不用改变客户端或者相关实现。

此外这也意味着你的 protocol 不应该关注实现类的细节,更加认真地设计你的 protocol 的抽象表述的时候,需要注意它和底层实现是不相干的,协议是暴露给使用者的抽象概念。

任何可以在未来复用的设计意味着可以提高代码质量,同时也是程序员的目标。是否这样设计代码,就是大师和菜鸟的区别。

最后的代码可以在这找到。here.

NSNotification

当你定义你自己的 NSNotification 的时候你应该把你的通知的名字定义为一个字符串常量,就像你暴露给其他类的其他字符串常量一样。你应该在公开的接口文件中将其声明为 extern 的, 并且在对应的实现文件里面定义。

因为你在头文件中暴露了符号,所以你应该按照统一的命名空间前缀法则,用类名前缀作为这个通知名字的前缀。

同时,用一个 Did/Will 这样的动词以及用 "Notifications" 后缀来命名这个通知也是一个好的实践。

// Foo.h
extern NSString * const ZOCFooDidBecomeBarNotification

// Foo.m
NSString * const ZOCFooDidBecomeBarNotification = @"ZOCFooDidBecomeBarNotification";