行为模式-观察者模式(The Observer Pattern)

本文大部分内容翻译至《Pro Design Pattern In Swift》By Adam Freeman,一些地方做了些许修改,并将代码升级到了Swift2.0,翻译不当之处望多包涵。

观察者模式(The Observer Pattern)

观察者设计模式定义了对象间的一种一对多的依赖关系,以便一个对象的状态发生变化时,所有依赖于它的对象都得到通知并自动刷新。


示例工程

OS X Command Line Tool工程:

SystemComponents.swift

class ActivityLog {
    func logActivity(activity:String) {
        print("Log: \\(activity)")
    }
}

class FileCache {
    func loadFiles(user:String) {
        print("Load files for \\(user)")
    }
}

class AttackMonitor {
    var monitorSuspiciousActivity: Bool = false {
        didSet {
            print("Monitoring for attack: \\(monitorSuspiciousActivity)")
        }
    }
}

ActivityLog类代表系统的事件日志输出;FileCache类代表一个给定的用户的文件加载;AttackMonitor类代表可疑事件发生时的安全服务。

Authentication.swift

class AuthenticationManager {
    private let log = ActivityLog()
    private let cache = FileCache()
    private let monitor = AttackMonitor()
    
    func authenticate(user:String, pass:String) -> Bool {
        var result = false
        if (user == "bob" && pass == "secret") {
            result = true
            print("User \\(user) is authenticated")
            // call system components
            log.logActivity("Authenticated \\(user)")
            cache.loadFiles(user)
            monitor.monitorSuspiciousActivity = false
        } else {
            print("Failed authentication attempt")
            // call system components
            log.logActivity("Failed authentication: \\(user)")
            monitor.monitorSuspiciousActivity = true
        }
        return result
    }
}

AuthenticationManager类代表用密码来认证用户的服务类。可以看出认证成功后会输出成功日志并加载用户的文件,失败后会输出失败日志并输出受攻击的警告。

main.swift

let authM = AuthenticationManager()
authM.authenticate("bob", pass: "secret")
print("--------------")
authM.authenticate("joe", pass: "shhh")

运行程序:

User bob is authenticated
Log: Authenticated bob
Load files for bob
Monitoring for attack: false
--------------
Failed authentication attempt
Log: Failed authentication: joe
Monitoring for attack: true

理解观察者模式解决的问题

示例中的代码结构在真正的项目中十分常见,一个事件的发生引起了一系列的其它事件的发生。



问题发生在操作初始事件的类里(本例中就是AuthenticationManager类),它必须知道触发的其它事件的详细和它们是如何操作的。如果其中的一个触发类做一些修改,那么相应的初始事件类中也要做相应的修改。


理解观察者模式

观察者模式通过将它们分成被观察者和观察者来改变这种关系。被观察者持有观察者的集合,当发生改变时就通知它们。



实现观察者模式

实现观察者模式的关键是用协议定义观察者和被观察者的协议。

Observer.swift

protocol Observer : class {
    func notify(user:String, success:Bool)
}

protocol Subject {
    func addObservers(observers:Observer...)
    func removeObserver(observer:Observer)
}

注意到Observer协议的class关键字, 这样做的原因是我们后面要进行对象的比较。

创建被观察者基类

我们知道被观察类持有观察者类的集合,所以同时需要GCD并发保护。

Observer.swift

import Foundation
protocol Observer : class {
    func notify(user:String, success:Bool)
}

protocol Subject {
    func addObservers(observers:Observer...)
    func removeObserver(observer:Observer)
}

class SubjectBase : Subject {
    private var observers = [Observer]()
    private var collectionQueue = dispatch_queue_create("colQ",DISPATCH_QUEUE_CONCURRENT)
    
    func addObservers(observers: Observer...) {
        dispatch_barrier_sync(self.collectionQueue){[weak self] in
            for newOb in observers {
                self!.observers.append(newOb)
            }
        }
    }
    
    
    func removeObserver(observer: Observer) {
        dispatch_barrier_sync(self.collectionQueue){[weak self] in
            self!.observers = self!.observers.filter(){
                $0 !== observer
            }
        }
    }
    
    func sendNotification(user:String, success:Bool) {
        dispatch_sync(self.collectionQueue){ [weak self] in
            for ob in self!.observers {
                ob.notify(user, success: success)
            }
        }
    }
}

实现被观察者协议

Authentication.swift

