[Swift] Swift의 우체국, NotificationCenter

NotificationCenter 

옵저버 패턴? 발행-구독 패턴?

이전 포스트에서 옵저버 패턴과 펍섭패턴으로 불리는 발행-구독 패턴을 정리한 적이 있었습니다. 두 패턴에 대한 이해가 있으면 훨씬 더 재미있으니 두 포스트를 먼저 참고해주세요! [옵저버패턴][펍섭패턴] 스위프트의 NotificationCenter는 발행-구독 패턴과 유사하게 동작합니다. 발행-구독 패턴에서 이벤트 브로커에 해당하는 중개자의 역할을 NotificationCenter 객체가 하게되죠. NotificationCenter라는 이름처럼 자신에게 등록된 친구들에게 알림을 보내주는 객체가 NotificationCenter입니다!

용어 정리

먼저 NotificationCenter에서 사용하는 용어부터 정리하겠습니다.

NotificationCenter

앞서 설명한 것처럼, NotificationCenter는 객체로부터 어떤 이벤트를 받아 자신에게 등록된 객체들에게 알림을 보내주는 객체입니다. NotificationCenter는 싱글톤으로 구성되어 있어 사용자가 인스턴스를 만들지 않고 NotificationCenter를 부를 수 있습니다. 동시에 싱글톤이기 때문에 발생하는 문제점도 있는데요, A와 B라는 객체가 있을 때, 어떤 이벤트를 A만 받게 하고 싶어도 A와 B는 NotificationCenter의 싱글톤 인스턴스를 공유하기 때문에 두 객체가 모두 알림을 받게 됩니다. 물론 이 문제를 해결할 수 있는 방법도 있습니다! 아래에서 더 자세히 설명해볼게요~!

Observer

옵저버 패턴의 Observer라는 용어를 기억하시나요? NotificationCenter의 Observer는 NotificationCenter에 자신의 정보를 등록하여 알림을 받고자 하는 객체를 의미합니다. 모든 객체는 Observer가 될 수도 있고, 이벤트를 보내는 객체가 될 수도 있습니다.

Post

Post는 객체가 NotificationCenter로 이벤트를 보내는 행위를 의미합니다. 발행-구독 패턴에서 발행에 해당된다고 생각하면 되겠죠?

Notification

Notification은 이벤트를 발행하는 객체가 NotificationCenter에 보내는 이벤트를 의미합니다. 

NotificationName

위에서 NotificationCenter는 싱글톤이라고 했었죠? 그럼 이벤트를 여러 개 만들고 싶을 때는 어떻게 할까요? 예를 들어, 색상을 바꾸는 알림, 선 두께를 바꾸는 알림을 보내고자 한다면, 싱글톤인 NotificaionCenter는 자신에게 보내지는 이벤트가 어떤 이벤트인지 알고 있어야 합니다. 그래서 이벤트를 보내는 객체는 NotificationName이라는 식별자를 NotificationCenter에 알려주어서 이를 구분할 수 있게 합니다.

사용해보기

그럼 이제 간단한 예제를 통해서 주요한 기능들을 사용해보겠습니다!

import Foundation

class Chatter {
    let name: String
    let isMaster: Bool
    
    init(name: String, isMaster: Bool) {
        self.name = name
        self.isMaster = isMaster
    }
    
    func join(to room: GroupChatRoom) {
    }
    func send(message: String, to room: GroupChatRoom) {
    }
    func sendToMaster(message: String, to room: GroupChatRoom) {
    }
}

class GroupChatRoom {
    let name: String
    init(name: String) {
        self.name = name
    }
    func send(message: String, senderName: String) {
    }
    func sendToMaster(message: String, senderName: String) {
    }
}

먼저 아주 기본적인 구현을 해두었습니다. 그룹채팅방을 표현하는 GroupChatRoom은 사용자들이 보내는 메시지를 이 방에 가입된 모든 사용자들에게 전달하는 역할을 합니다. 각 사용자들은 이름과, 방장인지 여부에 대한 정보만 가지고 있습니다. 그리고 특정한 그룹채팅방에 가입하거나, 해당 방에 메시지를 보낼 수도 있습니다. 이 예제에서의 목표는 사용자들이 보내는 메시지를 GroupChatRoom을 통해 채팅방에 가입된 다른 사용자들에게 뿌려주는 것입니다. 

 

제가 원하는 시나리오는 이렇습니다:

 

