[TIL] 20231205

KVO(Key-value observing)

[공식 문서 번역]

Key-value observing은 다른 개체의 속성에 대한 변경 사항을 개체에게 알릴 때 사용하는 Cocoa 프로그래밍 패턴입니다. 모델 간, 뷰 간 등 논리적으로 분리된 앱의 부분 간의 변경 사항을 전달하는 데 유용합니다. Key-value observing은 오직 NSObject에서 상속되는 클래스와 함께 사용할 수 있습니다.

 

정리

• Key-value Observing은 Cocoa 프로그래밍 패턴
• 프로퍼티가 변경되면 이 사항을 다른 객체에 알리는 데에 사용됨
• 모델과 뷰 처럼 기능적으로 분리되어 있는 부분에서의 정보 전달에 적합
• KVO를 사용하기 위해서는 객체가 NSObject를 상속받아야 함

사용 방법

1. @objc dynamic var

key-value observing 을 통해 관찰하고자 하는 프로퍼티에 @objc 어트리뷰트와 dynamic 키워드를 붙여 KVO를 사용해 관찰가능하도록 해줍니다.

 

class MyObjectToObserve: NSObject {
    @objc dynamic var myDate = NSDate(timeIntervalSince1970: 0) // 1970
    func updateDate() {
        myDate = myDate.addingTimeInterval(Double(2 << 30)) // Adds about 68 years.
    }
}

 

위의 예시 코드와 같이 NSObject를 상속받는 클래스 내의 프로퍼티를 @objc dynamic var로 선언해주면 됩니다.

2. Observer 정의 - observe(_:options:changeHandler:) 

observer 클래스의 인스턴스는 하나 이상의 프로퍼티의 변경 사항에 대한 정보를 관리합니다.

observer를 정의할 때는 관찰하고자 하는 프로퍼티를 참조하는 key path를 가진 observe(_:options:changeHandler:) 메서드를 호출하여 관찰을 시작할 수 있습니다.

 

class MyObserver: NSObject {
    @objc var objectToObserve: MyObjectToObserve
    var observation: NSKeyValueObservation?


    init(object: MyObjectToObserve) {
        objectToObserve = object
        super.init()


        observation = observe(
            \.objectToObserve.myDate,
            options: [.old, .new]
        ) { object, change in
            print("myDate changed from: \(change.oldValue!), updated to: \(change.newValue!)")
        }
    }
}

 

위의 코드는 NSKeyValueObservatedChange 인스턴스의 oldValue와 newValue를 사용하여 관찰 중인 프로퍼티에 대해 변경된 내용을 확인합니다.

프로퍼티가 어떻게 변경되었는지 알 필요가 없으면 options 파라미터를 생략하면 됩니다. options 파라미터를 생략하면 새로운 프로퍼티 값과 변경 전 프로퍼티 값이 저장되지 않으므로 oldValue와 newValue가 nil이 됩니다.

NotificationCenter

[공식 문서 번역]

등록된 관찰자(observers)에게 정보를 브로드캐스팅할 수 있는 알림 발송 메커니즘입니다.

 

개체는 알림 센터에 등록하여 addObserver(_:selector:name:object:using:) 메서드를 사용하거나 addObserver(forName:object:queue:using:) 메서드를 사용하여 알림(= NSNotification 객체)을 수신합니다.

개체가 자신을 관찰자로 추가할 때 어떤 알림을 수신해야 하는지 지정합니다. 따라서 개체는 여러 다른 알림에 대해 관찰자로 등록하기 위해 이 메서드를 여러 번 호출할 수 있습니다.

실행 중인 각 앱에는 default notification center가 있으며, 특정 컨텍스트에서 통신을 구성하기 위해 새로운 notification center를 생성할 수 있습니다.

알림 센터는 단일 프로그램 내에서만 알림을 전송할 수 있습니다.

(다른 프로세스에 알림을 발송, 수신하려면 DistributedNotificationCenter를 사용)

Post, Observer 메서드

Post(알림을 보내는) 메서드

• name: 전달하고 싶은 신호 이름
• object: 전달하고 싶은 데이터. 없으면(신호만 전달하고 싶다면) nil
• userInfo: notification과 관련된 값 또는 객체의 저장소. 없으면 nil

Observer(알림을 받기 위한 관찰자) 메서드

메서드 자세히 보기!

• observer: 관찰자로 등록할 객체
• selector: 해당 신호를 받으면 실행할 함수
• name: observer를 등록할 notification 이름
• object: observer가 해당 object의 notification만 전달받고 싶을 때 지정 가능. nil일 경우는 해당하는 신호를 모두 받겠다는 의미
• queue: block이 실행되는 작업 대기열 (nil일 경우 동기적으로 실행)˜
• block: 알림을 받을 때 실행되는 블록

예제 코드

class ViewController: UIViewController {
    
    @IBOutlet weak var statusLabel: UILabel!
    @IBOutlet weak var titleLabel: UILabel!
    @IBOutlet weak var messageTextField: UITextField!
    
    override func viewDidLoad() {
        super.viewDidLoad()
    }
    
    @IBAction func tapSubscribeButton(_ sender: Any) {
        NotificationCenter.default.addObserver(self, selector: #selector(dataReceived), name: NSNotification.Name("SendAlarm"), object: nil)
        statusLabel.text = "구독함!!!!!"
    }
    
    @IBAction func tapSendButton(_ sender: Any) {
        NotificationCenter.default.post(name: NSNotification.Name("SendAlarm"), object: messageTextField.text ?? "")
    }
    
    @objc
    func dataReceived(notification: NSNotification) {
        if let text = notification.object as? String {
            titleLabel.text = text
        }
    }
}