虽然说Swift是作为一种全新的语言被推出的&＃xff0c;但是不可避免的需要借助于Apple生态来对它进行推广&＃xff0c;在推广的过程中&＃xff0c;就不可避免的需要被使用在Cocoa框架中&＃xff0c;所以我们今天来总结一下当Swift被使用在Cocoa框架中时需要注意的一些事项。

在我们开始讨论之前&＃xff0c;我们先来了解一下Swift与Objective-C的一些不同点。

区别

我们通过使用Swift与Objective-C来编写具有一个存储属性、一个计算属性、一个实例方法的类&＃xff1a;

Objective-C

&＃64;interface OCModel : NSObject///存储属性
&＃64;property (nonatomic, copy) NSString *privateName;///计算属性
&＃64;property (nonatomic, copy) NSString *publicName;///实例方法
- (void)showName;&＃64;end&＃64;implementation OCModel- (void)setPublicName:(NSString *)publicName {self.privateName &＃61; publicName;
}- (NSString *)publicName {return self.privateName;
}///实例方法
- (void)showName {NSLog(&＃64;"OCModel name is %&＃64;", self.privateName);
}&＃64;end

Swift

class SwiftModel {///存储属性var privateName: String?///计算属性var publicName: String {get {return privateName ?? "none"}set {privateName &＃61; newValue}}///实例方法func showName() -> Void {print("SwiftModel name is \(privateName ?? "none")")}
}

现在我们对两种语言定义的类通过Runtime来读取一下相关的内容&＃xff0c;结果如下&＃xff1a;

Objective-C

Swift

从上面结果可见&＃xff0c;Swift中的属性即方法并不能通过Runtime机制读取出&＃xff0c;这是因为Runtime的API是基于运行时机制的&＃xff0c;而Swift本身是静态语言&＃xff0c;在编译时就已经确定变量、方法等内容。

但我们在使用Objective-C进行iOS开发时&＃xff0c;或多或少的都使用到了Runtime&＃xff0c;同时Runtime也可以为我们解决许多问题&＃xff0c;那么在Swift中就无法使用Runtime了吗&＃xff1f;当然不是。

Swift中使用Runtime

我们了解了Swift为何无法使用Runtime的原因&＃xff0c;要解决这个问题&＃xff0c;最简单的方法就是将Swift中想要使用Runtime的内容桥接至Objective-C上&＃xff0c;所幸苹果已经为我们做到了这一点&＃xff0c;那就是&＃64;objc关键字。

我们将上述Swift中的类桥接至Objective-C之后看一下结果&＃xff1a;

桥接之后

&＃64;objc class SwiftModel: NSObject {///存储属性&＃64;objc var privateName: String?///计算属性&＃64;objc var publicName: String {get {return privateName ?? "none"}set {privateName &＃61; newValue}}///实例方法&＃64;objc func showName() -> Void {print("SwiftModel name is \(privateName ?? "none")")}
}

结果

可见&＃xff0c;在将Swift桥接至Objective-C之后&＃xff0c;我们可以使用Runtime访问到所有的变量、属性以及方法。

注意

1. 使用&＃64;objc可以将Swift编写的类桥接至Objective-C&＃xff0c;但是必须保证该类的基类为NSObject。
2. 在基于Swift3以及之前版本的Swift语言项目中&＃xff0c;当Swift编写的类被标记为&＃64;objc时&＃xff0c;编译器会自动为该类中所有非private访问级别的成员默认添加&＃64;objc关键字。但是在Swift4之后&＃xff0c;该功能被关闭&＃xff0c;我们需要为我们想要桥接至Objective-C的类、属性、方法进行手动显式地添加&＃64;objc标记。

现在&＃xff0c;我们再来讨论一下在Cocoa框架中使用Swift&＃xff0c;首先我们来看一下Target-Action模式。

Target-Action模式

首先我们看一下Target-Action模式中的两个关键点&＃xff1a;Target以及Action。

我们使用Timer的API来查看一下&＃xff1a;

public init(timeInterval ti: TimeInterval, target aTarget: Any, selector aSelector: Selector, userInfo: Any?, repeats yesOrNo: Bool)

首先&＃xff0c;target为Any类型&＃xff0c;其余没有特殊要求。

其次&＃xff0c;我们来重点探讨一下action。

Action

从API中可以看出&＃xff0c;Action的类型为Selector。在官方文档中&＃xff0c;Selector的描述如下&＃xff1a;The Objective-C SEL type.

由此我们可以看出&＃xff0c;该Selector必须是桥接到Objective-C的方法。

Selector的初始化方式有两种&＃xff0c;其中有一些注意点如下&＃xff1a;