1. 그룹 채팅방에 가입하면 자동으로 Observer가 된다.
2. 사용자들은 "SendMessage"라는 NotificationName으로 자신이 보내고자 하는 메시지를 이벤트로 발행할 수 있다. 
3. 사용자들은 "SendMessage"에 대한 알림을 받으면 자신의 이름과 받은 메시지를 출력한다.
4. 사용자들은 "SendMessageToMaster"라는 NotificationName으로 방장에게만 메시지를 보내는 이벤트를 발행할 수 있다.
5. 메시지들은 한 채팅방 내에서만 유효하고 다른 채팅방에는 전송되지 않는다. 

그럼 위 시나리오를 그대로 구현해보도록 합니다!

1. 그룹채팅방에 가입하면 자동으로 Observer가 된다.

사용자들이 가입을 할 때, 옵저버로 등록을 해주면 되는데요, NotificationCenter에서는 addObserver 메서드를 제공합니다.

func addObserver(
		_ observer: Any, 
        selector aSelector: Selector, 
        name aName: NSNotification.Name?, 
        object anObject: Any?
        )

이렇게 addObserver와 네 가지 파라미터가 있습니다. 각 파라미터는 공식문서에 나와있는 대로 정리해보겠습니다!

observer

옵저버로 등록할 객체를 넣어줍니다. 우리의 예시에서는 채팅방에 참여하는 각 참여자들의 인스턴스를 넣어주면 되겠네요.

aSelector

aSelector는 옵저버가 Notification을 받았을 때 수행할 작업이 무엇인지 표시합니다. Object-C 함수를 정의하고 함수의 이름을 selector로 작성해줄 수 있습니다. 우리는 메시지를 받았을 때 이름과 받은 메시지를 출력기로 했으니 이에 대한 로직을 구현한 함수를 추가해주면 되겠죠?

aName

name은 전달받은 Notification의 이름을 적습니다. 이 옵저버들이 어떤 이벤트를 받을지 여기서 결정할 수 있습니다. 만약 nil을 값으로 넣으면 NotificationName을 고려하지 않고 모든 Notification을 받게 됩니다. 우리가 보낼 이벤트는 두 종류였죠? SendMessage, SendMessageToMaster를 이곳에 등록해보면 어떨까요?

anObject

이 파라미터를 통해서 Notification을 보내는 객체를 특정할 수 있습니다. 우리의 예시에서는 여러 채팅방끼리는 메시지를 공유하면 안 되기 때문에 자신이 속한 채팅방에서 오는 메시지만 받도록 해야겠네요. 

 

그럼 구현해볼까요?

func join(to room: GroupChatRoom) {
    NotificationCenter.default.addObserver(
        self,
        selector: #selector(didReceiveMessage(_:)),
        name: Notification.Name("SendMessage"),
        object: room
    )
    if self.isMaster {
        NotificationCenter.default.addObserver(
            self,
            selector: #selector(didReceiveMessageToMaster(_:)),
            name: Notification.Name("SendMessageToMaster"),
            object: room
        )
    }
}

Chatter 클래스에 join 메서드를 위와 같이 구현하였습니다. 각 사용자들은 join 메서드를 호출해서 자신이 가입할 채팅방 객체를 지정할 수 있습니다. 가입되는 순간에 가입한 채팅방에 대한 Observer로 사용자들을 등록해야 하는데요, 이를 위해서 addObserver 메서드를 호출하고 인자를 다음과 같이 설정했습니다. 

 

1. observer: self - 채팅방에 가입한 사용자 자기 자신을 NotificationCenter에 등록합니다.
2. selector: #selector(didReceiveMessage) - 이벤트에 대한 알림을 받았을 때 실행할 메서드를 지정합니다. 여기서는 didReceiveMessage로 지정했습니다. 이제 같은 클래스 내부에 해당 함수를 구현해주어야 합니다.
3. name: Notification.Name("SendMessage"): Notification의 이름을 SendMessage로 하기로 했었죠? 그대로 설정했습니다.
4. object: room - 채팅방에 가입된 사용자들 여러 채팅방 중에서 자신이 가입한 채팅방에서 오는 메시지만 받아야 합니다. 그래서 발신자 객체를 가입한 채팅방으로 지정했습니다.

그리고 위와 같은 방법으로 만약 사용자가 방장일 경우에는 방장에게 보내는 메시지에 대한 Observer를 추가적으로 등록하게 했습니다. selector에 넣어주었던 메서드는 다음과 같이 구현할 수 있습니다. 

    @objc func didReceiveMessage(_ notification: Notification) {
    	print("receive")
    }
    @objc func didReceiveMessageToMaster(_ notification: Notification) {
    	print("receive from member to master")
    }

