Swift工具类命名空间隔离
前言
OC 中一直一来就有一个很让人头疼的问题就是方法名或者类名重复的问题,特别是在使用第三方 SDK 中包含了一个与自己在项目中与用到的同一个第三方框架,这是一个很头疼的问题.
遇到这种情况,你只有两个选择:
1.换一个相同功能的第三方框架
2.把这个第三方框架中的方法名和类名全改了
所以,一直一来在 OC 的第三方框架中,都加了前缀,如 AFNetworking, MJRefresh, YYModel.即使是在我们自己写的类中,也会加上前缀
但是加上前缀也只是减小了重复的可能性,并不能完全的不会重复
然后,苹果发布了 Swift,像许多优秀的编程语言一样,在 Swift 中避开了 OC 中的尴尬情况,采用用命名空间的概念.
然而在 Swift 中的命名空间是基于一个 Module 的,也就是一个 Module 是一个命名空间.这也就是为什么现在的 Snapkit 使用的时候会view.snp.xxxx,Kingfisher 使用的时候要用imageView.kf.xxxx.
但是在我们自己平时在写一些工具类或者 Foundation框架的类的扩展的时候,有可能会有一些方法与系统或者别人写的方法重名,这就很尴尬了!
这个前言好像有点长了☺️
类型嵌套
不过好在 SWift 为我们提供了类型嵌套的方法,我们可以在一个类型(可以是类,结构体,枚举类型)里面去定义别一个类型,从而达到隔离内部类型的方法,可以参考喵神的文章
struct MyOuterClass1 {
class MyClass {
class func hello() {
print("hello from MyClassContainer1")
}
}
}
struct MyOuterClass2 {
class MyClass {
class func hello() {
print("hello from MyClassContainer2")
}
}
}
使用时:
MyOuterClass1.MyClass.hello()
MyOuterClass2.MyClass.hello()
<a name="protocol"></a>为扩展类型添加协议一致性
阅读 SnapKit 和 Kingfisher 的代码后,你会发现它们并没有使用类型嵌套,而是是用了一个很巧妙的方法来实现的: 自定义一个类并且提供一个协议来完成
下面我们看一下如何隔离我们的工具类:
1.先定义一个泛型工具类
TTAUtils<Base>,并提供一个对应泛型的属性和一个初始化方法2.定义一个泛型协议,在协议中定义一个工具类只读的一个实例属性和一个类型属性,用来调用你工具类的方法,在协议扩展中分类给定两个默认实现,分别返回一个 TTAUtils 的实例和 TTAUtils 的类型
3.然后给你要扩展的类型在扩展中添加协议一致性
Show you the code!
public final class TTAUtils<Base> {
public let base: Base
public init(_ base: Base) {
self.base = base
}
}
public protocol TTAUtilsCompatiable {
associatedtype CompatiableType
var tta: CompatiableType { get }
static var ttaClass: CompatiableType.Type { get }
}
public extension TTAUtilsCompatiable {
public var tta: TTAUtils<Self> {
return TTAUtils(self)
}
public static var ttaClass: TTAUtils<Self>.Type {
return TTAUtils<Self>.self
}
}
extension NSObject: TTAUtilsCompatiable { }
上面的准备工作做好了,下面我们来为类型添加协议一致性
/// 为 TTAUtils 类添加扩展方法
extension TTAUtils where Base: UIImageView {
public func setImageWithURL(url: URL?, placeholderImage: UIImage?) {
print(url ?? "not a url")
}
}
如果添加的类型是结构体类型,需要一些额外的工作:
/// 定义一个结构体类型
public struct StringProxy {
fileprivate let base: StringTTAUtilsCompatiable
init(proxy: String) {
base = proxy
}
}
/// 为 String 结构体添加协议一致性,并实现对应的属性 `getter`
extension String: TTAUtilsCompatiable {
public var tta: StringProxy {
return StringProxy(proxy: self)
}
}
/// 为自定义结构体添加扩展方法
extension StringProxy {
public func printAString() {
print(base)
}
}
使用:
/// 类类型
let imageView = UIImageView(frame: CGRect(x: 0, y: 0, width: 80, height: 80))
imageView.backgroundColor = .blue
imageView.center = aView.center
aView.addSubview(imageView)
imageView.tta.setImageWithURL(url: URL(string: "Here is a image url string"), placeholderImage: nil)
/// 结构体类型
let string = "Hello world"
string.tta.printAString()
总结
以上两种方法,我个人更推荐第二种方法(为扩展类型添加协议一致性)
因为这种方法,可以让你:
1.很灵活的扩展任何想要扩展的类型
2.调用起来可以与主流框架(SnapKit, Kingfisher) 类似,又可以与我们习惯的 OC 写法想对应!