1.#selector()

我们可以使用#selector()来初始化一个Selector。

由Xcode的提示我们可知&＃xff0c;所需要使用到的方法也必须是经过&＃64;objc标记的方法。

2.init(_ str: String)

使用Selector的初始化方法来进行创建&＃xff0c;通过传入一个方法名称的字符串来创建Selector。

在使用该方法创建时&＃xff0c;同样需要注意使用到的方法也必须是进过&＃64;objc标识的方法。

同时&＃xff0c;在使用该方法创建时&＃xff0c;方法名称字符串必须是Objective-C语法类型的方法名。

例如&＃xff0c;我们使用如下方法创建Selector&＃xff1a;

&＃64;objc func repeatFunction(timer: Timer) -> Void {print(timer)
}

那么对应的方法应该是&＃xff1a;

Selector("repeatFunctionWithTimer:")

接下里我们再看一下Cocoa中的另一个模式。

Key-Value Observing模式

首先我们查看一下与KVO相关的几个方法&＃xff1a;

extension NSObject {open func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)
}extension NSObject {open func addObserver(_ observer: NSObject, forKeyPath keyPath: String, options: NSKeyValueObservingOptions &＃61; [], context: UnsafeMutableRawPointer?)&＃64;available(iOS 5.0, *)open func removeObserver(_ observer: NSObject, forKeyPath keyPath: String, context: UnsafeMutableRawPointer?)open func removeObserver(_ observer: NSObject, forKeyPath keyPath: String)
}

由方法定义我们可知&＃xff0c;想要使用KVO&＃xff0c;那么被观察的对象需要是NSObject的子类。那好&＃xff0c;我们定义一个NSObject的子类&＃xff1a;

class SwiftModel: NSObject {var name: String?
}

接下来我们创建一个该类的实例&＃xff0c;并对该实例进行 name 变量的观察&＃xff1a;

override func viewDidLoad() {super.viewDidLoad()let model &＃61; SwiftModel()model.addObserver(self, forKeyPath: "name", options: [.new], context: nil)model.name &＃61; "new name"model.removeObserver(self, forKeyPath: "name")}override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {if object is SwiftModel, keyPath &＃61;&＃61; "name" {print(change!)}
}

接下来运行&＃xff0c;我们发现并没有触发KVO观察的回调&＃xff0c;这是为什么呢&＃xff1f;

我们知道&＃xff0c;KVO机制是在建立观察时动态的为被观察的类创建一个子类&＃xff0c;同时重写被观察键的setter方法(关于KVO的探讨&＃xff0c;可以查看该篇博客)。

此时我们没有触发KVO的观察回调&＃xff0c;是由于&＃64;objc虽然将属性桥接至Objective-C上&＃xff0c;但是Swift编译器还是无法实现动态调用&＃xff0c;我们需要将被观察的属性设置为动态调用&＃xff0c;即使用dynamic关键词来标识属性&＃xff1a;

class SwiftModel: NSObject {&＃64;objc dynamic var name: String?
}

至此&＃xff0c;我们实现了在Swift中使用KVO&＃xff0c;下面是在使用KVO时的几点总结&＃xff1a;

1.被观察的类需要继承自NSObject。

2.被观察的属性/变量需要制定动态调用&＃xff0c;即使用dynamic来标识。

3.在使用dynamic标识时&＃xff0c;需要将属性/变量桥接至Objective-C&＃xff0c;即同时使用&＃64;objc dynamic标识。

其他一些相关注意事项

在实际开发中&＃xff0c;我们需要对方法进行Swizzle&＃xff0c;此时我们一般使用下面的方法&＃xff1a;

func swizzle(instanceMethod: Selector, method: Selector) -> Void {let cls &＃61; type(of: self)let origMethodOptional &＃61; class_getInstanceMethod(cls, instanceMethod)let newMethodOptional &＃61; class_getInstanceMethod(cls, method)guard let origMethod &＃61; origMethodOptional, let newMethod &＃61; newMethodOptional else {return}if class_addMethod(cls,instanceMethod,method_getImplementation(newMethod),method_getTypeEncoding(newMethod)) {class_replaceMethod(cls,method,method_getImplementation(origMethod),method_getTypeEncoding(origMethod))} else {class_replaceMethod(cls,method,class_replaceMethod(cls,instanceMethod,method_getImplementation(newMethod),method_getTypeEncoding(newMethod))!,method_getTypeEncoding(origMethod))}
}

此时如果我们不对需要交换的方法进行特殊的处理&＃xff0c;那么可能会造成交换失败&＃xff0c;如下例&＃xff1a;

