优雅地使用 Selector - Swift

〇. 不够优雅的 #selector

Swift 中的 Selector 就是 Objective-C 中的 SEL, 在 SWift 中重新封装成结构体, 并扩展了一些方法。也同样提供了使用字符串的进行初始化。

// 官方定义
public struct Selector : ExpressibleByStringLiteral {
    /// Create a selector from a string.
    public init(_ str: String)
    /// Create an instance initialized to `value`.
    public init(stringLiteral value: String)
}

但是出于字符串操作的不安全性,封装了类似宏类型的语法糖 #selector,允许使用编辑器的自动补全功能,杜绝了直接使用字符串导致错误的可能,同时还会检查当前的方法是否支持动态派发。

但是每次使用#selector 都感觉不顺手,介于 #selector 不够优雅,我们可以对其进行优化。


一. 使用 Struct 进行封装
// 定义
struct Action {
  static let tapped: Selector = #selector(SomeClass.tap(_:))
}
// 使用
button.addTarget(self, action: Action.tapped, for: .touchUpInside)

OK,使用结构体的方式,我们终于可以在实际使用的地方避免了使用 #selector, 但是每次都定义一个 Action 吗? 这样不免会让人感觉很累赘。

二. 使用 Extention 进行封装
// 定义
extension Selector {
    static let tapped: Selector = #selector(SomeClass.tap(_:))
}
// 使用
button.addTarget(self, action: .tapped, for: .touchUpInside)

好了,使用扩展的方式,让我们可以直接定义自己的选择器,同时使用类型推断可以省略部分代码,但是其他文件也想使用 tapped 时有问题:

  • 多文件同时使用将导致静态成员混乱,命名被占用。

那么我们为扩展添加权限, 让不同文件可以使用相同的命名:

// A.swift
fileprivate extension Selector {
    static let tapped: Selector = #selector(AClass.tap(_:))
}
// B.swift
fileprivate extension Selector {
    static let tapped: Selector = #selector(BClass.tap(_:))
}

修改后, 实际使用还是有很多问题:

  • 每个方法需要定义一个静态成员,使用麻烦。
  • 不同类的相同方法名需要分别定义静态成员,不可重用。
三. 使用 Protocol 进行封装

为了解决上面的问题,尝试使用 Swift 中最强大的协议进行解决,毕竟 Swift ≈ POP。

//定义
protocol Selectorable {
  var tapAction: Selector { get }
  func tap(_ sender: UIButton)
}
// 实现
class Person: Selectorable {
  var tapAction: Selector {
    return #selector(tap(_:))
  }
  func tap(_ sender: UIButton) {
    print("that's all right")
  }
}

使用协议后,同时解决了上面的几个问题,文件间不会造成冲突也不需要每个文件都去重新定义静态成员。 但是每次都实现属性和方法稍显累赘,是否可以进行优化,只在需要的时候重写?

使用 Protocol Extension 来提供默认的实现:

// 添加默认实现
extension Selectorable {
  var tapAction: Selector {
    return  #selector(Self.tap(_:))
  }
}

可添加实现后,会出现 error: Argument of '#selector' refers to instance method 'tapButton' that is not exposed to Objective-C (必须要将该方法暴露给 Objective-C runtime)。

那么我们为该方法添加 @objc 修饰符,同时因为协议内包含有 @objc 的方法,则协议本身必须是 @objc, 也就是整个协议注册到 Objective-C runtime 使用动态派发。 那么,问题来了,在 Swift 中协议的扩展只可以采用静态派发[1],所以我们在协议扩展内的默认实现也是静态派发的,不满足整个协议动态的要求(编写时也会出现预处理错误),那么一切又回到了原点,我们需要实现协议内所有的属性和方法。

但是,你可还记得 Selector 提供了字符串的初始化方法,这样我们就可以使用字符串初始化[2] Selector 来逃过编译器的语法检查:

// 添加默认实现
extension Selectorable {
  var tapAction: Selector {
    return Selector("tap:")
  }
}

