一、前言
发布-订阅模式又叫观察者模式,它定义对象间的一种一对多的依赖关系,当一个对象的状态发生改变时,所有依赖于它的对象都将得到通知。在JavaScript开发中,我们一般用事件模型来替代传统的发布-订阅模式。
二、发布-订阅者的作用
发布-订阅模式可以广泛应用于异步编程中,这是一种替代传递回调函数的方案。如果我们订阅ajax请求的error、succ等事件。或者如果想在动画的每一帧完成之后做一些事情,那我们可以订阅一个事件,然后在动画的每一帧完成之后发布这个事件。在异步编程中使用发布-订阅者模式,我们就无须过多关注对象在异步运行期间的内部状态,而只需要订阅感兴趣的事件发生点。
发布-订阅模式可以取代对象之间硬编码的通知机制,一个对象不用再显式地调用另外一个对象的某个接口。发布-订阅模式让两个对象耦合地联系在一起,虽然不太清楚彼此的细节,但这不影响它们之间相互通信。当有新的订阅者出现时,发布者的代码不需要任何修改;同样发布者需要改变时,也不会影响到之前的订阅者。只要之前约定的事件名没有变化,就可以自由地改变它们。
三、DOM事件
实际上,只要我们曾经在DOM节点上面绑定过事件函数,那我们就曾经使用过发布-订阅模式
document.body.addEventListener('click', function() {
alert(1)
}, false);
document.body.click(); // 模拟用户点击
在这里需要监控用户点击document.body的动作,但是我们没办法预知用户将在什么时候点击。所以我们订阅document.body上的click事件,当body被点击时,body节点便会向订阅者发布这个消息。
当然我们可以随意增加或者删除订阅者,增加任何订阅者都不会影响发布者代码的编写:
document.body.addEventListener('click', function() {
alert(2)
}, false);
document.body.addEventListener('click', function() {
alert(3)
}, false);
document.body.addEventListener('click', function() {
alert(4)
}, false);
documemt.body.click(); // 模拟用户点击
四、自定义事件
除了DOM事件,我们还会经常实现一些自定义的事件,这种依靠自定义事件完成的发布-订阅模式可也以用于任何JavaScript代码中。
现在来看看如何一步步实现发布-订阅模式
- 首先指定好谁充当发布者(比如售楼处)
- 然后给发布者添加一个缓存列表,用于存放回调函数以便通知订阅者(售楼处的花名册)
- 最后发布消息的时候,发布者会遍历这个缓存列表,依次触发里面存放的订阅者回调函数(遍历花名册,挨个发短信)
另外,我们还可以往回调函数里填入一些参数,订阅者可以接收这些参数。这是很有必要的,比如售楼处可以在发给订阅者的短信里加上房子的单价、面积、容积率等信息,订阅者接收到这些信息之后可以进行各自的处理:
var salesOffices = {}; // 定义售楼处
salesOffices.cilentList = {}; // 缓存列表,存放订阅者的回调函数
salesOffices.listen = function(fn) { // 增加订阅者
this.cilentList.push(fn); // 订阅的消息添加进缓存列表
};
salesOffices.trigger = function() { // 发布消息
for(var i = 0, fn; fn = this.cilentList[i++]) {
fn.apply(this, arguments); // argument 是发布消息时带上的参数
}
};
下面是一些简单的测试:
salesOffices.listen(function(price, squareMeter) { // 小明订阅消息
console.log('价格:' + price);
console.log('面积:' + squareMeter);
});
salesOffices.listen(function(price){ // 小红订阅消息
console.log('价格:' + price);
console.log('面积:' + squareMeter);
});
salesOffices.tigger(20000, 88);
salesOffices.tigger(30000, 110);
至此,我们实现一个简单的发布-订阅模式,但是这里还存在一些问题,我们看到订阅者接收到了发布者发布的每个消息,虽然小明只想买88平米的房子,但是发布者把110平米的消息也推送给了小明,这对小明来说是不必要的困扰。所以我们有必要增加一个标示key,让订阅者只订阅自己感兴趣的消息。改写后的代码如下:
var salesOffices = {}; // 定义售楼处
salesOffices.cilentsList = {}; // 缓存列表,存放订阅者的回调函数
salesOffices.listen = function(key, fn) {
if(!this.cilentList[key]) { // 如果没有订阅过此类消息,给该类消息一个创建一个缓存列表
this.cilentList[key] = [];
}
this.clilentList[key].push(fn); // 订阅的消息添加进消息缓存列表
};
salesOffices.trigger = function() { // 发布消息
var key = Array.prototype.shift.call(argument), // 取出消息
fns = this.cilentList[key]; // 取出该消息对应的回调函数集合
if(!fns || fns.length === 0) { // 如果没有订阅该消息,则返回
return false;
};
for(var i = 0, fn; fn = fns[i++]) {
fn.apply(this, arguments); // arguments 是发布消息时附送的参数
}
};
salesOffices.listen('squareMeter88', function(price) { // 小明订阅88平方米房子的消息
console.log('价格:' + price); // 输出 200000
});
salesOffices.listen('squareMeter110', function(price) { // 小红订阅110平方米房子的消息
console.log('价格:' + price); // 输出 300000
});
salesOffices.trigger('squareMeter88', 200000); // 发布88平方米房子的价格
salesOffices.trigger('squareMeter110', 300000); // 发布110平方米房子的价格
很明显,现在订阅者可以只订阅自己感兴趣的事件了。
五、发布-订阅模式的通用实现
现在我们已经看到了如何让售楼处接受订阅和发布事件的功能。假设现在小明又去另一家售楼处买房子,那么这段代码是否必须在另一个售楼处对象上重写一次呢,有没有办法可以让所有对象都拥有一套发布-订阅功能呢?
答案是有的,JavaScript作为一门解释执行的语言,给对象动态添加职责是理所当然的事情。
所以我们把发布-订阅的功能提取出来,放在一个单独的对象内:
var event = {
cilentList: [];
listen: function(key, fn) {
if(!this.cilentList[key]) {
this.cilentList[key] = [];
};
this.cilentList[key].push(fn); // 订阅的消息添加进缓存列表
},
trigger: function() {
var key = Array.prototype.shift.call(arguments),
fns = this.cilents[key];
if(!fns || fns.length === 0) { // 如果没有绑定对应的消息
return false;
};
for(var i = 0, fn; fn = fns[i++]) {
fn.apply(this, arguments); // arguments 是 trigger时带上的参数
}
}
};
再定义一个installEvent函数,这个函数可以给所有的对象都动态安装发布-订阅功能。
var installEvent = function(obj) {
for(var i in event) {
obj[i] = event[i];
}
};
再来测试一番,我们给售楼处对象 salesOffices 动态增加一个发布-订阅功能:
var salesOffices = {};
installEvent(salesOffices);
salesOffices.listen('squareMeter88', function(price){ // 小明订阅消息
console.log('价格:' + price); // 200000
});
salesOffices.listen('squareMeter110', function(price){ // 小红订阅消息
console.log('价格:' + price); // 300000
});
salesOffices.trigger('squareMeter88', 200000);
salesOffices.trigger('squareMeter110', 300000);