Swift命名空间

之前在使用RxSwfit的时候对.rx这个东西的一直有些疑问,不清楚实现原理,趁着现在有些空余时间,打算深入研究下,于是有了这篇文章。

通过学习,了解到rx其实就是一个命名空间的实现,关于Swift命名空间的说明,参考喵神的这篇文章

关于命名冲突

Swift的命名空间是以模块来划分的,一个模块表示一个命名空间,我们进行APP开发是,默认添加到主target的内容是同处于同一个命名空间的。如果用Cocoapod的方式导入的第三方库,是以一个单独的target存在,不会存在命名冲突。如果是以源码的方式导入工程中,很有可能发生命名冲突。所以,为了安全起见,第三方库都会使用命名空间这种方式来防止冲突。在Objective-C上没有命名空间,一般是使用方法名前面加前缀的方式避免冲突。

命名空间原理


let text = usernameLabel.rx.text.orEmpty.asObservable()

如果你对RxSwift熟悉的话,应该看过不少类似的代码。观察上面的代码,发现可以通过点语法访问rx,这说明rx是一个属性,rx又可以用点语法访问UILabel的text属性,说明rx是个数据结构。

小结:
1、rx是个数据结构
2、rx是个属性

实现命名空间

有了上面的说明,我们可以定义一个名为ButtonNameSpace的命名空间结构体


struct ButtonNameSpace {

 func hello() {

 print("Hello")

 }

}

然后,我们为UIButton这个类添加一个nameSpace计算属性,nameSpace返回一个ButtonNameSpace结构体的实例


extension UIButton {

 var nameSpace: ButtonNameSpace {

 return ButtonNameSpace()

 }

}

现在我们可以用如下方式使用


UIButton().nameSpace.hello() // 输出hello

这样的命名空间其实没有作用,因为无法访问UIButton的属性和函数。

下面为ButtonNameSpace加上一些有用的东西


struct ButtonNameSpace {

 private let button: UIButton

 init(button: UIButton) {

 self.button = button

 }

 func hello() {

 print("Hello \(button.titleLabel?.text ?? "")")

 }

}

修改UIButton的扩展的实现


extension ButtonNameSpace {

 var nameSapce: ButtonNameSapce {

 return ButtonNameSapce(button: self)

 }

}

现在命名空间更有意义了,因为它对创建它的对象,有了一个引用。实际上,命名空间的真正目的是对创建它的对象保存一个引用。

如果现在我想为UILabel也添加一个命名空间,那么我还要为UILabel添加一个LabelNameSpace的命名空间,这样显然是不太聪明的做法,命名空间结构体应该是通用的,让我们定义一个通用的命名空间结构体。

实现泛型的命名空间

定义泛型的命名空间结构体


struct MyNameSpace<Base> {

 private let base: Base

 init(base: Base) {

 self.base = base

 }

}

现在我们可以为UIButton和UILabel添加hello方法了


extension UIButton {

 var nameSpace: MyNameSpace<UIButton> {

 return MyNameSpace(base: self)

 }

}

extension MyNameSpace where Base: UIButton {

 func hello() {

 print("Hi \(base.titleLabel?.text ?? "")")

 }

}

let bnt = UIButton()

bnt("My button", for: .normal)

bnt.nameSpace.hello(). // 输出:Hi My button

extension UILabel {

 var nameSpace: MyNameSpace<UILabel> {

 return MyNameSpace(base: self)

 }

}

extension MyNameSpace where Base: UILabel {

 func hello() {

 print("Hi \(base?.text ?? "")")

 }

}

观察上面的代码,为UIButton和UILabel添加扩展的代码基本是一样的,都有nameSpace计算属性,返回的都是命名空间结构体的实例,显然我们可以用更优雅的代码实现上面的功能,没错,就是协议扩展。

协议扩展

protocol NameSpaceWrappable {
    associatedtype T
    var rx: T { get }
    static var rx: T.Type { get }
}

extension NameSpaceWrappable {
    var rx: MyNameSpace<Self> {
        return MyNameSpace<Self>(base: self)
    }

    static var rx: MyNameSpace<Self>.Type {
        return MyNameSpace<Self>.self
    }
}

观察上面的代码,我们定义了一个NameSpaceWrappable的协议,包含一个泛型实例属性和一个类属性,分别返回MyNameSpace泛型结构体的实例和类。

现在我们为UIButton实现上述功能,只需让UIButton遵循NameSpaceWrappable协议,就能得到一个名为rx的MyNameSpace结构体的实例属性和名为rx的类属性。

extension UIButton: NameSpaceWrappable {}
let btn = UIButton()
btn.titleLabel?.text = "ni hao"
btn.rx.hello()

查看Reactive.swift的源码,发现正是这样实现的。

总结

同一个模块中实现命名空间,其实就是通过类型嵌套限定使用范围。

水平有限,如有错误的地方,请务必留言告诉我。

推荐阅读更多精彩内容