objc@interface的设计哲学与设计技巧

时间 2019-11-17

标签 objc@interface objc interface 设计哲学技巧繁體版

原文原文链接

blog.sunnyxx.com

我是前言

学习objc时，尤为是先学过其余编程语言再来看objc时，总会对objc的类声明的关键字interface感到有点奇怪，在其它面向对象的语言中一般由class关键字来表示，而interface在java中表示的却大约至关于objc的protocol，这个关键字的区别究竟表明了objc语言的设计者怎样的思想呢，在objc类设计中须要注意哪些问题呢？接下来对这个问题进行一些思考和探究.java

interface?

先来段Wiki:c++

In object-oriented programming, a protocol or interface is a common means for unrelated objects to communicate with each other. These are definitions of methods and values which the objects agree upon in order to cooperate.git

接口约定了对象间交互的属性和方法，使得对象间无需了解对方就能够协做。
说的洋气点就是解耦嘛，细心点也能发现Wiki中interface和protocol表示了相近的语义。
引用我和项目组架构师讨论有关interface的问题时他的说法:github

interface就是一个object定义的能够被外界影响的方式编程

说着他指了下旁边桌子上放着的一把伞，说，这把伞我能够打开它，打开这个动做就是它的一个interface，桌子旁边还放着一个盒子，虽然它和伞都放在这张桌子上，可是它们之间永远不会互相影响，因此：微信

interface只存在于能互相影响的二者间架构

@interface生成了class？

学习objc时最先接触的就是怎么写一个类了，从.h中写@interface声明类，再从.m中写@implementation实现方法，因此，objc中写一个@interface就至关于c++中写一个class。但这是真的么？app

写个小test验证一下：
有两个类，Sark和Dark，Sark类只有.m文件，其中只写@implementation；Dark类只有.h头文件，其中只写@interface，而后以下测试代码：编程语言

1 2	Class sarkClass = NSClassFromString(@"Sark"); Class darkClass = NSClassFromString(@"Dark");

NSClassFromString方法调用了runtime方法，根据类名将加载进runtime的这个类找出来，没有这个类就回返回空(Nil)。
结果是sarkClass存在，而darkClass为空，说明什么？是否说明其实@implementation才是真正的Class？
进一步，不止能取到这个没有@interface的类，还能够正常调用方法（由于万能的runtime）ide

以下面的测试代码：

1 2	Sark *sark = [Sark new]; [sark speak];

要是没有@interface的声明，类名，方法名都会报错说找不到，可是能够像下面同样绕一下：

1
2
3

Class cls = NSClassFromString(@"Sark");
id obj = [cls performSelector:NSSelectorFromString(@"new")];
[obj performSelector:NSSelectorFromString(@"speak")];

其实，从rewrite后的objc代码能够发现，对于消息的发送，偏偏就是会被处理成相似上面的代码，使用字符串mapping出Class，selctor等再使用objc_msgSend()进行函数调用，以下面所示：

1
2
3

// 通过clang -rewrite-objc 命令重写后的代码
Sark *sark = ((id (*)(id, SEL))(void *)objc_msgSend)((id)objc_getClass("Sark"), sel_registerName("new"));
((void (*)(id, SEL))(void *)objc_msgSend)((id)sark, sel_registerName("speak"));

对比@interface和@implementation

@interface 咱们干过的事：

继承
声明协议
定义实例变量（@interface后面加大括号那种）
定义@property
声明方法

@implementation 咱们干过的和能够干的事：

继承
定义实例变量
合成属性（@synthesize和@dynamic）
实现方法（包括协议方法）

在@implementation干一些事情用的相对较少，可是是彻底合法的，如这样用：

1
2
3

@implementation Sark : NSObject {
 NSString *_name;
}

经过对比能够发现，@interface对objc类结构的合成并没有决定性做用，加上无决定性是由于若是没有@interface会丢失一些类自省的原始数据，如属性列表和协议列表，但对于纯粹的对象消息发送并没有影响。
因此说，能够得出这么一个结论，objc中@interface就是为了给调用者看的，是和调用者的一个protocol，没错，就是protocol。

对比@interface和@protocol

与其把@implementation扯进来不如对比下@protocol

我理解objc的@interface和@protocal间惟一的区别就是是否和一个类型绑定，这让我想起来鸭子类型(Duck typing), wiki连接

“当看到一只鸟走起来像鸭子、游泳起来像鸭子、叫起来也像鸭子，那么这只鸟就能够被称为鸭子。”

Duck type在objc的体现无疑就是@protocol了，咱们经常使用id<XXXDelegate> delegate的方式声明一个delegate，咱们无需care这货究竟是什么类型，咱们只知道他能干什么就能够work了。一样的功能我也可使用XXXDelegate *delegate的方式来定义，只不过这样的话这个类又须要耦合一个XXXDelegate类型，而这个delegate类是它本来并不须要关心的。

因此说，@interface是@protocol的强类型升级版。

举个NSObject的栗子最合适：

1
2
3

@interface NSObject <NSObject> {
 Class isa;
}

NSObject之因此成为NSObject，绝大多数都是<NSObject>协议定义的方法，实体类@interface定义的惟一一个变量isa指针，为了继承链和消息传递。
除了<NSObject>协议外，NSObject还有不少Category来补充它的功能，其实仔细想一想，Category更像protocol，一个补充协议，一样不能添加实例变量，可是和@interface同样须要与Class绑定。

进一步来说，自从属性能自动合成变量以后，在头文件@interface中写大括号声明实例变量的状况愈来愈少（能够参见近几个版本iOS SDK中类头文件里这种写法几乎消失），所以，@interface和@protocol的差异进一步缩小。

类与接口的设计原则 - 电视和遥控器