지금은 일단 이렇게 단순하게 구현해두겠습니다. NotificationCenter에 지정하는 메서드는 항상 적어도 한 개의 파라미터를 가집니다. Notification으로 전달되는 메시지를 나타내는 객체입니다. 

 

2. 사용자들은 "SendMessage"라는 NotificationName으로 자신이 보내고자 하는 메시지를 이벤트로 발행할 수 있다. 

이제 메시지를 이벤트로 발행해보겠습니다. 아까 만들었던 Chatter 객체와 GroupChatRoom 객체의 send 메서드를 구현하면 되겠죠?

func send(message: String, to room: GroupChatRoom) {
        room.send(message: message, senderName: self.name)
}
func sendToMaster(message: String, to room: GroupChatRoom) {
        room.sendToMaster(message: message, senderName: self.name)
}

Chatter에 있는 메서드는 단순하게 자신의 이름을 포함해서 GroupChatRoom에 전달해주면 됩니다. 

 

그리고 이렇게 호출되는 GroupChatRoom 객체의 send 메서드는 다음과 같이 구현해봅시다.

func send(message: String, senderName: String) {
        NotificationCenter.default.post(
            name: Notification.Name("SendMessage"), 
            object: self, 
            userInfo: ["message":message, "room":self.name, "senderName":senderName]
        )
}
func sendToMaster(message: String, senderName: String) {
        NotificationCenter.default.post(
            name: Notification.Name("SendMessageToMaster"), 
            object: self, 
            userInfo: ["message":message, "room":self.name, "senderName":senderName]
        )
}

GroupChatRoom은 자신이 직접 메시지를 전달하지 않고, NotificationCenter로 자신을 발신자로 하여 이벤트를 보냅니다. 이를 위해서 NotificationCenter의 post 메서드를 사용합니다.

func post(
    name aName: NSNotification.Name, 
    object anObject: Any?, 
    userInfo aUserInfo: [AnyHashable : Any]? = nil
)

post 메서드의 정의는 위와 같습니다. 앞에서 정의했던 addObserver 메서드와 대응되는 파라미터가 보이죠?

 

name 파라미터에는 보내고자 하는 Notification의 이름을 적어줍니다. object에는 이 Notification을 보내는 발신자 객체를 담고, userInfo에는 추가적인 데이터들을 담아 보냅니다.

💡 object 파라미터에는 데이터를 담는 게 아닙니다! object에 들어가는 객체의 정보로 addObserver를 사용했을 때 정의한 발신자를 식별하기 때문에 object에는 발신자 객체를 담고 함께 전달하고자 하는 데이터들은 userInfo에 담는 것이 원칙입니다.

userInfo에 담을 데이터는 딕셔너리로 구성합니다. 우리의 예제에서는 발신자 정보에 그룹채팅방 객체를 담고, 메시지, 메시지를 보내는 사람의 이름, 채팅방의 이름을 담아서 Notification을 보냅니다. 

 

3. 사용자들은 "SendMessage"에 대한 알림을 받으면 자신의 이름과 받은 메시지를 출력한다.

아까 잠시 미루어두었던 Chatter 객체의 메서드를 구현할 차례입니다. 이벤트를 성공적으로 받으면 addObserver 메서드를 호출할 때 selector 인자에 추가해주었던 메서드가 실행됩니다. 그리고 인자로 Notification 객체가 전달되죠. Notification 객체 안에는 Notification을 보낼 때 담았던 정보가 포함됩니다. 우리는 Notification을 보낼 때, userInfo에 정보들을 담았기 때문에 이를 사용하도록 메서드를 구성해주겠습니다,

 

    @objc func didReceiveMessage(_ notification: Notification) {
        guard let roomName = notification.userInfo?["room"] as? String,
              let message = notification.userInfo?["message"] as? String,
              let sender = notification.userInfo?["senderName"] as? String else { return }
        print("\(roomName)-\(sender)로부터의 메시지: \(message) | \(self.name) 수신완료")
    }
    @objc func didReceiveMessageToMaster(_ notification: Notification) {
        guard let roomName = notification.userInfo?["room"] as? String,
              let message = notification.userInfo?["message"] as? String,
              let sender = notification.userInfo?["senderName"] as? String else { return }
        print("\(roomName)-\(sender)로부터의 비밀메시지: \(message) | \(self.name) 수신완료")
    }

 