class AuthenticationManager : SubjectBase {
    func authenticate(user:String, pass:String) -> Bool {
    var result = false
    if (user == "bob" && pass == "secret") {
        result = true
        print("User \\(user) is authenticated")
    } else {
        print("Failed authentication attempt")
    }
    sendNotification(user, success: result)
    return result
    }
}

实现观察者协议

SystemComponents.swift

class ActivityLog : Observer {
    func notify(user: String, success: Bool) {
        print("Auth request for \\(user). Success: \\(success)")
    }
    
    func logActivity(activity:String) {
        print("Log: \\(activity)")
    }
}

class FileCache : Observer {
    func notify(user: String, success: Bool) {
        if (success) {
            loadFiles(user)
        }
    }
        
    func loadFiles(user:String) {
        print("Load files for \\(user)")
    }
}

class AttackMonitor : Observer {
    func notify(user: String, success: Bool) {
            monitorSuspiciousActivity = !success
    }
            
    var monitorSuspiciousActivity: Bool = false {
        didSet {
            print("Monitoring for attack: \\(monitorSuspiciousActivity)")
        }
    }
}

最后我们再看main.swift:

let log = ActivityLog()
let cache = FileCache()
let monitor = AttackMonitor()
let authM = AuthenticationManager()

authM.addObservers(log, cache, monitor)
authM.authenticate("bob", pass: "secret")

print("-----")
authM.authenticate("joe", pass: "shhh")

运行程序:

User bob is authenticated
Auth request for bob. Success: true
Load files for bob
Monitoring for attack: false
-----
Failed authentication attempt
Auth request for joe. Success: false
Monitoring for attack: true

我们再添加观察者就显得很容易了,只要实现观察者协议然后调用addOberservers方法添加观察者就行了。


观察者模式的变形

泛化通知类型

示例中的notify 方法只能接收认证的通知,这其实是很糟糕的一种设计。

...
func notify(user:String, success:Bool)
...

下面我们做一些修改,使得它所接受的数据类型和通知类型都可以多样化。

Observer.swift

import Foundation

enum NotificationTypes : String {
    case AUTH_SUCCESS = "AUTH_SUCCESS"
    case AUTH_FAIL = "AUTH_FAIL"
}
struct Notification {
    let type:NotificationTypes
    let data:Any?
}

protocol Observer : class {
    func notify(notification:Notification)
}
......

func sendNotification(notification:Notification) {
        dispatch_sync(self.collectionQueue){ [weak self] in
            for ob in self!.observers {
                ob.notify(notification)
            }
        }
    }
.......

接着我们修改SystemComponents.swift :

class ActivityLog : Observer {
    func notify(notification:Notification) {
        print("Auth request for \\(notification.type.rawValue) " + "Success: \\(notification.data!)")
    }
    
    func logActivity(activity:String) {
        print("Log: \\(activity)")
    }
}

class FileCache : Observer {
    func notify(notification:Notification) {
        if (notification.type == NotificationTypes.AUTH_SUCCESS) {
            loadFiles(notification.data! as! String)
        }
    }
        
    func loadFiles(user:String) {
        print("Load files for \\(user)");
    }
}

class AttackMonitor : Observer {
    func notify(notification: Notification) {
        monitorSuspiciousActivity = (notification.type == NotificationTypes.AUTH_FAIL)
    }
        
    var monitorSuspiciousActivity: Bool = false {
        didSet {
            print("Monitoring for attack: \\(monitorSuspiciousActivity)");
        }
    }
}

最后是AuthenticationManager.swift:

class AuthenticationManager : SubjectBase {
    func authenticate(user:String, pass:String) -> Bool {
        var nType = NotificationTypes.AUTH_FAIL
        if (user == "bob" && pass == "secret") {
            nType = NotificationTypes.AUTH_SUCCESS
            print("User \\(user) is authenticated")
        } else {
            print("Failed authentication attempt")
        }
        sendNotification(Notification(type: nType, data: user))
        return nType == NotificationTypes.AUTH_SUCCESS
    }
}

运行程序:

p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Menlo; color: #ffffff}span.s1 {font-variant-ligatures: no-common-ligatures}

User bob is authenticated
Auth request for AUTH_SUCCESS Success: bob
Load files for bob
Monitoring for attack: false
-----
Failed authentication attempt
Auth request for AUTH_FAIL Success: joe
Monitoring for attack: true
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容