JavaScript 自定義事件

JavaScript 自定義事件就是有別于如 click, submit 等標(biāo)準(zhǔn)事件的自行定制的事件,在敘述自定義事件有何好處之前,先來看一個(gè)自定義事件的例子:

   <div id="testBox"></div>
  // 創(chuàng)建事件  
  var evt = document.createEvent('Event');
  // 定義事件類型
  evt.initEvent('customEvent', true, true);
  // 在元素上監(jiān)聽事件
  var obj = document.getElementById('testBox');
  obj.addEventListener('customEvent', function(){
    console.log('customEvent 事件觸發(fā)了');
  }, false);

具體效果可以查看 Demo,在 console 中輸入 obj.dispatchEvent(evt),可以看到 console 中輸出“customEvent 事件觸發(fā)了”,表示自定義事件成功觸發(fā)。

在這個(gè)過程中,createEvent 方法創(chuàng)建了一個(gè)空事件 evt,然后使用 initEvent 方法定義事件的類型為約定好的自定義事件,再對相應(yīng)的元素進(jìn)行監(jiān)聽,接著,就是使用 dispatchEvent 觸發(fā)事件了。

沒錯(cuò),自定義事件的機(jī)制如普通事件一樣——監(jiān)聽事件,寫回調(diào)操作,觸發(fā)事件后執(zhí)行回調(diào)。但不同的是,自定義事件完全由我們控制觸發(fā)時(shí)機(jī),這就意味著實(shí)現(xiàn)了一種 JavaScript 的解耦。我們可以把多個(gè)關(guān)聯(lián)但邏輯復(fù)雜的操作利用自定義事件的機(jī)制靈活地控制好。

當(dāng)然,可能你已經(jīng)猜到了,上面的代碼在低版本的 IE 中并不生效,事實(shí)上在 IE8 及以下版本的 IE 中并不支持 createEvent(),而有 IE 私有的 fireEvent() 方法,但遺憾的是,fireEvent 只支持標(biāo)準(zhǔn)事件的觸發(fā)。因此,我們只能使用一個(gè)特殊而簡單的方法觸發(fā)自定義事件。

// type 為自定義事件,如 type = 'customEvent',callback 為開發(fā)者實(shí)際定義的回調(diào)函數(shù)
obj[type] = 0;
obj[type]++;
 
obj.attachEvent('onpropertychange', function(event){
    if( event.propertyName == type ){
        callback.call(obj);
    }
});

這個(gè)方法的原理實(shí)際上是在 DOM 中增加一個(gè)自定義屬性,同時(shí)監(jiān)聽元素的 propertychange 事件,當(dāng) DOM 的某個(gè)屬性的值發(fā)生改變時(shí)就會觸發(fā) propertychange 的回調(diào),再在回調(diào)中判斷發(fā)生改變的屬性是否為我們的自定義屬性,若是則執(zhí)行開發(fā)者實(shí)際定義的回調(diào)。從而模擬了自定義事件的機(jī)制。

為了使到自定義事件的機(jī)制能配合標(biāo)準(zhǔn)事件的監(jiān)聽和模擬觸發(fā),這里給出一個(gè)完整的事件機(jī)制,這個(gè)機(jī)制支持標(biāo)準(zhǔn)事件和自定義事件的監(jiān)聽,移除監(jiān)聽和模擬觸發(fā)操作。需要注意的是,為了使到代碼的邏輯更加清晰,這里約定自定義事件帶有 'custom' 的前綴(例如:customTest,customAlert)。

/**
 * @description 包含事件監(jiān)聽、移除和模擬事件觸發(fā)的事件機(jī)制,支持鏈?zhǔn)秸{(diào)用
 * @author Kayo Lee(kayosite.com)
 * @create 2014-07-24
 *
 */
 
