YUI学习笔记（4）
by xujiwei (http://www.xujiwei.com/)
YAHOO.util.Subscriber 与 YAHOO.util.CustomEvent。
1. YAHOO.util.Subscriber (event.js)
这 应该算是设计模式中的观察者模式了，Subscriber 订阅一个事件，在 Publisher 触发那个事件后，会逐个通知 Subscriber。
对 于一般开发者来说，并不需要去关心 Subscriber 的实现，因为 Subscriber 主要是 CustomEvent 用来分发动作以及删 除 Subscriber 的。
Subscriber 类只定义了 3 个属性：fn、obj 以及 override，3 个方 法：getScope、contains、toString，其中 fn 为订阅者的回调函数，obj 为要传递给回调函数的一个额外参 数，override 如果是布尔型的 true 值，那么表示使用 obj 属性为回调函数执行时的上下文，或者直接使用一个对象来作为回调函数执行的 上下文。
Subscriber 的 3 个方法中比较有用的是 getScope 和 contains，toString 只是简单的 将 Subscriber 对象转换成一个字符串。getScope 会根据 Subscriber 对象的 override 属性来获取回调函数执行 的上下文，contains 用来判断 Subscriber 对象与指定的回调函数和 obj 是否一致。
2. YAHOO.util.CustomEvent (event.js)
CustomEvent 的 作用相当在观察者模式中发布者的身份，可以通过它来实现一个自己的事件发布者。
CustomEvent 构造函数的定义如下：
CustomEvent = function(type, oScope, silent, signature)
在 创建 CustomEvent 对象时，几个参数的用途如下：
type 是自定义事件的名称，在使用回调函数的参数格式 为 YAHOO.util.Event.LIST 时，回调函数的第一个参数就是 CustomEvent 对象的名称；
oScope 是 执行回调函数时的上下文对象，也就是在回调函数中可以用 this 来引用这个对象；
silent 参数是用指示是否 在 YUI 为 debug 版本时禁用调试信息；
signature 用来指示回调函数参数的格式，可以为 YAHOO.util.Event.FLAT 或 YAHOO.util.Event.LIST， 默认是 YAHOO.util.Event.LIST。
在使用 CustomEvent 之前，先要了解一下 CustomEvent 中 回调函数参数的格式，CustomEvent 的回调函数可以有两种格式，一种为 YAHOO.util.Event.LIST，这种格式的回调函数具有 三个参数，分别是事件名称、参数数组和附加对象参数；另外一种回调函数参数格式为 YAHOO.util.Event.FLAT，这个时候回调函数只有两 个参数，一个为 CustomEvent 对象调用 fire 方法时的第一个参数，另外一个是订阅时的额外对象参数。
在创 建 CustomEvent 对象时，CustomEvent 构造函数还会首先创建一个内部的自定义事件，用来处理该自定义事件被订阅的事件，这 在 EventProvider 中用到，这里暂且不提。
CustomEvent 对象使用一个名为 subscribers 的数组来保 存所有订阅者的列表，并且通过维护这个列表来维护该自定义事件的订阅者。
CustomEvent 对象提供了 subscribe、 unsubscribe、unsubscribeAll、fire 这几个方法来处理自定义事件的订阅、退订以及触发等动作，而这几个就是观察者模式中的 主要动作了。
subscribe 的签名为 subscribe: function(fn, obj, override)， 三个参数分别对应了 Subscriber 类构造函数的三个参数，分别对应了回调函数、额外对象参数以及是否使用额外对象参数作为执行上下文。 subscribe 只是简单的判断参数 fn 是否有定义，然后会触发自定义事件订阅事件，最后使用这三个参数创建一个 Subscriber 对象添 加到 CustomEvent 对象的 subscribers 属性中。
unsubscribe 方法用来取消事件的订阅，它的函数签名 为 unsubscribe: function(fn, obj)，两个参数分别是回调函数和额外对象参数，如果使用无参数调 用 unsubscribe 方法，那么会直接调用 unsubscribeAll 来删除所有订阅者，否则会逐一判断 subscribers 中的每 个对象，通过使用 Subscriber 对象的 contains 方法来判断给定的 fn 和 obj 与其是否一致，如果一致，就使用一个私有方 法 _delete 来删除这个 Subscriber。
unsubscribeAll 方法没有参数，它只是简单的直接删除自定义事件的 所有订阅者，最后直接给 subscribers 赋值一个空数组来避免有可能出现漏删订阅者的情况。
内部方法 _delete 的参数 是 Subscriber 对象在 subscribers 数组中的索引，它会先删除 Subscriber 对象的 fn 和 obj 属性，最后使 用 splice 方法将 Subscriber 对象从数组中删除。
var s = this.subscribers[index];
if (s) {
delete s.fn;
delete s.obj;
}
this.subscribers.splice(index, 1);
使用 delete 删除 Subscriber 对象的 fn 和 obj 属性是为了去除 回调函数及额外对象参数的引用，以免引起不必要的内 存泄露。
CustomEvent 对象最重要的方法就是 fire 了，就是通过这个方法来通知所有了订阅者这个自定义事件被触发了。 fire 方法先使用 Array 的 slice 方法将调用 fire 方法时的参数转化成数组，这样就可以在调用 Subscriber 的回调函 数时可以传递参数给它们。
在遍历 subscribers 中的 Subscriber 前，fire 方法先使用 了 subscribers 的 slice 方法来创建一个 subscribers 的副本，这样避免在执行 fire 的过程中 有 Subscirber 取消订阅了这个自定义事件会导致错误。
在执行 Subscriber 的回调函数前，先使 用 Subscriber 对象的 getScope 方法来获取执行回调函数时的上下文对象，再根据 CustomEvent 对象 的 signature 属性来决定怎么去调用 Subscriber 的回调函数。
如 果 signature 为 YAHOO.util.CustomEvent.FLAT，那么就把调用 fire 方法时的第一个参数做为回调函数的第一 个参数，再把 Subscriber 对象的 obj 属性做为第二个参数：
s.fn.call(scope, param, s.obj)
如 果 signature 为 YAHOO.util.CustomEvent.LIST，那么就除了把整个 fire 方法的参数列表传递给回调函数外， 还要传递当前 CustomEvent 的名称给回调函数：
s.fn.call(scope, this.type, args, s.obj)
Subscriber 的 回调函数如果在执行过程中出现了错误，那么 CustomEvent 的 lastError 属性就是指向错误对象的引用，另外，如 果 YAOO.util.Event.throwErrors 为 true，那么会把这个错误再次抛出。
另外，Subscriber 对 象也可以控制事件通知是否继续，如果 Subscriber 对象的回调函数执行后的返回一个 false，那么在 fire 方法中就会停止通知剩下 的 Subscriber 对象，通常情况下，先订阅自定义事件的 Subscriber 可以阻止后订阅的 Subscriber 接收到通知。
使 用 YUI 的自定义事件（CustomEvent）可以很方便地实现观察者模式，更好地组织 JavaScript 程序的结构。
0 条评论。