巧用 Class Extension 分离接口依赖
Class Extension
和 Category
是我们经常使用的 Objective-C 语法:
1 | // Class Extension |
还记得最开始学习 Objective-C 时,并没有支持 Class Extension,当时只能凑活的用个 Private 的 Category 充当,需要添加私有成员变量时那叫个痛苦,直到大概四年前的 WWDC 终于宣布添加上了 Class Extension 的语法,当时底下的开发者们含泪报以了热烈掌声,它让类的封装变的更加得心用手。
在类组织结构上,Category 可以用来帮助拆分功能,让一个大型的类分治管理:(类似 NSString.h
)
1 | // Sark.h |
不过有两个设计原则必须要遵守:
- Category 的实现可以依赖主类,但主类一定不依赖 Category,也就是说移除任何一个 Category 的代码不会对主类产生任何影响。
- Category 可以直接使用主类已有的私有成员变量,但不应该为实现 Category 而往主类中添加成员变量,考虑在 Category 的实现中使用
objc association
来达到相同效果。
所以 Category 一定是简单插拔的,就像买个外接键盘来扩展在 MacBook 上的写码能力,但当拔了键盘,MacBook 的运行不会受到任何影响。
而 Class Extension 和 Category 在语言机制上有着很大差别:Class Extension 在编译期就会将定义的 Ivar、属性、方法等直接合入主类,而 Category 在程序启动 Runtime Loading 时才会将属性(没 Ivar)和方法合入主类。但有意思的是,两者在在语法解析层面却只有细微的差别,可以尝试用 clang
命令查看一个文件的 AST
(抽象语法树)
1 | $ clang -Xclang -ast-dump -fsyntax-only main.m |
生成 AST 是 Clang 其中一个比较重要的职责,像 Xcode 的代码补全、语法检查、代码风格规范都是在这一层做的;如果像我一样无聊,也可以玩玩 libclang,一个 C 语言 Clang API,输入代码,就能将其解析成语法树,通过遍历 AST,可以取得每个 Decl 和 Token 的信息和所处的源码行数和位置,大到类定义,小到一个逗号一个分号都能完全掌控,非常有助于理解编译器如何处理源码;有了 libclang,定义些规则就能实现个简单的 Linter 啦。
上面的命令会在控制台中打印出一堆花花绿绿的语法树结构,挑出我们关注的信息:
1 | // ... |
可以看出,Class Extension 和 Category 在 AST 中的表示都是 ObjCCategoryDecl
,只是有无名字的区别,也可以说 Class Extension 是匿名的 Category。
既然 Category 可以有 N 个,Class Extension 也可以有,且它不限于写在 .m
中,只要在 @implementation
前定义就可以,我们可以利用这个性质,将 Header 中的声明按功能归类:
1 | // Sark.h |
与 Category 不同,Class Extension 的分组形式并没有破坏 “一个主类” 的 基本外交原则 基本结构,还可以把属性( Ivar )也放心丢进来。
— 正题分割线 —
除此之外,Class Extension 还能巧妙的解决一个接口暴露问题,若有下面的声明:
1 | // Sark.framework/Sark.h |
假设 Sark.h
是 Sark.framework
唯一暴露的 Header,而 framework 中的一个私有类需要获取这个公共类的某个属性(或方法)该怎么办?上面的 creditCardPassword
属性需要一个对外不可见而对内可见的地方声明,这时候可以利用 Class Extension:
1 | // Sark.h |
将对公业务和对私业务用 Class Extension 的形式拆到两个 Header 中,这样私有类对私有属性的依赖就被成功隔离开了:
1 | // PrivateSarkWife.m |
Done.