如何在 Swift 3 中创建自定义通知?

How do you create custom notifications in Swift 3?

在Objective-C中,自定义通知只是一个普通的NSString,但在Swift3的WWDC版本中并不明显。

Notification.post 定义为:

public func post(name aName: NSNotification.Name, object anObject: AnyObject?)

在 Objective-C 中,通知名称是一个普通的 NSString。在Swift中定义为NSNotification.Name.

NSNotification.Name 定义为:

public struct Name : RawRepresentable, Equatable, Hashable, Comparable {
    public init(_ rawValue: String)
    public init(rawValue: String)
}

这有点奇怪,因为我希望它是一个枚举,而不是一些似乎没有更多好处的自定义结构。

NSNotification.Name 的通知中有一个类型别名:

public typealias Name = NSNotification.Name

令人困惑的部分是 Notification 和 NSNotification 都存在于 Swift

因此,为了定义您自己的自定义通知,请执行以下操作:

public class MyClass {
    static let myNotification = Notification.Name("myNotification")
}

然后调用它:

NotificationCenter.default().post(name: MyClass.myNotification, object: self)

有一种更简洁的(我认为)方法可以实现它

extension Notification.Name {

    static let onSelectedSkin = Notification.Name("on-selected-skin")
}

然后就可以这样使用了

NotificationCenter.default.post(name: .onSelectedSkin, object: selectedSkin)

这只是参考

// Add observer:
NotificationCenter.default.addObserver(self,
    selector: #selector(notificationCallback),
    name: MyClass.myNotification,
    object: nil)

    // Post notification:
    let userInfo = ["foo": 1, "bar": "baz"] as [String: Any]
    NotificationCenter.default.post(name: MyClass.myNotification,
        object: nil,
        userInfo: userInfo)

您可以将自定义初始化程序添加到 NSNotification.Name

extension NSNotification.Name {
    enum Notifications: String {
        case foo, bar
    }
    init(_ value: Notifications) {
        self = NSNotification.Name(value.rawValue)
    }
}

用法:

NotificationCenter.default.post(name: Notification.Name(.foo), object: nil)

更简单的方法:

let name:NSNotification.Name = NSNotification.Name("notificationName")
NotificationCenter.default.post(name: name, object: nil)

您也可以为此使用协议

protocol NotificationName {
    var name: Notification.Name { get }
}

extension RawRepresentable where RawValue == String, Self: NotificationName {
    var name: Notification.Name {
        get {
            return Notification.Name(self.rawValue)
        }
    }
}

然后将您的通知名称定义为 enum 任意位置。例如:

class MyClass {
    enum Notifications: String, NotificationName {
        case myNotification
    }
}

并像

一样使用它
NotificationCenter.default.post(name: Notifications.myNotification.name, object: nil)

这样通知名称将与 Foundation 分离 Notification.Name。如果 Notification.Name 的实施发生变化,您只需修改协议。

NSNotification.Name(rawValue: "myNotificationName")

我做了我自己的实现,混合了各种各样的东西,发现这是最方便的。分享给可能感兴趣的人:

public extension Notification {
    public class MyApp {
        public static let Something = Notification.Name("Notification.MyApp.Something")
    }
}

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        NotificationCenter.default.addObserver(self,
                                               selector: #selector(self.onSomethingChange(notification:)),
                                               name: Notification.MyApp.Something,
                                               object: nil)
    }

    deinit {
        NotificationCenter.default.removeObserver(self)
    }

    @IBAction func btnTapped(_ sender: UIButton) {
        NotificationCenter.default.post(name: Notification.MyApp.Something,
                                      object: self,
                                    userInfo: [Notification.MyApp.Something:"foo"])
    }

    func onSomethingChange(notification:NSNotification) {
        print("notification received")
        let userInfo = notification.userInfo!
        let key = Notification.MyApp.Something 
        let something = userInfo[key]! as! String //Yes, this works :)
        print(something)
    }
}

使用枚举的好处是我们可以让编译器检查名称是否正确。减少潜在问题并使重构更容易。

对于那些喜欢使用枚举而不是带引号的字符串作为通知名称的人来说,这段代码可以解决问题:

enum MyNotification: String {
    case somethingHappened
    case somethingElseHappened
    case anotherNotification
    case oneMore
}

extension NotificationCenter {
    func add(observer: Any, selector: Selector, 
             notification: MyNotification, object: Any? = nil) {
        addObserver(observer, selector: selector, 
                    name: Notification.Name(notification.rawValue),
                    object: object)
    }
    func post(notification: MyNotification, 
              object: Any? = nil, userInfo: [AnyHashable: Any]? = nil) {
        post(name: NSNotification.Name(rawValue: notification.rawValue), 
             object: object, userInfo: userInfo)
    }
}

那么你可以这样使用它:

NotificationCenter.default.post(.somethingHappened)

虽然与问题无关,但故事板 segues 也可以这样做,以避免输入带引号的字符串:

enum StoryboardSegue: String {
    case toHere
    case toThere
    case unwindToX
}

extension UIViewController {
    func perform(segue: StoryboardSegue) {
        performSegue(withIdentifier: segue.rawValue, sender: self)
    }
}

然后,在您的视图控制器上,将其命名为:

perform(segue: .unwindToX)

如果您使用仅包含字符串的自定义通知,则没有理由扩展任何 类 但 String

    extension String {
        var notificationName : Notification.Name{
            return Notification.Name.init(self)
        }
    }

@CesarVarela 的回答很好,但是为了让代码更简洁一些,您可以执行以下操作:

extension Notification.Name {
    typealias Name = Notification.Name

    static let onSelectedSkin = Name("on-selected-skin")
    static let onFoo = Name("on-foo")
}

我可能会建议另一个与@CesarVarela 建议类似的选项。

extension Notification.Name {
    static var notificationName: Notification.Name {
        return .init("notificationName")
    }
}

这将使您 post 轻松订阅通知。

NotificationCenter.default.post(Notification(name: .notificationName))

希望对您有所帮助。

如果您希望它在同时使用 Objective-C 和 Swift 的项目中干净地工作,我发现在 Objective-C 中创建通知更容易.

创建 .m/.h 文件:

//CustomNotifications.h
#import <Foundation/Foundation.h>

// Add all notifications here
extern const NSNotificationName yourNotificationName;
//CustomNotifications.m
#import "CustomNotifications.h"

// Add their string values here
const NSNotificationName yourNotificationName = @"your_notification_as_string";

在您的 MyProject-Bridging-Header.h(以您的项目命名)中将它们公开给 Swift。

#import "CustomNotifications.h"

像这样在 Objective-C 中使用您的通知:

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(yourMethod:) name:yourNotificationName:nil];

并且在 Swift (5) 中像这样:

NotificationCenter.default.addObserver(self, selector: #selector(yourMethod(sender:)), name: .yourNotificationName, object: nil)