class SuperClass: NSObject {&＃64;objc func sayHello() -> Void {print("Super Say Hello")}
}class SubClass: SuperClass {override init() {super.init()self.swizzle(instanceMethod: #selector(sayHello), method: #selector(hookSayHello))}&＃64;objc func hookSayHello() -> Void {print("Sub Say hello")}
}

接下来我们初始化一个SubClass对象&＃xff0c;然后分别调用sayHello()和hookSayHello()方法&＃xff0c;理论上两个方法进行了交换&＃xff0c;打印结果也应该进行交换&＃xff0c;但结果并没有交换。

这是为什么呢&＃xff1f;

其实不难想象&＃xff0c;KVO中要将观察的属性设置为dynamic&＃xff0c;目的就是为了在调用时动态访问到重写之后的setter方法。而在此处&＃xff0c;两个方法并没有指定dynamic&＃xff0c;虽然两个方法进行了调换&＃xff0c;但是在调用时并没有动态调用&＃xff0c;而仅仅是直接访问&＃xff0c;所以并没有达到我们想要的效果。

我们可以通过以下步骤进行验证&＃xff1a;

1.验证方法是否被交换

我们改动一下Runtime交换方法的函数&＃xff0c;在其中打印一下交换前与交换后的方法指向&＃xff1a;

然后我们运行代码&＃xff0c;此时方法的打印结果没有交换&＃xff0c;但是方法的指向发生了改变&＃xff1a;

2.验证单个dynamic标识效果

• 我们为sayHello方法添加dynamic&＃xff0c;运行代码&＃xff0c;发现两次打印都是”Sub Say Hello”。
• 我们为hookSayHello方法添加dynamic&＃xff0c;允许代码&＃xff0c;发现两次打印都是”Super Say Hello”。

不难理解&＃xff0c;当其中一个方法被指定为dynamic时&＃xff0c;当访问该方法时&＃xff0c;会采用动态调用的方式&＃xff0c;进而访问到调换之后的实现。而没有指定dynamic的方法&＃xff0c;还是按照直接调用的方法&＃xff0c;访问到它自己本身的实现上。

3.验证两个dynamic标识效果

当两个方法都被指定为dynamic时&＃xff0c;打印结果发生了交换&＃xff0c;证明方法调换成功。

接下来我们继续对方法调换进行探索&＃xff0c;假设hookSayHello方法是在SubClass的Extension中&＃xff0c;那么对于dynamic的使用有和不同&＃xff1a;

class SuperClass: NSObject {&＃64;objc func sayHello() -> Void {print("Super Say Hello")}
}class SubClass: SuperClass {override init() {super.init()self.swizzle(instanceMethod: #selector(sayHello), method: #selector(hookSayHello))}
}extension SubClass {&＃64;objc func hookSayHello() -> Void {print("Sub Say hello")}
}

我们依旧使用上述步骤进行验证&＃xff1a;

1.验证方法是否被交换

我们运行代码&＃xff0c;此时方法的指向发生了变化&＃xff0c;同时两次打印结果均为”Super Say Hello”。

2.验证单个dynamic标识效果

• 我们为sayHello方法添加dynamic&＃xff0c;运行代码&＃xff0c;发现两次分别是”Sub Say Hello”&＃xff0c;”Super Say Hello”。
• 我们为hookSayHello方法添加dynamic&＃xff0c;允许代码&＃xff0c;发现两次打印都是”Super Say Hello”。

3.验证两个dynamic标识效果

当两个方法都被指定为dynamic时&＃xff0c;打印结果发生了交换&＃xff0c;证明方法调换成功。

从上述结果&＃xff0c;我们可以总结出&＃xff0c;sayHello方法的表现与之前验证结果一直&＃xff0c;而hookSayHello的表现无论有没有指定dynamic&＃xff0c;都进行了动态调用&＃xff0c;由此可见&＃xff0c;通过Extension新增的方法&＃xff0c;均表现为dynamic。

至此&＃xff0c;我们可以进行一个总结&＃xff1a;

1.Runtime可以将Swift中的&＃64;objc方法进行调换。

2.Swift调用方法时&＃xff0c;并不依赖于Runtime&＃xff0c;即使方法对应的IMP已经改变&＃xff0c;但Swift依旧可以使用直接调用方式调用到原始的IMP。

3.可以使用dynamic关键字将Swift中的方法指定为动态调用&＃xff0c;此时的Swift方法与Objective-C中方法表现一致&＃xff0c;会受到Runtime的影响。

4.通过Extension新增的方法&＃xff0c;默认为dynamic的&＃xff0c;这些方法受Runtime影响。