(function( window, undefined ){
    var Ev = window.Ev = window.$ = function(element){
    return new Ev.fn.init(element);
};
 
// Ev 對象構(gòu)建
Ev.fn = Ev.prototype = {
    init: function(element){
        this.element = (element && element.nodeType == 1)? element: document;
    },
 
    /**
     * 添加事件監(jiān)聽
     * 
     * @param {String} type 監(jiān)聽的事件類型
     * @param {Function} callback 回調(diào)函數(shù)
     */
    add: function(type, callback){
        var _that = this;
        if(_that.element.addEventListener){
            /**
             * @supported For Modern Browers and IE9+
             */
            _that.element.addEventListener(type, callback, false);
        } else if(_that.element.attachEvent){
            /**
             * @supported For IE5+
             */
            // 自定義事件處理
            if( type.indexOf('custom') != -1 ){
                if( isNaN( _that.element[type] ) ){
                    _that.element[type] = 0;
                } 
 
                var fnEv = function(event){
                    event = event ? event : window.event
                    if( event.propertyName == type ){
                        callback.call(_that.element);
                    }
                };
                _that.element.attachEvent('onpropertychange', fnEv);
 
                // 在元素上存儲綁定的 propertychange 的回調(diào),方便移除事件綁定
                if( !_that.element['callback' + callback] ){
                    _that.element['callback' + callback] = fnEv;
                }
            // 標(biāo)準(zhǔn)事件處理
            } else {
                _that.element.attachEvent('on' + type, callback);
            }
        } else {
            /**
             * @supported For Others
             */
            _that.element['on' + type] = callback;
        }
        return _that;
    },
 
    /**
     * 移除事件監(jiān)聽
     * 
     * @param {String} type 監(jiān)聽的事件類型
     * @param {Function} callback 回調(diào)函數(shù)
     */
    remove: function(type, callback){
        var _that = this;
        if(_that.element.removeEventListener){
            /**
             * @supported For Modern Browers and IE9+
             */
            _that.element.removeEventListener(type, callback, false);
        } else if(_that.element.detachEvent){
            /**
             * @supported For IE5+
             */
            // 自定義事件處理
            if( type.indexOf('custom') != -1 ){
                // 移除對相應(yīng)的自定義屬性的監(jiān)聽
                _that.element.detachEvent('onpropertychange', _that.element['callback' + callback]);
                // 刪除儲存在 DOM 上的自定義事件的回調(diào)
                _that.element['callback' + callback] = null;
            // 標(biāo)準(zhǔn)事件的處理
            } else {
                _that.element.detachEvent('on' + type, callback);
            }
        } else {
            /**
             * @supported For Others
             */
            _that.element['on' + type] = null;
        }
        return _that;
    },
     
    /**
     * 模擬觸發(fā)事件
     * @param {String} type 模擬觸發(fā)事件的事件類型
     * @return {Object} 返回當(dāng)前的 Kjs 對象
     */
    trigger: function(type){
        var _that = this;
        try {
            // 現(xiàn)代瀏覽器
            if(_that.element.dispatchEvent){
                // 創(chuàng)建事件
                var evt = document.createEvent('Event');
                // 定義事件的類型
                evt.initEvent(type, true, true);
                // 觸發(fā)事件
                _that.element.dispatchEvent(evt);
            // IE
            } else if(_that.element.fireEvent){
                if( type.indexOf('custom') != -1 ){
                    _that.element[type]++;
                } else {
                    _that.element.fireEvent('on' + type);
                }
            }
        } catch(e){
        };
        return _that;
    }
}
 
Ev.fn.init.prototype = Ev.fn;
 
})( window );

測試用例1(自定義事件測試)

// 測試用例1(自定義事件測試)
// 引入事件機(jī)制
// 捕捉 DOM
var testBox = document.getElementById('testbox');
// 回調(diào)函數(shù)1
function triggerEvent(){
        console.log('觸發(fā)了一次自定義事件 customConsole');
}
// 回調(diào)函數(shù)2
function triggerAgain(){
        console.log('再一次觸發(fā)了自定義事件 customConsole');
}
// 封裝
testBox = $(testBox);
// 同時(shí)綁定兩個(gè)回調(diào)函數(shù),支持鏈?zhǔn)秸{(diào)用
testBox.add('customConsole', triggerEvent).add('customConsole', triggerAgain);

在 console 中調(diào)用 testBox.trigger('customConsole') 自行觸發(fā)自定義事件,可以看到 console 輸出兩個(gè)提示語,再輸入 testBox.remove('customConsole', triggerAgain) 移除對后一個(gè)監(jiān)聽,這時(shí)再使用 testBox.trigger('customConsole') 觸發(fā)自定義事件,可以看到 console 只輸出一個(gè)提示語,即成功移除后一個(gè)監(jiān)聽,至此事件機(jī)制所有功能正常工作。

測試用例2(標(biāo)準(zhǔn)事件測試)

// 測試用例2(標(biāo)準(zhǔn)事件測試)
// 引入事件機(jī)制
// 捕捉 DOM
var testClick = document.getElementById('testClick');
// 回調(diào)函數(shù)
function triggerEvent(){
    alert('擦,我被狠狠地點(diǎn)擊了!');
}
// 封裝
testClick = $(testBox);
// 監(jiān)聽
testClick.add('click', triggerEvent);

本文由 Kayo Lee 發(fā)表,本文鏈接:http://kayosite.com/javascript-custom-event.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 上一次,了解了JS自定義事件。今天在DOM上進(jìn)行事件方法擴(kuò)展。 1.基于DOM擴(kuò)展自定義方法(了解即可) 我們一起...
    卓三陽閱讀 848評論 0 1
  • 最近在研究webRTC的封裝庫,在閱讀其源碼的過程中,對js原生的自定義事件封裝與調(diào)用機(jī)制有了新的認(rèn)識,記錄下來分...
    藺相如如閱讀 1,530評論 0 2
  • 所謂自定義事件,就是有別于帶有瀏覽器特定行為的事件(鼠標(biāo)事件,鍵盤事件,html事件等),事件名稱可以自定義,可以...
    卓三陽閱讀 1,114評論 0 0
  • NARUTOne引言:js的事件機(jī)制在web開發(fā)中的出鏡率是很高,但是要想給事件機(jī)制拍出高顏值的效果,還是很難的。...
    迷緣火葉閱讀 672評論 0 0
  • 我想 一個(gè)人也挺好的 快樂是我的 悲傷也是我的 我想 一個(gè)人也挺好的 寂寞是我的 喧囂也是我的 擁擠的街 洶涌人海...
    程姑娘12138閱讀 393評論 4 3

友情鏈接更多精彩內(nèi)容