36.Swift学习之Associated Object
- 2019 年 10 月 10 日
- 筆記
介绍
Swift 可以利用 OC 的 runtime 和 KVC ，在运行时向一个对象添加值存储，这种方式称之为Associated Object。在使用 extension 扩展现有类的功能时，使用Associated Object的方式，可以将一个值 “关联” 到已有的要扩展的类上。该知识点在 iOS 开发中使用往往能优雅地解决很多问题。
关键API
/// 获取关联值 /// - Parameter object: 源对象，一般为 self，给谁关联参数，就填入谁 /// - Parameter key: 关键字，相当于一个标识，通过该标识可以拿到值 public func objc_getAssociatedObject(_ object: Any, _ key: UnsafeRawPointer) -> Any? /// 设置关联值 /// - Parameter object: 同上 /// - Parameter key: 同上 /// - Parameter value: 关联的对象，具体的关联的值 /// - Parameter policy: 关键策略，需要熟悉OC才能理解 public func objc_setAssociatedObject(_ object: Any, _ key: UnsafeRawPointer, _ value: Any?, _ policy: objc_AssociationPolicy)
案例
- 示例
class Person { } extension Person { private struct AssociateKeys { static var key: Void? } var name: String? { get { return objc_getAssociatedObject(self, &AssociateKeys.key) as? String } set { objc_setAssociatedObject(self, &AssociateKeys.key, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC) } } } // 进行关联后，在对这个目标对象访问的时候，就像是直接在通过属性访问一样，非常方便 let p = Person() p.name = "Zhangsan" print(p.name!)
注意 AssociateKeys中出现了一个奇怪的写法，这里的key的类型声明为了 Void?，并且通过 & 操作符取地址并作为 UnsafeRawPointer<Void> 类型被传入，这在 Swift 与 C 协作和指针操作时是一种很常见的用法。
- 给 UINavigationController 扩展一个
disablePopGesture属性
extension UINavigationController { private struct AssociateKeys { static var key: Void? // 也可以直接这样写 // static var disablePopGesture = "disablePopGesture" } var disablePopGesture: Bool { get{ return objc_getAssociatedObject(self, &AssociateKeys.key) as? Bool ?? false } set{ objc_setAssociatedObject(self, &AssociateKeys.key, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC) } } } UINavigationController().disablePopGesture = true
- 扩展 UIButton 点击事件
class ViewController: UIViewController { override func viewDidLoad() { super.viewDidLoad() let btn: UIButton = UIButton(type: .contactAdd) btn.center = self.view.center btn.addAction(event: .touchUpInside) { (self) in print("Button click") } self.view.addSubview(btn) } } extension UIButton { private struct AssociateKeys { static var key: Void? } func addAction(event: Event, _ action: ((UIButton)->Void)?){ // 通过objc_setAssociatedObject将闭包保存 objc_setAssociatedObject(self, &AssociateKeys.key, action, .OBJC_ASSOCIATION_RETAIN_NONATOMIC) addTarget(self, action: #selector(itemClick(button:)), for: event) } @objc private func itemClick(button: UIButton){ // 点击按钮，通过objc_getAssociatedObject获取之前保存的闭包并调用 if let block = objc_getAssociatedObject(self, &AssociateKeys.key) as? ((UIButton)->Void){ block(button) } } }
- UIButton 传参 项目开发中，经常会有类似九宫格的菜单按钮，每个按钮的点击时的参数是不一样的，此时可以有如下几种方案：
- 创建 9 个按钮，逐一设置
- 通过
for创建 9 个UIButton，为UIButton设置不同的tag，然后在点击事件里面用switch case判断 - 自定义
UIButton，添加自定义属性 - 利用
Associated Object绑定参数
class ViewController: UIViewController { // 不同的参数 let params = ["param1", "param2", "param3", "param4", "param5", "param6", "param7", "param8", "param9"] private struct AssociateKeys { static var key: Void? } override func viewDidLoad() { super.viewDidLoad() // 添加按钮 for i in 0..<9 { let btn: UIButton = UIButton(type: .custom) btn.setTitle("(i+1)", for: .normal) btn.setTitleColor(.black, for: .normal) btn.frame = CGRect(x: 100, y: 100 + i*50, width: 30, height: 30) // 绑定参数 objc_setAssociatedObject(btn, &AssociateKeys.key, params[i], .OBJC_ASSOCIATION_COPY) btn.addTarget(self, action: #selector(itemClick(button:)), for:.touchUpInside) self.view.addSubview(btn) } } @objc private func itemClick(button: UIButton){ // 取出参数 if let param = objc_getAssociatedObject(button, &AssociateKeys.key) as? String{ print(param) } } }