OK, 这样明目张胆逃过编译器的语法检查,就出现了 warning: Use '#selector' instead of explicitly constructing a 'Selector' (建议使用 #selector 来避免显式地调用初始化方法),但是这就是我们的目的。由于 Swift 并没有实现预处理器,所以 Objective-C 内的 #pragma[3] 在这里并不能使用.

警告先不管, 现在看起来就可以比较方便地使用了:

// 定义
protocol Selectorable {
  var tapAction: Selector { get }
  func tap(_ sender: UIButton)
}
extension Selectorable {
  var tapAction: Selector {
    return Selector("tap:")
  }
}
// 实现
class Person: Selectorable {
  func tap(_ sender: UIButton) {
    print("that's all right")
  }
}

我们可以将项目中比较常用的一些 Selector 抽象到协议内,如自定义的返回,编辑操作:

// 定义
protocol Selectorable {
  var tapAction: Selector { get }
  func tap(_ sender: UIButton)
  
  var backAction: Selector { get }
  func back(_ sender: UIButton)
  
  var editAction: Selector { get }
  func edit(_ sender: UIButton)
}
extension Selectorable {
  var tapAction: Selector { return Selector("tap:") }
  var backAction: Selector { return Selector("back:") }
  var editAction: Selector { return Selector("edit:") } 
}
// 实现
class Person: Selectorable {
  func tap(_ sender: UIButton) {}
  func back(_ sender: UIButton) {}
  func edit(_ sender: UIButton) {}
}

看起来不错,但是,你也应该发现了,不管我们需不需要这个方法,我们都必须实现协议内的所有方法,但是如果为协议的方法添加修饰符 optional,那么势必将整个 Protocol 标志为 @objc,那么又回到之前提到的问题:协议扩展内的默认实现将失效。

那么换一种思路,在协议扩展内实现所有的默认实现(但是实现将不会被调用[4]):

// 扩展实现
extension Selectorable {
  var tapAction: Selector { return Selector("tap:") }
  var backAction: Selector { return Selector("back:") }
  var editAction: Selector { return Selector("edit:") }
  /*this is just a placeholder, and the function will never be invoked \
    because of static dispatch*/
  func tap(_ sender: UIButton) {}
  func back(_ sender: UIButton) {}
  func edit(_ sender: UIButton) {}
}
class Person: Selectorable {
 // 默认不需要实现任何方法, 按需实现对应的方法即可
}

一切OK, 接下来在实际项目中运行,抛出了我们熟悉的运行时错误: unrecognized selector send to instance 0x00000123456。 为什么抛出该错误:

因为没有实现该方法,你肯定在 Objective-C 中遇见过。

那么实现了协议中的方法,运行,可还是抛出相同错误!

因为实现了该方法,但是没有注册到运行时。

为什么还要注册到运行时呢? 是否还记得我们之前逃过编译器语法检查的事? 大家肯定知道,Target-Action 使用的就是 Objective-C Runtime 的消息机制,而类中对于协议的实现默认是使用函数表派发 (Virtual Dispatch) 的,这就导致 Selector 找不到对应的函数实现,那么我们可以使用 @objc 将方法注册到 Runtime 解决该错误。

完成后运行,ALL RIGHT!

当然,也还有一些问题,暂时没有找到解决思路

  • 由于 Swift 不支持预处理器,我们不能在代码中添加指令去忽略这个警告,但是可以在 Building Setting 内搜索 warning 来解除警告.
  • 有时候我们需要很多很多的 Selector 用来处理各种不同的按钮事件,通知事件,有一些只需要调用一次,如果把只需要调用一次的事件写入协议,将会造成协议庞大难以维护。 如果不写入协议,那么将会造成同一份代码内有两种方式书写 selector 调用,一种是原始的 #selector,另一种是协议的方式。
  • 逃过编译器检查,势必会造成一些编写造成的错误,例如忘记在遵循的协议方法前添加 @objc。

  1. Protocol 默认使用 Virtual Dispatch, 使用数组保存函数, 扩展内的函数不能添加到表尾。

  2. 可自行查阅 Swift 中的方法转换成 Objective-C 方法的规则。

  3. Clang Warning 查阅表 http://fuckingclangwarnings.com

  4. 当遵循协议的类没有实现方法,使用 Target-Action 调用协议默认实现时,由于协议默认实现为静态派发, 不会注册到 Runtime,所以 Selector 获取不到默认实现的函数, 抛出错误。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,755评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,369评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,799评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,910评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,096评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,159评论 3 411
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,917评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,360评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,673评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,814评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,509评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,156评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,123评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,641评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,728评论 2 351

推荐阅读更多精彩内容