在日常的开发过程中,我们经常会为Class或Struct添加一些扩展函数或属性以方便使用,可是随着扩展的增多,难免会有视觉上的污染,甚至会让人分不清哪些是系统提供的,哪些是项目中扩展的,这对开发者来说并不是一个好的体验。另一方面,如果定义的扩展是专注于处理某一块业务的,那么这些扩展方法应该被放在一块(这里的放在一块是指在Xcode的api提示框中,这些api能够集中在一起展示),这样的话,使用者就能够快速地查看所有的相关api,减轻了使用者的负担。举个例子,比如你想为String添加一些处理正则的扩展方法,通常情况下,我们会这么做:
extension String{
public func matchs(pattern: String){
//xxxx
}
public func isMatch(pattern: String){
//xxxx
}
public func replace(pattern: String, with string: String){
//xxxx
}
}
然后当使用者想用这个api时,如果使用者对api的名称记得不是很清楚,那么他就得去查看源码文件,从而找到有哪些可使用api,这一步对使用者来说略显繁琐。解决这个问题的办法很简单,只需降低使用者的记忆负担,让使用者只需记得一件事:所有正则处理相关api都被扩展到了String.regex这个属性的类型上了。这样一来,使用者只需记住”regex”这个单词,便可以以此单词为索引查看到所有相关api(当然,这里是不需要点到源码文件的,不需要切换当前工作区),这里的 ‘regex’ 就可以称之为’命名空间’。
下面看一下这种方案的简单实现:
class StringRegexNameSpace{
private var _originStr: String
init(_ originStr: String) {
_originStr = originStr
}
public func matchs(pattern: String){
//xxxx
}
public func isMatch(pattern: String){
//xxxx
}
public func replace(pattern: String, with string: String){
//xxxx
}
}
extension String{
var regex: StringRegexNameSpace{
return StringRegexNameSpace(self)
}
}
上面代码很简单,就不多做解释了。接着看一下调用时的体验:
很明显,提示很清爽,没有任何多余无关api,调用者可以很轻松的选择自己想使用的api。对比一下传统的方式:
很明显,传统方式提示了一大堆api,使用者要么通过几个关键字定位到目标api,要么就只能一个个查看。
上面的方案看起来没什么问题,有的三方库也是这么做的,比如 SnapKit, 但是假如我们正在开发的是一个工具类或者是一个较为复杂的模块,需要给很多类添加扩展,难道我们要为每个类都这么定义一个 XXNameSpace 吗?这样也未免太过繁琐了,于是便有了下面这种方案,下面这个方案分为两个部分:
part1 实现一种模式:使用这种模式能够快速定义具有命名空间的扩展
public protocol NameSpaceCompatible {
associatedtype ExtensionTargetType
var xxxNameSpace: NameSpaceWrapper<ExtensionTargetType> { get }
}
public final class NameSpaceWrapper<T>{
private var _base: T
internal init(_ base: T) {
_base = base
}
}
public extension NameSpaceCompatible{
public var xxxNameSpace: NameSpaceWrapper<Self> {
return NameSpaceWrapper<Self>(self)
}
}
part2 使用这种模式,定义具有命名空间的扩展
extension String: NameSpaceCompatible{}
extension NameSpaceWrapper where T == String{
public func matchs(pattern: String){
//xxxx
}
public func isMatch(pattern: String){
//xxxx
}
public func replace(pattern: String, with string: String){
//xxxx
}
}
之后我们如果要给某个类添加命名空间扩展,只需参照part2的部分就可以了。
上述方案主要是利用了泛型约束这个特性,根据不同的具体类型做扩展。
遇到的问题:
理论上,上述的方案没啥问题,然而在实际使用中发现,某些情况下Xcode会把不属于某个具体类型的扩展api也提示出来(这应该是Xcode的一个bug)。比如:
clz2Func() 虽然有提示出来,但实际是不能用的,
然后经过不断的尝试,发现改成如下形式就不会有问题:
这两种方式区别是在于extension 中 where 语句对泛型类型的约束方式, ==
用来表明T是某种类型,而 :
表示 T 是某种类型或其子类,
虽然此例中使用:
解决了问题,但是如果要给Struct扩展,那么就没法用:
(因为Swift中Struct不可以被继承,所以不存在子类型一说)。 所以,如果对结构体做扩展,那么还是得用最初提到的那种方案去实现(如果你不是非常care api提示框中的污染,那么用这种方案也是ok的)。
最后,如果哪天Xcode解决了这个问题,自然就皆大欢喜了。