我喜欢将Class和interface的关系比喻成电视+遥控器，那么objc中的消息机制就能够理解成：
用户（caller）经过遥控器（interface）上的按钮（methods）发送红外线（message）来操纵电视（object）
因此，有没有遥控器，电视都在那儿，也就是说，有没有interface，class都是存在的，只是这种存在并无意义，就好像这个电视没人会打开，没人会用，没人能看，一堆废铁摆在那儿。

对比简洁的遥控器，一个拥有不少按钮的老式电视遥控器，咱们常常会用到的按钮能有几个呢？

因此，在设计一个类的interface的时候，如同在设计遥控器应该有怎样功能的按钮，要从调用者的角度出发，区分边界，应该时刻有如下几点考虑：

这个方法或属性真的属于这个类的职责么？（电视遥控器能遥控空调？）
这个方法或属性真的必须放在.h中（而不是放在.m的类扩展中）么？
调用者必须看文档才能知道这个类该如何使用么？（同一个业务须要调用者按顺序调用屡次（而不是将这些细节隐藏，同时提供一个简洁的接口）才行）
调用者是否能够很容易发现类内部的变量和实现方式？（脑补下电视里面一块电路板漏在外面半截- -）
…

objc的@interface设计技巧Tips

看过很多代码，从@interface设计上多少就能看出做者的水平，分享下我对于这个问题的一些拙见。

只暴露外部须要看到的

好比，有以下一个类（这个类无心义，主要关注写法）：

// Sark.h
@interface SarkViewController : NSObject <NSXMLParserDelegate /*1*/, NSCopying> {
 NSString *_name; // 2
 IBOutlet UITextField *_nameTextField; // 2
}
@property (nonatomic, strong) NSXMLParser *parser; // 3
- (IBAction)nameChangedAction:(id)sender; // 4
@end

这个interface出现的问题：

类内部本身使用的协议，如<NSXMLParserDelegate>不该该在头文件@interface中声明，而应该在类扩展中声明；公开由外部调用的协议，如<NSCopying>则写在这儿是正确的。
实例变量和IBOutlet不该出如今这儿定义，这将类的内部实现暴露了出去，自从属性能够自动合成后，这里就更应该清净了。
内部使用的属性对象不要暴露在外，应该移动到类扩展中。
调用者对IBAction一样不须要关心，那么就不该该放在这儿。

合理分组子功能

将相同功能的一组属性或方法写在一块儿

使用这个类或者对其进行修改时，通常都是从功能上找，因此把同一功能模块的一组属性或方法写在一块

纯操做方法的子功能（无需向类添加变量）使用Category分块
在头文件中也可使用类扩展将interface按功能分区

Category里不能添加实例变量，可是类扩展能够，通常都在.m中做为私有interface使用，一样在头文件里做为分区使用，如，ReactiveCocoa中的RACStream.h

避免头文件污染

首先，类实现内部.m文件中使用的其余interface应该在.m文件import，若是也写在header中就会形成对调用者的污染；当interface中出现其余Class或protocol时，可使用前置声明@class XXX, @protocol XXX；当模块（一组类）内部间须要有一些定义（如常量、类型）而又不须要模块使用者知道时，使用一个内部头文件在模块中使用。

避免接口过分设计

考虑调用者的使用方即是很必要的，过火了反而增长了复杂度：

@interface Sark : NSObject
- (instancetype)init;
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithName:(NSString *)name sex:(NSString *)sex;
- (instancetype)initWithName:(NSString *)name sex:(NSString *)sex age:(NSInteger)age;
- (instancetype)initWithName:(NSString *)name sex:(NSString *)sex age:(NSInteger)age friends:(NSArray *)friends;
// 无数多个 //
@end

提供了一组这样的方法，调用者可能只能用到其中的一个，那这样倒不如只留一个接口。

避免单例的滥用

单例模式当然好用，但感受有点过分，将接口设计成单例入口前须要考虑一下：

这个类表达的含义真的只能有一个实例么？（如UIApplication）仍是只是为了好调用而已？
这个单例持有的内存一直存在
是否能用类方法代替？
这个单例对象是否能成为另外一个单例对象的属性？若是是，应该做为属性

隐藏继承关系中的私有接口

感谢@像条狗在飞在留言中提出的问题，问题大概能够总结为：当子类须要使用父类的一个私有属性（方法）时，须要把这个属性（方法）放到父类的header中，但暴露给子类的同时暴露给了外部调用者，如何解决?

个人方案是：创建一个私有header，使用类扩展定义父类须要暴露给子类的属性（方法），而后在各自的.m文件中引用，如：

有Father类和Son类，继承关系，能够考虑建一个如FatherPrivate.h的私有header：

// FatherPrivate.h
@interface Father ()
@property (nonatomic, copy) NSString *privateThingSonNeed;
- (void)privateMethodNeedsSonOverride;
@end

同时在Father.m和Son.m中同时import这个私有header，这样，Father和Son内部对于定义的属性和方法都是透明的，而对外部是隐藏的（由于两个类的header中都没有import这个私有header）

总结

@implementation合成了Class，而非@interface，@interface是@protocol的强类型升级版，它们和Category都表示了相近的含义
咱们应该善于面向接口编程，划清边界，将类的实现隐藏在调用者所见以外，使主调和被调者之间保持最少知识原则
@interface自己就是最好的文档

References

http://en.m.wikipedia.org/wiki/Interface_(object-oriented_programming)
http://zh.wikipedia.org/wiki/%E9%B8%AD%E5%AD%90%E7%B1%BB%E5%9E%8B

原创文章，转载请注明源地址，blog.sunnyxx.com

原创文章，转载请注明原地址：blog.sunnyxx.com
对博主有意思？新浪微博@我就叫Sunny怎么了
or 微信搜索订阅号sunnyxx或扫下面的逗比狗