תבנית Observer

חלק מהיחידה תכנות מונחה עצמים במסלול ה-Swift של Coddy. שיעור 44 מתוך 57.

בתבנית המתבונן, אובייקט (הנושא) מחזיק רשימה של מתבוננים ומודיע לכולם כשמשהו קורה. הנושא לא צריך לדעת מה המתבוננים עושים:

final class Button {
    private var handlers: [(String) -> Void] = []

    func onTap(_ handler: @escaping (String) -> Void) {
        handlers.append(handler)
    }

    func tap() {
        for h in handlers { h("tapped") }
    }
}

let b = Button()
b.onTap { print("logger saw \($0)") }
b.onTap { print("counter saw \($0)") }
b.tap()

פלט:

logger saw tapped
counter saw tapped

משקיפים יכולים להיות גם אובייקטים שתואמים לפרוטוקול. הנושא קורא למתודת הפרוטוקול בכל משקיף רשום:

protocol StockObserver: AnyObject {
    func priceChanged(_ symbol: String, to price: Int)
}

final class Stock {
    let symbol: String
    private var observers: [StockObserver] = []
    var price: Int { didSet { observers.forEach { $0.priceChanged(symbol, to: price) } } }
    init(symbol: String, price: Int) { self.symbol = symbol; self.price = price }
    func add(_ o: StockObserver) { observers.append(o) }
}

final class Alert: StockObserver {
    func priceChanged(_ s: String, to p: Int) { if p > 100 { print("\(s) above 100: \(p)") } }
}

let apple = Stock(symbol: "AAPL", price: 90)
apple.add(Alert())
apple.price = 95
apple.price = 120

פלט:

AAPL above 100: 120

צופים בדרך כלל זקוקים לדרך להפסיק להאזין. החזרת מזהה (או אסימון) בעת ההרשמה מאפשרת למי שקרא לפונקציה להסיר את הצופה שלו בהמשך:

final class EventBus {
    private var listeners: [Int: (String) -> Void] = [:]
    private var nextId = 0

    func subscribe(_ f: @escaping (String) -> Void) -> Int {
        nextId += 1
        listeners[nextId] = f
        return nextId
    }
    func unsubscribe(_ id: Int) { listeners[id] = nil }
    func publish(_ event: String) {
        for id in listeners.keys.sorted() { listeners[id]!(event) }
    }
}

let bus = EventBus()
let a = bus.subscribe { print("A got \($0)") }
_ = bus.subscribe { print("B got \($0)") }
bus.publish("login")
bus.unsubscribe(a)
bus.publish("logout")

פלט:

A got login
B got login
B got logout

@escaping מסמן closure שנשמר ונקרא מאוחר יותר, לאחר שהפונקציה שקיבלה אותו חזרה. דפוס Observer שומר על קשר רופף בין הנושא לצופים: אפשר להוסיף צופים חדשים בלי לשנות את הנושא.

func onTap(_ handler: @escaping (String) -> Void) {
    handlers.append(handler)   // נשמר: חייב להיות @escaping
}

אתגר

קל

השלם את המחלקה Newsletter, נושא ששולח גיליונות למנויים. subscribe(name:handler:) שומרת סגירה תחת שם (הרשמה נוספת עם אותו שם מחליפה אותה), unsubscribe(name:) מסירה אותה, ו-publish(_ title:) קוראת לכל המטפלים לפי סדר אלפביתי של השמות ומחזירה כמה מנויים קיבלו הודעה.

הקוד שסופק קורא פקודות sub <name>, unsub <name> או pub <title>. המטפל של כל מנוי מדפיס <name> reads <title>; אחרי כל pub הקוד מדפיס sent to 2.

הקוד שלך יופיע ב-Newsletter.swift. הקובץ main.swift מכיל את קוד הקלט/פלט שסופק ואי אפשר לערוך אותו.

נסו בעצמכם

// קוד קלט/פלט שסופק: השאירו אותו כפי שהוא
var input: [String] = []
while let line = readLine() { input.append(line) }
let news = Newsletter()
for cmd in input {
    let p = cmd.split(separator: " ", maxSplits: 1).map(String.init)
    switch p[0] {
    case "sub":
        let name = p[1]
        news.subscribe(name: name) { print("\(name) reads \($0)") }
    case "unsub": news.unsubscribe(name: p[1])
    default: print("sent to \(news.publish(p[1]))")
    }
}