Swift之Associated Object

yungfan· 2019-10-03

介紹

Swift 可以利用 OC 的 runtimeKVC ,在運行時向一個對象添加值存儲,這種方式稱之為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)
        }      
    }
}
奔驰宝马机漏洞玩法