HSNotification 0.3.2

HSNotification 0.3.2

Confused Vorlon维护。



  • 作者
  • ConfusedVorlon

HSNotification

Version License Platform

摘要

Swift更好的通知观察者。

  • 具有合理默认值的简化API
  • 更容易避免'悬空'观察者
  • 简单激活/禁用
  • 简单集成视图控制器生命周期

安装

HSObserver可通过CocoaPods获取。要安装它,请简单地将以下行添加到Podfile中

pod 'HSObserver'

观察者已发布

class Watcher {
    static let wave = NSNotification.Name.init("waveNotification")

    var waveObserver:HSObserver
    init() {
        waveObserver = HSObserver.init(forName: Watcher.wave,
                                           activate:true,
                                           using: { (notif) in
            //Do Something
        })
    }
}

与标准观察者不同,当观察器被释放时,waveObserver也被完全释放。(张贴波浪通知将不会调用//Do Something代码)

观察者可以启用和禁用

    var waveObserver:HSObserver
    init() {
        waveObserver = HSObserver.init(forName: Watcher.wave,
                                           using: { (notif) in
            //Do Something
        })

        //activate
        waveObserver.activate()

        //deactivate
        waveObserver.deactivate()
    }

注意。请记住,您必须激活观察者才能使其工作。

  • 在初始化器中指定 activate:true
  • 或者调用 myObserver.activate()`
  • 或者在初始化器上链式调用 HSObserver.init(....).activate()

HSHasObservers 与 View Controller 生命周期集成良好

对于视图控制器,一个常见的模式是在 viewWillAppear 中激活观察者,并在 viewDidDisappear 中停止激活

HSHasObservers 协议添加到任何类中,可以轻松地添加一组观察者,并激活或停止激活它们。

可以手动添加观察者,或者通过将 .add(to:self) 链接到 HSObserver 来添加。

class ViewController: NSViewController, HSHasObservers {

    override func viewDidLoad() {
        super.viewDidLoad()

        //Add manually
        let waveObserver = HSObserver.init(forName: Watcher.wave,
                                           using: { (notif) in
                                            //Do Something
        })
        self.add(observer: waveObserver)

        //Or by chaining
        HSObserver.init(forName: Watcher.wave,
                            using: { (notif) in
                                //Do Something
        }).add(to: self)
    }
}

这很好地与视图生命周期协同工作

    override func viewWillAppear() {
        super.viewWillAppear()

        activateObservers()
    }

    override func viewDidDisappear() {
        super.viewDidDisappear()

        deactivateObservers()
    }

添加多个观察者

        let manyThingsObserver = HSObserver.init(forNames: [Watcher.wave,Watcher.hello] ,
                                                     activate:true,
                                           using: { (notif) in
                                            //Do Something
        })

指定中心、队列等

    /// Create observer
    ///
    /// - parameter name:  notification name
    /// - parameter obj:   object to observe (default nil)
    /// - parameter queue: queue to run the block on (default main)
    /// - parameter center: notification center (default NotificationCenter.default)
    /// - parameter block: block to run (beware of retain cycles!)
    ///
    /// - returns: unactivated manager. Call activate() to start
    convenience init(forName name: NSNotification.Name,
                     object obj: Any? = nil,
                     queue: OperationQueue? = .main,
                     center newCenter: NotificationCenter = NotificationCenter.default,
                     activate: Bool = false,
                     using block: @escaping (Notification) -> Swift.Void)

HSObservers 允许您跳过默认值。我们假设

  • object = nil
  • queue = .main
  • center = NotificationCenter.default
  • activate = false

您可以在初始化器中覆盖每个值

注意,苹果的默认做法是在发送者相同的队列上调用您的块。如果您想这样做,请只需使用 central = nil

我发现我通常希望使用通知来更新 UI,所以我的默认值是使用 .main

作者

ConfusedVorlon, [email protected]

许可证

HSNotification 在 MIT 许可证下可用。有关更多信息,请参阅 LICENSE 文件。