메서드가 호출되면 전달된 Notification 객체에서 userInfo를 찾습니다. 여기에는 딕셔너리로 전달한 데이터가 담겨 있겠죠? 그래서 Notification을 보낼 때 사용했던 키 값들을 그래도 사용해서 데이터를 읽어와 출력합니다. String으로 다운 캐스팅을 시도하는 부분이 있는데요, 이유는 post 메서드의 원형을 다시 보면 알 수 있습니다. 

userInfo aUserInfo: [AnyHashable : Any]? = nil)

userInfo는 딕셔너리의 값으로 Any타입을 가집니다. 타입이 특정되지 않았기 때문에 Notification을 받은 메서드는 전달된 데이터의 타입을 알 수가 없으니 원하는 타입으로 캐스팅을 해주어야 합니다.

 

여기까지 했다면 일단 완성입니다! 한번 실행해볼까요?

let park = Chatter(name: "박중사", isMaster: true)
let han = Chatter(name: "한호열", isMaster: false)
let ahn = Chatter(name: "안준호", isMaster: false)
let dpRoom = GroupChatRoom(name: "DP")

park.join(to: dpRoom)
han.join(to: dpRoom)
ahn.join(to: dpRoom)

park.send(message: "야", to: dpRoom)
han.sendToMaster(message: "박중사님?", to: dpRoom)

// DP-박중사로부터의 메시지: 야 | 박중사 수신완료
// DP-박중사로부터의 메시지: 야 | 한호열 수신완료
// DP-박중사로부터의 메시지: 야 | 안준호 수신완료
// DP-한호열로부터의 비밀메시지: 박중사님? | 박중사 수신완료

잘 동작하네요! 

 

그럼 몇 가지 예외상황도 테스트해보겠습니다. 우리가 정했던 시나리오에서 자신이 가입 그룹채팅방에서 전달되는 메시지만 받는다는 조건이 있었는데요, 그룹채팅방을 하나 더 만들어서 테스트해보겠습니다.

let park = Chatter(name: "박중사", isMaster: true)
let han = Chatter(name: "한호열", isMaster: false)
let ahn = Chatter(name: "안준호", isMaster: false)
let dpRoom = GroupChatRoom(name: "DP")

park.join(to: dpRoom)
han.join(to: dpRoom)
ahn.join(to: dpRoom)

let dpRoomWithoutPark = GroupChatRoom(name: "간부없는 DP 방")
han.join(to: dpRoomWithoutPark)
ahn.join(to: dpRoomWithoutPark)

park.send(message: "야", to: dpRoom)
han.sendToMaster(message: "박중사님?", to: dpRoom)

ahn.send(message: "한호열 상뱀님?", to: dpRoomWithoutPark)
han.send(message: "준호야~~~", to: dpRoomWithoutPark)
han.sendToMaster(message: "박범구 중사님 같이 징계 받읍시다~~~!!!!", to: dpRoomWithoutPark)

간부 없는 채팅방 하나를 만들고, 메시지가 잘 도착하는지, 그리고 방장이 없을 때 메시지가 누구에게 전달되는지 확인해보겠습니다. 

// DP-박중사로부터의 메시지: 야 | 박중사 수신완료
// DP-박중사로부터의 메시지: 야 | 한호열 수신완료
// DP-박중사로부터의 메시지: 야 | 안준호 수신완료
// DP-한호열로부터의 비밀메시지: 박중사님? | 박중사 수신완료
// 간부없는 DP 방-안준호로부터의 메시지: 한호열 상뱀님? | 한호열 수신완료
// 간부없는 DP 방-안준호로부터의 메시지: 한호열 상뱀님? | 안준호 수신완료
// 간부없는 DP 방-한호열로부터의 메시지: 준호야~~~ | 한호열 수신완료
// 간부없는 DP 방-한호열로부터의 메시지: 준호야~~~ | 안준호 수신완료

원하는 시나리오대로 잘 동작하네요~! 이렇게 NotificationCenter를 사용하면 객체 간의 통신을 더 쉽게 만들 수 있습니다! 발행-구독 패턴의 장점처럼, 채팅방은 누가 자신에게 가입되어있는지 정보를 저장할 필요가 없고, 멤버들도 어떤 멤버들이 있는지 못하는 상황에서도 메시지를 성공적으로 전달할 수 있습니다. 시스템 내부적으로 동작하다 보니 디버깅이 어렵다는 단점이 있지만 유용하게 사용할 수 있는 기술인 것 같네요. 

 

긴 글 읽어주셔서 감사합니다~! 잘못된 내용이 있다면 알려주세요!

 

예제 코드 전체