这里有一些和风格指南有关的苹果的文档： - [The Objective-C Programming Language](http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/ObjectiveC/Introduction/introObjectiveC.html) - [Cocoa Fundamentals Guide](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CocoaFundamentals/Introduction/Introduction.html) - [Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html) - [iOS App Programming Guide](http://developer.apple.com/library/ios/#documentation/iphone/conceptual/iphoneosprogrammingguide/Introduction/Introduction.html) - [Apple Objective-C conventions](https://developer.apple.com/library/ios/documentation/cocoa/conceptual/ProgrammingWithObjectiveC/Conventions/Conventions.html): 来自苹果的代码约定 其他： - [Objcetive-Clean](http://objclean.com): an attempt to write a standard for writing Objective-C code with Xcode integration; - [Uncrustify](http://uncrustify.sourceforge.net/): source code beautifier. ## 其他的 Objective-C 风格指南 这里有一些和风格指南有关的苹果的文档。如果有一些本书没有涉猎的地方，你或许能在这些之中找到详细说明。 来自 Apple 的： - [The Objective-C Programming Language](http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/ObjectiveC/Introduction/introObjectiveC.html) - [Cocoa Fundamentals Guide](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CocoaFundamentals/Introduction/Introduction.html) - [Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html) - [iOS App Programming Guide](http://developer.apple.com/library/ios/#documentation/iphone/conceptual/iphoneosprogrammingguide/Introduction/Introduction.html) 来自社区的： - [NYTimes Objective-C Style Guide](https://github.com/NYTimes/objetive-c-style-guide) - [Google](http://google-styleguide.googlecode.com/svn/trunk/objcguide.xml) - [GitHub](https://github.com/github/objective-c-conventions) - [Adium](https://trac.adium.im/wiki/CodingStyle) - [Sam Soffes](https://gist.github.com/soffes/812796) - [CocoaDevCentral](http://cocoadevcentral.com/articles/000082.php) - [Luke Redpath](http://lukeredpath.co.uk/blog/my-objective-c-style-guide.html) - [Marcus Zarra](http://www.cimgf.com/zds-code-style-guide/) - [Ray Wenderlich](https://github.com/raywenderlich/objective-c-style-guide)

# Aspect Oriented Programming 面向切面编程 Aspect Oriented Programming (AOP，面向切面编程) 在 Objective-C 社区内没有那么有名，但是 AOP 在运行时可以有巨大威力。 但是因为没有事实上的标准，Apple 也没有开箱即用的提供，也显得不重要，开发者都不怎么考虑它。 引用 [Aspect Oriented Programming](http://en.wikipedia.org/wiki/Aspect-oriented_programming) 维基页面: > An aspect can alter the behavior of the base code (the non-aspect part of a program) by applying advice (additional behavior) at various join points (points in a program) specified in a quantification or query called a pointcut (that detects whether a given join point matches). (一个切面可以通过在多个 join points 中 实行 advice 改变基础代码的行为(程序的非切面的部分) ) 在 Objective-C 的世界里，这意味着使用运行时的特性来为 _切面_ 增加适合的代码。通过切面增加的行为可以是： - 在类的特定方法调用前运行特定的代码 - 在类的特定方法调用后运行特定的代码 - 增加代码来替代原来的类的方法的实现 有很多方法可以达成这些目的，但是我们没有深入挖掘，不过它们主要都是利用了运行时。 [Peter Steinberger](https://twitter.com/steipete) 写了一个库，[Aspects](https://github.com/steipete/Aspects) 完美地适配了 AOP 的思路。我们发现它值得信赖以及设计得非常优秀，所以我们就在这边作为一个简单的例子。 对于所有的 AOP库，这个库用运行时做了一些非常酷的魔法，可以替换或者增加一些方法（比 method swizzling 技术更有技巧性） Aspect 的 API 有趣并且非常强大： ~~~ + (id<AspectToken>)aspect_hookSelector:(SEL)selector withOptions:(AspectOptions)options usingBlock:(id)block error:(NSError **)error; - (id<AspectToken>)aspect_hookSelector:(SEL)selector withOptions:(AspectOptions)options usingBlock:(id)block error:(NSError **)error; ~~~ 比如，下面的代码会对于执行 `MyClass` 类的 `myMethod:` (实例或者类的方法) 执行块参数。 ~~~ [MyClass aspect_hookSelector:@selector(myMethod:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) { ... } error:nil]; ~~~ 换一句话说：这个代码可以让在 `@selector` 参数对应的方法调用之后，在一个 `MyClass` 的对象上（或者在一个类本身，如果方法是一个类方法的话）执行 block 参数。 我们为 `MyClass` 类的 `myMethod:` 方法增加了切面。 通常 AOP 用来实现横向切面的完美的适用的地方是统计和日志。 下面的例子里面，我们会用AOP用来进行统计。统计是iOS项目里面一个热门的特性，有很多选择比如 Google Analytics, Flurry, MixPanel, 等等. 大部分统计框架都有教程来指导如何追踪特定的界面和事件，包括在每一个类里写几行代码。 在 Ray Wenderlich 的博客里有 [文章](http://www.raywenderlich.com/53459/google-analytics-ios) 和一些示例代码，通过在你的 view controller 里面加入 [Google Analytics](https://developers.google.com/analytics/devguides/collection/ios/) 进行统计。 ~~~ - (void)logButtonPress:(UIButton *)button { id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker]; [tracker send:[[GAIDictionaryBuilder createEventWithCategory:@"UX" action:@"touch" label:[button.titleLabel text] value:nil] build]]; } ~~~ 上面的代码在按钮点击的时候发送了特定的上下文事件。但是当你想追踪屏幕的时候会更糟糕。 ~~~ - (void)viewDidAppear:(BOOL)animated { [super viewDidAppear:animated]; id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker]; [tracker set:kGAIScreenName value:@"Stopwatch"]; [tracker send:[[GAIDictionaryBuilder createAppView] build]]; } ~~~ 对于大部分有经验的iOS工程师，这看起来不是很好的代码。我们让 view controller 变得更糟糕了。因为我们加入了统计事件的代码，但是它不是 view controller 的职能。你可以反驳，因为你通常有特定的对象来负责统计追踪，并且你将代码注入了 view controller ，但是无论你隐藏逻辑，问题仍然存在 ：你最后还是在`viewDidAppear:` 后插入了代码。 你可以用 AOP 来追踪屏幕视图来修改 `viewDidAppear:` 方法。同时，我们可以用同样的方法，来在其他感兴趣的方法里面加入事件追踪，比如任何用户点击按钮的时候（比如频繁地调用IBAction） 这个方法是干净并且非侵入性的： - 这个 view controller 不会被不属于它的代码污染 - 为所有加入到我们代码的切面定义一个 SPOC 文件 (single point of customization)提供了可能 - SPOC 应该在 App 刚开始启动的时候就加入切面 - 公司负责统计的团队通常会提供统计文档，罗列出需要追踪的事件。这个文档可以很容易映射到一个 SPOC 文件。 - 追踪逻辑抽象化之后，扩展到很多其他统计框架会很方便 - 对于屏幕视图，对于需要定义 selector 的方法，只需要在 SPOC 文件修改相关的类（相关的切面会加入到 `viewDidAppear:` 方法）。如果要同时发送屏幕视图和时间，一个追踪的 label 和其他元信息来提供额外数据（取决于统计提供方） 我们可能希望一个 SPOC 文件类似下面的（同样的一个 .plist 文件会适配） ~~~ NSDictionary *analyticsConfiguration() { return @{ @"trackedScreens" : @[ @{ @"class" : @"ZOCMainViewController", @"label" : @"Main screen" } ], @"trackedEvents" : @[ @{ @"class" : @"ZOCMainViewController", @"selector" : @"loginViewFetchedUserInfo:user:", @"label" : @"Login with Facebook" }, @{ @"class" : @"ZOCMainViewController", @"selector" : @"loginViewShowingLoggedOutUser:", @"label" : @"Logout with Facebook" }, @{ @"class" : @"ZOCMainViewController", @"selector" : @"loginView:handleError:", @"label" : @"Login error with Facebook" }, @{ @"class" : @"ZOCMainViewController", @"selector" : @"shareButtonPressed:", @"label" : @"Share button" } ] }; } ~~~ 这个提及的架构在 Github 的[EF Education First](https://github.com/ef-ctx/JohnnyEnglish/blob/master/CTXUserActivityTrackingManager.m) 中托管 ~~~ - (void)setupWithConfiguration:(NSDictionary *)configuration { // screen views tracking for (NSDictionary *trackedScreen in configuration[@"trackedScreens"]) { Class clazz = NSClassFromString(trackedScreen[@"class"]); [clazz aspect_hookSelector:@selector(viewDidAppear:) withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) { dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{ NSString *viewName = trackedScreen[@"label"]; [tracker trackScreenHitWithName:viewName]; }); }]; } // events tracking for (NSDictionary *trackedEvents in configuration[@"trackedEvents"]) { Class clazz = NSClassFromString(trackedEvents[@"class"]); SEL selektor = NSSelectorFromString(trackedEvents[@"selector"]); [clazz aspect_hookSelector:selektor withOptions:AspectPositionAfter usingBlock:^(id<AspectInfo> aspectInfo) { dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{ UserActivityButtonPressedEvent *buttonPressEvent = [UserActivityButtonPressedEvent eventWithLabel:trackedEvents[@"label"]]; [tracker trackEvent:buttonPressEvent]; }); }]; } } ~~~

委托是 Apple 的框架里面使用广泛的模式，同时它是一个重要的 四人帮的书“设计模式”中的模式。委托模式是单向的，消息的发送方（委托方）需要知道接收方（委托），反过来就不是了。对象之间没有多少耦合，因为发送方只要知道它的委托实现了对应的 protocol。 本质上，委托模式只需要委托提供一些回调方法，就是说委托实现了一系列空返回值的方法。 不幸的是 Apple 的 API 并没有尊重这个原则，开发者也效仿 Apple 进入了歧途。一个典型的例子是 [UITableViewDelegate](https://developer.apple.com/library/ios/documentation/uikit/reference/UITableViewDelegate_Protocol/Reference/Reference.html) 协议。 一些有 void 返回类型的方法就像回调 ~~~ - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath; - (void)tableView:(UITableView *)tableView didHighlightRowAtIndexPath:(NSIndexPath *)indexPath; ~~~ 但是其他的不是 ~~~ - (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath; - (BOOL)tableView:(UITableView *)tableView canPerformAction:(SEL)action forRowAtIndexPath:(NSIndexPath *)indexPath withSender:(id)sender; ~~~ 当委托者询问委托对象一些信息的时候，这就暗示着信息是从委托对象流向委托者，而不会反过来。 这个概念就和委托模式有些不同，它是一个另外的模式：数据源。 可能有人会说 Apple 有一个 [UITableViewDataSouce](https://developer.apple.com/library/ios/documentation/uikit/reference/UITableViewDataSource_Protocol/Reference/Reference.html) protocol 来做这个（虽然使用委托模式的名字），但是实际上它的方法是用来提供真实的数据应该如何被展示的信息的。 ~~~ - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath; - (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView; ~~~ 此外，以上两个方法 Apple 混合了展示层和数据层，这显的非常糟糕，但是很少的开发者感到糟糕。而且我们在这里把空返回值和非空返回值的方法都天真地叫做委托方法。 为了分离概念，我们应该这样做： - 委托模式：事件发生的时候，委托者需要通知委托 - 数据源模式: 委托方需要从数据源对象拉取数据 这个是实际的例子： ~~~ @class ZOCSignUpViewController; @protocol ZOCSignUpViewControllerDelegate <NSObject> - (void)signUpViewControllerDidPressSignUpButton:(ZOCSignUpViewController *)controller; @end @protocol ZOCSignUpViewControllerDataSource <NSObject> - (ZOCUserCredentials *)credentialsForSignUpViewController:(ZOCSignUpViewController *)controller; @end @protocol ZOCSignUpViewControllerDataSource <NSObject> @interface ZOCSignUpViewController : UIViewController @property (nonatomic, weak) id<ZOCSignUpViewControllerDelegate> delegate; @property (nonatomic, weak) id<ZOCSignUpViewControllerDataSource> dataSource; @end ~~~ 在上面的例子里面，委托方法需要总是有一个调用方作为第一个参数，否则委托对象可能被不能区别不同的委托者的实例。此外，如果调用者没有被传递到委托对象，那么就没有办法让一个委托对象处理两个不同的委托者了。所以，下面这样的方法就是人神共愤的： ~~~ - (void)calculatorDidCalculateValue:(CGFloat)value; ~~~ 默认情况下，委托对象需要实现 protocol 的方法。可以用`@required` 和 `@optional` 关键字来标记方法是否是必要的还是可选的。 ~~~ @protocol ZOCSignUpViewControllerDelegate <NSObject> @required - (void)signUpViewController:(ZOCSignUpViewController *)controller didProvideSignUpInfo:(NSDictionary *); @optional - (void)signUpViewControllerDidPressSignUpButton:(ZOCSignUpViewController *)controller; @end ~~~ 对于可选的方法，委托者必须在发送消息前检查委托是否确实实现了特定的方法（否则会Crash）： ~~~ if ([self.delegate respondsToSelector:@selector(signUpViewControllerDidPressSignUpButton:)]) { [self.delegate signUpViewControllerDidPressSignUpButton:self]; } ~~~ ## 继承 有时候你可能需要重载委托方法。考虑有两个 UIViewController 子类的情况：UIViewControllerA 和 UIViewControllerB，有下面的类继承关系。 `UIViewControllerB < UIViewControllerA < UIViewController` `UIViewControllerA` conforms to `UITableViewDelegate` and implements `- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath`. `UIViewControllerA` 遵从 `UITableViewDelegate` 并且实现了 `- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath`. 你可能会想要提供一个和 `UIViewControllerB` 不同的实现。一个实现可能是这样子的： ~~~ - (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath { CGFloat retVal = 0; if ([super respondsToSelector:@selector(tableView:heightForRowAtIndexPath:)]) { retVal = [super tableView:self.tableView heightForRowAtIndexPath:indexPath]; } return retVal + 10.0f; } ~~~ 但是如果超类(`UIViewControllerA`)没有实现这个方法呢？ 调用过程 ~~~ [super respondsToSelector:@selector(tableView:heightForRowAtIndexPath:)] ~~~ 会用 NSObject 的实现，寻找，在 `self` 的上下文中无疑有它的实现，但是 app 会在下一行 Crash 并且报下面的错： ~~~ *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[UIViewControllerB tableView:heightForRowAtIndexPath:]: unrecognized selector sent to instance 0x8d82820' ~~~ 这种情况下我们需要来询问特定的类实例是否可以响应对应的 selector。下面的代码提供了一个小技巧： ~~~ - (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath { CGFloat retVal = 0; if ([[UIViewControllerA class] instancesRespondToSelector:@selector(tableView:heightForRowAtIndexPath:)]) { retVal = [super tableView:self.tableView heightForRowAtIndexPath:indexPath]; } return retVal + 10.0f; } ~~~ 就像上面的丑陋的代码，一个委托方法也比重载方法好。 ## 多重委托 多重委托是一个非常基础的概念，但是，大多数开发者对此非常不熟悉而使用 NSNotifications。就像你可能注意到的，委托和数据源是对象之间的通讯模式，但是只涉及两个对象：委托者和委托。 数据源模式强制一对一的关系，发送者来像一个并且只是一个对象来请求信息。但是委托模式不一样，它可以完美得有多个委托来等待回调操作。 至少两个对象需要接收来自特定委托者的回调，并且后一个需要知道所有的委托，这个方法更好的适用于分布式系统并且更加广泛用于大多数软件的复杂信息流传递。 多重委托可以用很多方式实现，读者当然喜欢找到一个好的个人实现，一个非常灵巧的多重委托实现可以参考 Luca Bernardi 在他的 [LBDelegateMatrioska](https://github.com/lukabernardi/LBDelegateMatrioska) 的原理。 一个基本的实现在下面给出。Cocoa 在数据结构中使用弱引用来避免引用循环，我们使用一个类来作为委托者持有委托对象的弱引用。 ~~~ @interface ZOCWeakObject : NSObject @property (nonatomic, weak, readonly) id object; + (instancetype)weakObjectWithObject:(id)object; - (instancetype)initWithObject:(id)object; @end ~~~ ~~~ @interface ZOCWeakObject () @property (nonatomic, weak) id object; @end @implementation ZOCWeakObject + (instancetype)weakObjectWithObject:(id)object { return [[[self class] alloc] initWithObject:object]; } - (instancetype)initWithObject:(id)object { if ((self = [super init])) { _object = object; } return self; } - (BOOL)isEqual:(id)object { if (self == object) { return YES; } if (![object isKindOfClass:[object class]]) { return NO; } return [self isEqualToWeakObject:(ZOCWeakObject *)object]; } - (BOOL)isEqualToWeakObject:(ZOCWeakObject *)object { if (!object) { return NO; } BOOL objectsMatch = [self.object isEqual:object.object]; return objectsMatch; } - (NSUInteger)hash { return [self.object hash]; } @end ~~~ 一个简单的使用 weak 对象来完成多重引用的组成部分： ~~~ @protocol ZOCServiceDelegate <NSObject> @optional - (void)generalService:(ZOCGeneralService *)service didRetrieveEntries:(NSArray *)entries; @end @interface ZOCGeneralService : NSObject - (void)registerDelegate:(id<ZOCServiceDelegate>)delegate; - (void)deregisterDelegate:(id<ZOCServiceDelegate>)delegate; @end @interface ZOCGeneralService () @property (nonatomic, strong) NSMutableSet *delegates; @end ~~~ ~~~ @implementation ZOCGeneralService - (void)registerDelegate:(id<ZOCServiceDelegate>)delegate { if ([delegate conformsToProtocol:@protocol(ZOCServiceDelegate)]) { [self.delegates addObject:[[ZOCWeakObject alloc] initWithObject:delegate]]; } } - (void)deregisterDelegate:(id<ZOCServiceDelegate>)delegate { if ([delegate conformsToProtocol:@protocol(ZOCServiceDelegate)]) { [self.delegates removeObject:[[ZOCWeakObject alloc] initWithObject:delegate]]; } } - (void)_notifyDelegates { ... for (ZOCWeakObject *object in self.delegates) { if (object.object) { if ([object.object respondsToSelector:@selector(generalService:didRetrieveEntries:)]) { [object.object generalService:self didRetrieveEntries:entries]; } } } } @end ~~~ 在 `registerDelegate:` 和 `deregisterDelegate:` 方法的帮助下，连接/解除组成部分很简单：如果委托对象不需要接收委托者的回调，仅仅需要'unsubscribe'. 这在一些不同的 view 等待同一个回调来更新界面展示的时候很有用：如果 view 只是暂时隐藏（但是仍然存在），它可以仅仅需要取消对回调的订阅。

Blocks 是 Objective-C 版本的 lambda 或者 closure（闭包）。 使用 block 定义异步接口: ~~~ - (void)downloadObjectsAtPath:(NSString *)path completion:(void(^)(NSArray *objects, NSError *error))completion; ~~~ 当你定义一个类似上面的接口的时候，尽量使用一个单独的 block 作为接口的最后一个参数。把需要提供的数据和错误信息整合到一个单独 block 中，比分别提供成功和失败的 block 要好。 以下是你应该这样做的原因： - 通常这成功处理和失败处理会共享一些代码（比如让一个进度条或者提示消失）； - Apple 也是这样做的，与平台一致能够带来一些潜在的好处； - block 通常会有多行代码，如果不是在最后一个参数的话会打破调用点； - 使用多个 block 作为参数可能会让调用看起来显得很笨拙，并且增加了复杂性。 看上面的方法，完成处理的 block 的参数很常见：第一个参数是调用者希望获取的数据，第二个是错误相关的信息。这里需要遵循以下两点： - 若 `objects` 不为 nil，则 `error` 必须为 nil - 若 `objects` 为 nil，则 `error` 必须不为 nil 因为调用者更关心的是实际的数据，就像这样： ~~~ - (void)downloadObjectsAtPath:(NSString *)path completion:(void(^)(NSArray *objects, NSError *error))completion { if (objects) { // do something with the data } else { // some error occurred, 'error' variable should not be nil by contract } } ~~~ 此外，Apple 提供的一些同步接口在成功状态下向 error 参数（如果非 NULL) 写入了垃圾值，所以检查 error 的值可能出现问题。 ## 深入 Blocks 一些关键点： - block 是在栈上创建的 - block 可以复制到堆上 - block 有自己的私有的栈变量（以及指针）的常量复制 - 可变的栈上的变量和指针必须用 __block 关键字声明 如果 block 没有在其他地方被保持，那么它会随着栈生存并且当栈帧（stack frame）返回的时候消失。当在栈上的时候，一个 block 对访问的任何内容不会有影响。如果 block 需要在栈帧返回的时候存在，它们需要明确地被复制到堆上，这样，block 会像其他 Cocoa 对象一样增加引用计数。当它们被复制的时候，它会带着它们的捕获作用域一起，retain 他们所有引用的对象。如果一个 block指向一个栈变量或者指针，那么这个block初始化的时候它会有一份声明为 const 的副本，所以对它们赋值是没用的。当一个 block 被复制后，`__block` 声明的栈变量的引用被复制到了堆里，复制之后栈上的以及产生的堆上的 block 都会引用这个堆上的变量。 用 LLDB 来展示 block 是这样子的：  最重要的事情是 `__block` 声明的变量和指针在 block 里面是作为显示操作真实值/对象的结构来对待的。 block 在 Objective-C 里面被当作一等公民对待：他们有一个 `isa` 指针，一个类也是用 `isa` 指针来访问 Objective-C 运行时来访问方法和存储数据的。在非 ARC 环境肯定会把它搞得很糟糕，并且悬挂指针会导致 Crash。`__block` 仅仅对 block 内的变量起作用，它只是简单地告诉 block： > 嗨，这个指针或者原始的类型依赖它们在的栈。请用一个栈上的新变量来引用它。我是说，请对它进行双重解引用，不要 retain 它。谢谢，哥们。 如果在定义之后但是 block 没有被调用前，对象被释放了，那么 block 的执行会导致 Crash。 `__block` 变量不会在 block 中被持有，最后... 指针、引用、解引用以及引用计数变得一团糟。 ## self 的循环引用 当使用代码块和异步分发的时候，要注意避免引用循环。 总是使用 `weak` 引用会导致引用循环。 此外，把持有 blocks 的属性设置为 nil (比如 `self.completionBlock = nil`) 是一个好的实践。它会打破 blocks 捕获的作用域带来的引用循环。 **例子:** ~~~ __weak __typeof(self) weakSelf = self; [self executeBlock:^(NSData *data, NSError *error) { [weakSelf doSomethingWithData:data]; }]; ~~~ **不要这样做:** ~~~ [self executeBlock:^(NSData *data, NSError *error) { [self doSomethingWithData:data]; }]; ~~~ **多个语句的例子:** ~~~ __weak __typeof(self)weakSelf = self; [self executeBlock:^(NSData *data, NSError *error) { __strong __typeof(weakSelf) strongSelf = weakSelf; if (strongSelf) { [strongSelf doSomethingWithData:data]; [strongSelf doSomethingWithData:data]; } }]; ~~~ **不要这样做:** ~~~ __weak __typeof(self)weakSelf = self; [self executeBlock:^(NSData *data, NSError *error) { [weakSelf doSomethingWithData:data]; [weakSelf doSomethingWithData:data]; }]; ~~~ 你应该把这两行代码作为 snippet 加到 Xcode 里面并且总是这样使用它们。 ~~~ __weak __typeof(self)weakSelf = self; __strong __typeof(weakSelf)strongSelf = weakSelf; ~~~ 这里我们来讨论下 block 里面的 self 的 `__weak` 和 `__strong` 限定词的一些微妙的地方。简而言之，我们可以参考 self 在 block 里面的三种不同情况。 1. 直接在 block 里面使用关键词 self 1. 在 block 外定义一个 `__weak` 的 引用到 self，并且在 block 里面使用这个弱引用 1. 在 block 外定义一个 `__weak` 的 引用到 self，并在在 block 内部通过这个弱引用定义一个 `__strong` 的引用。 **1. 直接在 block 里面使用关键词 `self`** 如果我们直接在 block 里面用 self 关键字，对象会在 block 的定义时候被 retain，（实际上 block 是 [copied](https://developer.apple.com/library/ios/documentation/cocoa/conceptual/Blocks/Articles/bxVariables.html#//apple_ref/doc/uid/TP40007502-CH6-SW4) 但是为了简单我们可以忽略这个）。一个 const 的对 self 的引用在 block 里面有自己的位置并且它会影响对象的引用计数。如果 block 被其他 class 或者/并且传送过去了，我们可能想要 retain self 就像其他被 block 使用的对象，从他们需要被block执行 ~~~ dispatch_block_t completionBlock = ^{ NSLog(@"%@", self); } MyViewController *myController = [[MyViewController alloc] init...]; [self presentViewController:myController animated:YES completion:completionHandler]; ~~~ 不是很麻烦的事情。但是, 当 block 被 self 在一个属性 retain（就像下面的例子）呢 ~~~ self.completionHandler = ^{ NSLog(@"%@", self); } MyViewController *myController = [[MyViewController alloc] init...]; [self presentViewController:myController animated:YES completion:self.completionHandler]; ~~~ 这就是有名的 retain cycle, 并且我们通常应该避免它。这种情况下我们收到 CLANG 的警告： ~~~ Capturing 'self' strongly in this block is likely to lead to a retain cycle （在 block 里面发现了 `self` 的强引用，可能会导致循环引用） ~~~ 所以可以用 `weak` 修饰 **2. 在 block 外定义一个 `__weak` 的 引用到 self，并且在 block 里面使用这个弱引用** 这样会避免循环引用，也是我们通常在 block 已经被 self 的 property 属性里面 retain 的时候会做的。 ~~~ __weak typeof(self) weakSelf = self; self.completionHandler = ^{ NSLog(@"%@", weakSelf); }; MyViewController *myController = [[MyViewController alloc] init...]; [self presentViewController:myController animated:YES completion:self.completionHandler]; ~~~ 这个情况下 block 没有 retain 对象并且对象在属性里面 retain 了 block 。所以这样我们能保证了安全的访问 self。 不过糟糕的是，它可能被设置成 nil 的。问题是：如果和让 self 在 block 里面安全地被销毁。 举个例子， block 被一个对象复制到了另外一个（比如 myControler）作为属性赋值的结果。之前的对象在可能在被复制的 block 有机会执行被销毁。 下面的更有意思。 **3. 在 block 外定义一个 `__weak` 的 引用到 self，并在在 block 内部通过这个弱引用定义一个 `__strong` 的引用** 你可能会想，首先，这是避免 retain cycle 警告的一个技巧。然而不是，这个到 self 的强引用在 _block 的执行时间_　被创建。当 block 在定义的时候， block 如果使用 self 的时候，就会 retain 了 self 对象。 [Apple 文档](http://developer.apple.com/library/mac/#releasenotes/ObjectiveC/RN-TransitioningToARC/Introduction/Introduction.html) 中表示 "为了 non-trivial cycles ，你应该这样" ： ~~~ MyViewController *myController = [[MyViewController alloc] init...]; // ... MyViewController * __weak weakMyController = myController; myController.completionHandler = ^(NSInteger result) { MyViewController *strongMyController = weakMyController; if (strongMyController) { // ... [strongMyController dismissViewControllerAnimated:YES completion:nil]; // ... } else { // Probably nothing... } }; ~~~ 首先，我觉得这个例子看起来是错误的。如果 block 本身被 completionHandler 属性里面 retain 了，那么 self 如何被 delloc 和在 block 之外赋值为 nil 呢? completionHandler 属性可以被声明为 `assign` 或者 `unsafe_unretained` 的，来允许对象在 block 被传递之后被销毁。 我不能理解这样做的理由，如果其他对象需要这个对象（self），block 被传递的时候应该 retain 对象，所以 block 应该不被作为属性存储。这种情况下不应该用 `__weak`/`__strong` 总之，其他情况下，希望 weakSelf 变成 nil 的话，就像第二种情况解释那么写（在 block 之外定义一个弱应用并且在 block 里面使用）。 还有，Apple的 "trivial block" 是什么呢。我们的理解是 trivial block 是一个不被传送的 block ，它在一个良好定义和控制的作用域里面，weak 修饰只是为了避免循环引用。 虽然有 Kazuki Sakamoto 和 Tomohiko Furumoto) 讨论的 [一](http://dhoerl.wordpress.com/2013/04/23/i-finally-figured-out-weakself-and-strongself/)[些](http://blog.random-ideas.net/?p=160)[的](http://stackoverflow.com/questions/7904568/disappearing-reference-to-self-in-a-block-under-arc)[在线](http://stackoverflow.com/questions/12218767/objective-c-blocks-and-memory-management)[参考](https://github.com/AFNetworking/AFNetworking/issues/807), [Matt Galloway](https://twitter.com/mattjgalloway) 的 ([Effective Objective-C 2.0](http://www.effectiveobjectivec.com/) 和 [Pro Multithreading and Memory Management for iOS and OS X](http://www.amazon.it/Pro-Multithreading-Memory-Management-Ios/dp/1430241160) ，大多数开发者始终没有弄清楚概念。 在 block 内用强引用的优点是，抢占执行的时候的鲁棒性。看上面的三个例子，在 block 执行的时候 **1. 直接在 block 里面使用关键词 `self`** 如果 block 被属性 retain，self 和 block 之间会有一个循环引用并且它们不会再被释放。如果 block 被传送并且被其他的对象 copy 了，self 在每一个 copy 里面被 retain **2. 在 block 外定义一个 `__weak` 的 引用到 self，并且在 block 里面使用这个弱引用** 没有循环引用的时候，block 是否被 retain 或者是一个属性都没关系。如果 block 被传递或者 copy 了，在执行的时候，weakSelf 可能会变成 nil。 block 的执行可以抢占，并且后来的对 weakSelf 的不同调用可以导致不同的值(比如，在 一个特定的执行 weakSelf 可能赋值为 nil ) ~~~ __weak typeof(self) weakSelf = self; dispatch_block_t block = ^{ [weakSelf doSomething]; // weakSelf != nil // preemption, weakSelf turned nil [weakSelf doSomethingElse]; // weakSelf == nil }; ~~~ ** 3. 在 block 外定义一个 `__weak` 的 引用到 self，并在在 block 内部通过这个弱引用定义一个 `__strong` 的引用。** 不论管 block 是否被 retain 或者是一个属性，这样也不会有循环引用。如果 block 被传递到其他对象并且被复制了，执行的时候，weakSelf 可能被nil，因为强引用被复制并且不会变成nil的时候，我们确保对象 在 block 调用的完整周期里面被 retain了，如果抢占发生了，随后的对 strongSelf 的执行会继续并且会产生一样的值。如果 strongSelf 的执行到 nil，那么在 block 不能正确执行前已经返回了。 ~~~ __weak typeof(self) weakSelf = self; myObj.myBlock = ^{ __strong typeof(self) strongSelf = weakSelf; if (strongSelf) { [strongSelf doSomething]; // strongSelf != nil // preemption, strongSelf still not nil（抢占的时候，strongSelf 还是非 nil 的) [strongSelf doSomethingElse]; // strongSelf != nil } else { // Probably nothing... return; } }; ~~~ 在一个 ARC 的环境中，如果尝试用 `->`符号来表示，编译器会警告一个错误： ~~~ Dereferencing a __weak pointer is not allowed due to possible null value caused by race condition, assign it to a strong variable first. (对一个 __weak 指针的解引用不允许的，因为可能在竞态条件里面变成 null, 所以先把他定义成 strong 的属性) ~~~ 可以用下面的代码展示 ~~~ __weak typeof(self) weakSelf = self; myObj.myBlock = ^{ id localVal = weakSelf->someIVar; }; ~~~ 在最后【疑问】 - **1**: 只能在 block 不是作为一个 property 的时候使用，否则会导致 retain cycle。 - **2**: 当 block 被声明为一个 property 的时候使用。 - **Case 3**: 和并发执行有关。当涉及异步的服务的时候，block 可以在之后被执行，并且不会发生关于 self 是否存在的问题。

对象之间需要通信，这也是所有软件的基础。再非凡的软件也需要通过对象通信来完成复杂的目标。本章将深入讨论一些设计概念，以及如何依据这些概念来设计出良好的架构。

当它需要的时候，注释应该用来解释特定的代码做了什么。所有的注释必须被持续维护或者干脆就删除。 块注释应该被避免，代码本身应该尽可能就像文档一样表示意图，只需要很少的打断注释 _例外： 这不能适用于用来产生文档的注释_ ### 头文档 一个类的文档应该只在 .h 文件里用 Doxygen/AppleDoc 的语法书写。 方法和属性都应该提供文档。 **例子: ** ~~~ /** * Designated initializer. * * @param store The store for CRUD operations. * @param searchService The search service used to query the store. * * @return A ZOCCRUDOperationsStore object. */ - (instancetype)initWithOperationsStore:(id<ZOCGenericStoreProtocol>)store searchService:(id<ZOCGenericSearchServiceProtocol>)searchService; ~~~

所有重要的方法，接口，分类以及协议定义应该有伴随的注释来解释它们的用途以及如何使用。更多的例子可以看 Google 代码风格指南 [File and Declaration Comments](http://google-styleguide.googlecode.com/svn/trunk/objcguide.xml#File_Comments)。 简而言之：有长的和短的两种字符串文档。 短文档适用于单行的文件，包括注释斜杠。它适合简短的函数，特别是（但不仅仅是）非 public 的 API： ~~~ // Return a user-readable form of a Frobnozz, html-escaped. ~~~ 文本应该用一个动词 ("return") 而不是 "returns" 这样的描述。 如果描述超出一行，你应该用长的字符串文档: 一行斜杠和两个星号来开始块文档 (/**, 之后是总结的一句话，可以用句号、问号或者感叹号结尾，然后空一行，在和第一句话对齐写下剩下的注释，然后用一个 (*/)来结束。 ~~~ /** This comment serves to demonstrate the format of a docstring. Note that the summary line is always at most one line long, and after the opening block comment, and each line of text is preceded by a single space. */ ~~~ 一个函数必须有一个字符串文档，除非它符合下面的所有条件： - 非公开 - 很短 - 显而易见 字符串文档应该描述函数的调用符号和语义，而不是它如何实现。

编译器是一个机器人，它会标记你代码中被 Clang 规则定义为错误的地方。但是，你总是比 Clang 更聪明。通常，你会发现一些讨厌的代码 会导致这个问题，而且不论怎么做，你都解决不了。你可以这样明确一个错误： ~~~ - (NSInteger)divide:(NSInteger)dividend by:(NSInteger)divisor { #error Whoa, buddy, you need to check for zero here! return (dividend / divisor); } ~~~ 类似的，你可以这样标明一个 警告 ~~~ - (float)divide:(float)dividend by:(float)divisor { #warning Dude, don't compare floating point numbers like this! if (divisor != 0.0) { return (dividend / divisor); } else { return NAN; } } ~~~

## Pragma Mark `#pragma mark -` 是一个在类内部组织代码并且帮助你分组方法实现的好办法。 我们建议使用 `#pragma mark -` 来分离: - 不同功能组的方法 - protocols 的实现 - 对父类方法的重写 ~~~ - (void)dealloc { /* ... */ } - (instancetype)init { /* ... */ } #pragma mark - View Lifecycle （View 的生命周期） - (void)viewDidLoad { /* ... */ } - (void)viewWillAppear:(BOOL)animated { /* ... */ } - (void)didReceiveMemoryWarning { /* ... */ } #pragma mark - Custom Accessors （自定义访问器） - (void)setCustomProperty:(id)value { /* ... */ } - (id)customProperty { /* ... */ } #pragma mark - IBActions - (IBAction)submitData:(id)sender { /* ... */ } #pragma mark - Public - (void)publicMethod { /* ... */ } #pragma mark - Private - (void)zoc_privateMethod { /* ... */ } #pragma mark - UITableViewDataSource - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath { /* ... */ } #pragma mark - ZOCSuperclass // ... 重载来自 ZOCSuperclass 的方法 #pragma mark - NSObject - (NSString *)description { /* ... */ } ~~~ 上面的标记能明显分离和组织代码。你还可以用 cmd+Click 来快速跳转到符号定义地方。但是小心，即使 paragma mark 是一门手艺，但是它不是让你类里面方法数量增加的一个理由：类里面有太多方法说明类做了太多事情，需要考虑重构了。 ## 关于 pragma 在 [http://raptureinvenice.com/pragmas-arent-just-for-marks](http://raptureinvenice.com/pragmas-arent-just-for-marks) 有很好的关于 pragma 的讨论了，在这边我们再做部分说明。 大多数 iOS 开发者平时并没有和很多编译器选项打交道。一些选项是对控制严格检查（或者不检查）你的代码或者错误的。有时候，你想要用 pragma 直接产生一个异常，临时打断编译器的行为。 当你使用ARC的时候，编译器帮你插入了内存管理相关的调用。但是这样可能产生一些烦人的事情。比如你使用 `NSSelectorFromString` 来动态地产生一个 selector 调用的时候，ARC不知道这个方法是哪个并且不知道应该用那种内存管理方法，你会被提示 `performSelector may cause a leak because its selector is unknown（执行 selector 可能导致泄漏，因为这个 selector 是未知的）`. 如果你知道你的代码不会导致内存泄露，你可以通过加入这些代码忽略这些警告 ~~~ #pragma clang diagnostic push #pragma clang diagnostic ignored "-Warc-performSelector-leaks" [myObj performSelector:mySelector withObject:name]; #pragma clang diagnostic pop ~~~ 注意我们是如何在相关代码上下文中用 pragma 停用 -Warc-performSelector-leaks 检查的。这确保我们没有全局禁用。如果全局禁用，可能会导致错误。 全部的选项可以在 [The Clang User's Manual](http://clang.llvm.org/docs/UsersManual.html) 找到并且学习。 ## 忽略没用使用变量的编译警告 这对表明你一个定义但是没有使用的变量很有用。大多数情况下，你希望移除这些引用来（稍微地）提高性能，但是有时候你希望保留它们。为什么？或许它们以后有用，或者有些特性只是暂时移除。无论如何，一个消除这些警告的好方法是用相关语句进行注解，使用 `#pragma unused()`: ~~~ - (void)giveMeFive { NSString *foo; #pragma unused (foo) return 5; } ~~~ 现在你的代码不用任何编译警告了。注意你的 pragma 需要标记到未定义的变量之下。

一个 GCC 非常模糊的特性，以及 Clang 也有的特性是，代码块如果在闭合的圆括号内的话，会返回最后语句的值 ~~~ NSURL *url = ({ NSString *urlString = [NSString stringWithFormat:@"%@/%@", baseURLString, endpoint]; [NSURL URLWithString:urlString]; }); ~~~ 这个特性非常适合组织小块的代码，通常是设置一个类。他给了读者一个重要的入口并且减少相关干扰，能让读者聚焦于关键的变量和函数中。此外，这个方法有一个优点，所有的变量都在代码块中，也就是只在代码块的区域中有效，这意味着可以减少对其他作用域的命名污染。

[来自](http://nshipster.com/pragma/) Mattt Thompson > code organization is a matter of hygiene (代码组织是卫生问题) 我们十分赞成这句话。清晰地组织代码和规范地进行定义, 是你对自己以及其他阅读代码的人的尊重。

## 空格 - 缩进使用 4 个空格。 永远不要使用 tab, 确保你在 Xcode 的设置里面是这样设置的。 - 方法的大括号和其他的大括号(`if`/`else`/`switch`/`while` 等) 总是在同一行开始，在新起一行结束。 **推荐:** ~~~ if (user.isHappy) { //Do something } else { //Do something else } ~~~ **不推荐:** ~~~ if (user.isHappy) { //Do something } else { //Do something else } ~~~ *　方法之间应该要有一个空行来帮助代码看起来清晰且有组织。 方法内的空格应该用来分离功能，但是通常不同的功能应该用新的方法来定义。优先使用 auto-synthesis。但是如果必要的话， `@synthesize` and `@dynamic` - 在实现文件中的声明应该新起一行。 - 应该总是让冒号对其。有一些方法签名可能超过三个冒号，用冒号对齐可以让代码更具有可读性。总是用冒号对其方法，即使有代码块存在。 【疑问】 **推荐:** ~~~ [UIView animateWithDuration:1.0 animations:^{ // something } completion:^(BOOL finished) { // something }]; ~~~ **不推荐:** ~~~ [UIView animateWithDuration:1.0 animations:^{ // something } completion:^(BOOL finished) { // something }]; ~~~ 如果自动对齐让可读性变得糟糕，那么应该在之前把 block 定义为变量，或者重新考虑你的代码签名设计。 ## Line Breaks 换行 本指南关注代码显示效果以及在线浏览的可读性，所以换行是一个重要的主题。 举个例子： ~~~ self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers]; ~~~ 一个像上面的长行的代码在第二行以一个间隔（2个空格）延续 ~~~ self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers]; ~~~ ## 括号 在以下的地方使用 [Egyptian风格 括号](https://en.wikipedia.org/wiki/Indent_style#K.26R_style) （译者注：又称 K&R 风格，代码段括号的开始位于一行的末尾，而不是另外起一行的风格。关于为什么叫做 Egyptian Brackets，可以参考 [http://blog.codinghorror.com/new-programming-jargon/](http://blog.codinghorror.com/new-programming-jargon/) ) - 控制语句 (if-else, for, switch) 非 Egyptian 括号可以用在： - 类的实现（如果存在) - 方法的实现

当你定义你自己的 `NSNotification` 的时候你应该把你的通知的名字定义为一个字符串常量，就像你暴露给其他类的其他字符串常量一样。你应该在公开的接口文件中将其声明为 `extern` 的， 并且在对应的实现文件里面定义。 因为你在头文件中暴露了符号，所以你应该按照统一的命名空间前缀法则，用类名前缀作为这个通知名字的前缀。 同时，用一个 Did/Will 这样的动词以及用 "Notifications" 后缀来命名这个通知也是一个好的实践。 ~~~ // Foo.h extern NSString * const ZOCFooDidBecomeBarNotification // Foo.m NSString * const ZOCFooDidBecomeBarNotification = @"ZOCFooDidBecomeBarNotification"; ~~~

在 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)。这可以跑起来，但是它的设计非常糟糕，不过它足够过一些要求不高的面试了。 最小的步骤是遵从单一功能原则，创建至少两个组成部分来完成这个任务： - 一个 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 一个更泛型的对象的需求。 我们使用 `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 的对象，确保所有的对象会响应从 `start` 和 `stop` 的方法，而且它会通过 delegate 的属性来提供信息。所有的 view controller 只需要知道相关对象并且不需要知道实现的细节。 ~~~ @interface ZOCTableViewController : UITableViewController <ZOCFeedParserDelegate> - (instancetype)initWithFeedParser:(id<ZOCFeedParserProtocol>)feedParser; @end ~~~ 上面的代码片段的改变看起来不多，但是有了一个巨大的提升。view controller 是面向一个协议而不是具体的实现的。这带来了以下的优点： - view controller 可以通过 delegate 属性带来的信息的任意对象，可以是 RSS 远程解析器，或者本地解析器，或是一个读取其他远程或者本地数据的服务 - `ZOCFeedParser` 和 `ZOCFeedParserDelegate` 可以被其他组成部分复用 - `ZOCViewController` （UI逻辑部分）可以被复用 - 测试更简单了，因为可以用 mock 对象来达到 protocol 预期的效果 当实现一个 protocol 你总应该坚持 [里氏替换原则](http://en.wikipedia.org/wiki/Liskov_substitution_principle)。这个原则让你应该取代任意接口（也就是Objective-C里的的"protocol"）实现，而不用改变客户端或者相关实现。 此外这也意味着你的 protocol 不应该关注实现类的细节，更加认真地设计你的 protocol 的抽象表述的时候，需要注意它和底层实现是不相干的，协议是暴露给使用者的抽象概念。 任何可以在未来复用的设计意味着可以提高代码质量，同时也是程序员的目标。是否这样设计代码，就是大师和菜鸟的区别。 最后的代码可以在这找到。[here](http://github.com/albertodebortoli/ADBFeedReader).

虽然我们知道这样写很丑, 但是我们应该要在我们的 category 方法前加上自己的小写前缀以及下划线，比如`- (id)zoc_myCategoryMethod`。 这种实践同样[被苹果推荐](https://developer.apple.com/library/ios/documentation/cocoa/conceptual/ProgrammingWithObjectiveC/CustomizingExistingClasses/CustomizingExistingClasses.html#//apple_ref/doc/uid/TP40011210-CH6-SW4)。 这是非常必要的。因为如果在扩展的 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 ~~~

当你要实现相等性的时候记住这个约定：你需要同时实现`isEqual` and the `hash`方法。如果两个对象是被`isEqual`认为相等的，它们的 `hash` 方法需要返回一样的值。但是如果 `hash` 返回一样的值，并不能确保他们相等。 这个约定是因为当被存储在集合（如 `NSDictionary` 和 `NSSet` 在底层使用 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 值，或者，最好保证对象是不可变的。

## 参数断言 你的方法可能要求一些参数来满足特定的条件（比如不能为nil），在这种情况下啊最好使用 `NSParameterAssert()` 来断言条件是否成立或是抛出一个异常。 ## 私有方法 永远不要在你的私有方法前加上 `_` 前缀。这个前缀是 Apple 保留的。不要冒重载苹果的私有方法的险。

属性应该尽可能描述性地命名，避免缩写，并且是小写字母开头的驼峰命名。我们的工具可以很方便地帮我们自动补全所有东西（嗯。。几乎所有的，Xcode 的Derived Data 会索引这些命名）。所以没理由少打几个字符了，并且最好尽可能在你源码里表达更多东西。 **例子 :** ~~~ NSString *text; ~~~ **不要这样 :** ~~~ NSString* text; NSString * text; ~~~ （注意：这个习惯和常量不同，这是主要从常用和可读性考虑。 C++ 的开发者偏好从变量名中分离类型，作为类型它应该是`NSString*` （对于从堆中分配的对象，同事对于C++是不能从栈上分配的）格式。） 使用属性的自动同步 (synthesize) 而不是手动的 `@synthesize` 语句，除非你的属性是 protocol 的一部分而不是一个完整的类。如果 Xcode 可以自动同步这些变量，就让它来做吧。否则只会让你抛开 Xcode 的优点，维护更冗长的代码。 你应该总是使用 setter 和 getter 方法访问属性，除了 `init` 和 `dealloc` 方法。通常，使用属性让你增加了在当前作用域之外的代码块的可能所以可能带来更多副作用 你总应该用 getter 和 setter 因为： - 使用 setter 会遵守定义的内存管理语义(`strong`, `weak`, `copy` etc...) 这回定义更多相关的在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?](http://blog.bignerdranch.com/4005-should-i-use-a-property-or-an-instance-variable/) ### Init 和 Dealloc 有一个例外：你永远不能在 init （以及其他初始化函数）里面用 getter 和 setter 方法，并且你直接访问实例变量。事实上一个子类可以重载sette或者getter并且尝试调用其他方法，访问属性的或者 ivar 的话，他们可能没有完全初始化。记住一个对象是仅仅在 init 返回的时候，才会被认为是初始化完成到一个状态了。 同样在 dealloc 方法中（在 dealloc 方法中，一个对象可以在一个 不确定的状态中）这是同样需要被注意的。 - [Advanced Memory Management Programming Guide](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/MemoryMgmt/Articles/mmPractical.html#//apple_ref/doc/uid/TP40004447-SW6) under the self-explanatory section "Don't Use Accessor Methods in Initializer Methods and dealloc"; - [Migrating to Modern Objective-C](http://adcdownload.apple.com//wwdc_2012/wwdc_2012_session_pdfs/session_413__migrating_to_modern_objectivec.pdf) at WWDC 2012 at slide 27; - in a [pull request](https://github.com/NYTimes/objective-c-style-guide/issues/6) form Dave DeLong's. 此外，在 init 中使用 setter 不会很好执行 `UIAppearence` 代理（参见 [UIAppearance for Custom Views](http://petersteinberger.com/blog/2013/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 Naming Guidelines](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CodingGuidelines/Articles/NamingIvarsAndTypes.html#//apple_ref/doc/uid/20001284-BAJGIIJE). 为了避免 `@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 的时候收到一个改变的通知很奇怪。

## 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]` 的表达式， `alloc` 和 `init` 区别慢慢褪去 。一个 Objective-C 的特性叫 _两步创建_ 。 这意味着申请分配内存和初始化是两个分离的操作。 - `alloc`表示对象分配内存，这个过程涉及分配足够的可用内存来保存对象，写入`isa`指针，初始化 retain 的计数，并且初始化所有实例变量。 - `init` 是表示初始化对象，这意味着把对象放到了一个可用的状态。这通常是指把对象的实例变量赋给了可用的值。 `alloc` 方法会返回一个合法的没有初始化的实例对象。每一个发送到实例的信息会被翻译为名字是 `self` 的 `alloc` 返回的指针的参数返回的 `objc_msgSend()` 的调用。这样之后 `self` 已经可以执行所有方法了。 为了完成两步创建，第一个发送给新创建的实例的方法应该是约定俗成的 `init` 方法。注意 `NSObject` 的 `init` 实现中，仅仅是返回了 `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 初始化方法都是合法的，而且应该保证 _所有的_ designated initializer 在类继承中是是从祖先（通常是 `NSObject`）到你的类向下调用的。 实际上这意味着第一个执行的初始化代码是最远的祖先，然后从顶向下的类继承，所有类都有机会执行他们特定的初始化代码。这样，你在你做你的特定的初始化工作前，所有你从超类继承的东西是不可用的状态。即使它的状态不明确，所有 Apple 的框架的 Framework 是保证遵守这个约定的，而且你的类也应该这样做。 当定义一个新类的时候有三个不同的方式： 1. 不需要重载任何初始化函数 1. 重载 designated initializer 1. 定义一个新的 designated initializer 第一个方案是最简单的：你不需要增加类的任何初始化逻辑，只需要依照父类的designated initializer。当你希望提供额外的初始化逻辑的时候你可以重载 designated initializer。你只需要重载你的直接的超类的 designated initializer 并且确认你的实现调用了超类的方法。你一个典型的例子是你创造`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 的规则。 In case you want to provide your own designated initializer there are three steps that you need to follow in order to guarantee the correct behavior: 在你希望提供你自己的初始化函数的时候，你应该遵守这三个步骤来保证正确的性： 1. 定义你的 designated initializer，确保调用了直接超类的 designated initializer 1. 重载直接超类的 designated initializer。调用你的新的 designated initializer. 1. 为新的 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:` 永远不会被调用，所以导致了不正确的初始化流程，你的类特定的初始化逻辑没有被执行。 即使可以推断那个方法是 designate initializer它，但是最好清晰地明确（未来的你或者其他开发者在改代码的时候会感谢你的）。你应该考虑来用这两个策略（不是互斥的）：第一个是你在文档中明确哪一个初始化方法是 designated 的，但是最好你可以用编译器的指令 `__attribute__((objc_designated_initializer))` 来标记你的意图。 用这个编译指令的时候，编译器回来帮你。如果你的新的 designate initializer 没有调用你超类的 designated initializer，上编译器会发出警告。然而，当没有调用类的 designated initializer 的时候（并且依次提供必要的参数），并且调用其他父类中的 designated initialize 的时候，会变成一个不可用的状态。参考之前的例子，当实例化一个 `ZOCNewsViewController` 展示一个新闻而那条新闻没有展示的话，就会毫无意义。这个情况下你应该只需要让其他的 designated initializer 失效，来强制调用一个非常特别的 designated initializer。通过使用另外一个编译器指令 `__attribute__((unavailable("Invoke the designated initializer")))` 来修饰一个方法，通过这个属性，会让你在试图调用这个方法的时候产生一个编译错误。 这是之前的例子相关的实现的头文件(这里使用宏来让代码没有那么啰嗦) ~~~ @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 遵守约定，它会调用 designated initializer）。如果这样，调用很可能会调用一个子类重写的 init 方法并且陷入无限递归之中。 然而一个意外是一个对象是否遵守 `NSCoding` 协议，并且它通过方法 `initWithCoder:` 初始化。我们应该区别超类是否符合 `NSCoding` 的情况。 如果符合，如果你只是调用 `[super initWithCoder:]` 你会可能有一个共享的初始化代码在 designated initializer 里面，一个好的方法是吧这些代码放在私有方法里面(比如 `p_commonInit` )。 当你的超类不符合`NSCoding` 协议的时候，推荐把 `initWithCoder:` 作为 secondary initializer 来对待，并且调用 `self` 的 designated initializer。 注意这是违反 Apple 的 [Archives and Serializations Programming Guide](https://developer.apple.com/library/mac/documentation/cocoa/Conceptual/Archiving/Articles/codingobjects.html#//apple_ref/doc/uid/20000948-BCIHBJDE) 上面写的： > the object should first invoke its superclass's designated initializer to initialize inherited state （对象总是应该首先调用超类的 designated initializer 来初始化继承的状态） 如果你的类不是 `NSObject` 的直接子类，这样做的话，会导致不可预测的行为。 ### Secondary Initializer 正如之前的描述么，secondary initializer 是一种方便提供默认值、行为到 designated initializer 的 方法。也就是说，你不应该强制很多初始化操作在这样的方法里面，并且你应该一直假设这个方法不会得到调用。我们保证的是唯一被调用的方法是 designated initializer。 这意味着你的 designated initializer 总是应该调用其他的 secondary initializer 或者你 `self` 的 designated initializer。有时候，因为错误，可能打成了 `super`，这样会导致不符合上面提及的初始化顺序（在这个特别的例子里面，是跳过当前类的初始化） ### References 参考 - [https://developer.apple.com/library/ios/Documentation/General/Conceptual/DevPedia-CocoaCore/ObjectCreation.html](https://developer.apple.com/library/ios/Documentation/General/Conceptual/DevPedia-CocoaCore/ObjectCreation.html) - [https://developer.apple.com/library/ios/documentation/General/Conceptual/CocoaEncyclopedia/Initialization/Initialization.html](https://developer.apple.com/library/ios/documentation/General/Conceptual/CocoaEncyclopedia/Initialization/Initialization.html) - [https://developer.apple.com/library/ios/Documentation/General/Conceptual/DevPedia-CocoaCore/MultipleInitializers.html](https://developer.apple.com/library/ios/Documentation/General/Conceptual/DevPedia-CocoaCore/MultipleInitializers.html) - [https://blog.twitter.com/2014/how-to-objective-c-initializer-patterns](https://blog.twitter.com/2014/how-to-objective-c-initializer-patterns) ## instancetype 我们经常忽略 Cocoa 充满了约定，并且这些约定可以帮助编译器变得更加聪明。无论编译器是否遭遇 `alloc` 或者 `init` 方法，他会知道，即使返回类型都是 `id` ，这些方法总是返回接受到的类类型的实例。因此，它允许编译器进行类型检查。（比如，检查方法返回的类型是否合法）。Clang的这个好处来自于 [related result type](http://clang.llvm.org/docs/LanguageExtensions.html#related-result-types)， 意味着： > 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 中要构成习惯以及保持始终如一的，此外，通过对你代码的小调整你可以提高可读性：在简单的浏览的时候你可以区分哪些方法是返回你类的实例的。你以后会感谢这些注意过的小细节的。 ### 参考 - [http://tewha.net/2013/02/why-you-should-use-instancetype-instead-of-id/](http://tewha.net/2013/02/why-you-should-use-instancetype-instead-of-id/) - [http://tewha.net/2013/01/when-is-id-promoted-to-instancetype/](http://tewha.net/2013/01/when-is-id-promoted-to-instancetype/) - [http://clang.llvm.org/docs/LanguageExtensions.html#related-result-types](http://clang.llvm.org/docs/LanguageExtensions.html#related-result-types) - [http://nshipster.com/instancetype/](http://nshipster.com/instancetype/) ## 初始化模式 ### 类簇 （class cluster) 类簇在Apple的文档中这样描述： > an architecture that groups a number of private, concrete subclasses under a public, abstract superclass. （一个在共有的抽象超类下设置一组私有子类的架构） 如果这个描述听起来很熟悉，说明你的直觉是对的。 Class cluster 是 Apple 对[抽象工厂](http://en.wikipedia.org/wiki/Abstract_factory_pattern)设计模式的称呼。 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]` 得到调用的时候之前的检查会变成 true 的，`self = nil` 是用来移除所有到 `ZOCKintsugiPhotoViewController` 实例的引用的，它会被释放，按照这个逻辑来检查哪个类应该被初始化。 让我们假设在 iPhone 上运行了这个代码， `ZOCKintsugiPhotoViewController_iPhone` 没有重载`initWithPhotos:`，在这个情况下，当执行 `self = [[ZOCKintsugiPhotoViewController_iPhone alloc] 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()的意思就是 ”把一些东西执行一次“，就像我们做的一样。 这样同时可以避免[possible and sometimes prolific crashes](http://cocoasamurai.blogspot.com/2011/04/singletons-your-doing-them-wrong.html). 经典的可以接受的单例对象的例子是一个设备的 GPS 以及 动作传感器。即使单例对象可以被子类化，这个情况可以十分有用。这个接口应该证明给出的类是趋向于使用单例的。然而，经常使用一个单独的公开的 `sharedInstance` 类方法就够了，并且不可写的属性也应该被暴露。 把单例作为一个对象的容器来在代码或者应用层面上共享是糟糕和丑陋的，这是一个不好的设计。

## 类名 类名应加上 **三** 个大写字母作为前缀（两个字母的为 Apple 的类保留）。虽然这个规范看起来难看，但是这样做是为了减少 objective-c 没有命名空间所带来的问题。 一些开发者在定义 Model 对象时并不遵循这个规范（对于 Core Data 对象，我们更应该遵循这个规范）。我们建议在定义 Core Data 对象时严格遵循这个约定，因为你最后可能把你的 Managed Object Model 和其他（第三方库）的 Managed Object Model 合并。 你可能注意到了，这本书里的类的前缀（其实不仅仅是类）是`ZOC`。 另一个类的命名规范：当你创建一个子类的时候，你应该把说明性的部分放在前缀和父类名的在中间。举个例子：如果你有一个 `ZOCNetworkClient` 类，子类的名字会是`ZOCTwitterNetworkClient` (注意 "Twitter" 在 "ZOC" 和 "NetworkClient" 之间); 按照这个约定， 一个`UIViewController` 的子类会是 `ZOCTimelineViewController`.