DIV CSS 佈局教程網

jQuery 事件命名空間完全解析:匹配規則、冒泡與 off 移除機制
編輯:JQuery特效代碼     

jQuery 的 on、off、trigger 都支援事件命名空間。用得好,你能精準管理同一事件類型下的不同監聽器,避免多個元件共用同一元素時互相干擾,也能擋掉瀏覽器自動觸發帶來的意外。本文用一系列可重現的實驗,把命名空間的匹配規則、冒泡行為與移除邏輯完整梳理一遍。

一、什麼是自定義事件

談命名空間前得先理解自定義事件,因為命名空間同時適用於自定義事件與瀏覽器原生事件。當內建事件無法表達元件語義時,我們就自己定義一個。以下範例的樹元件在初始化結束後觸發 init,讓外部得以插入回調:

<script src="../js/lib/jquery.js"></script> <div id="tree"> </div> <script> var Tree = function(element, options) { var $tree = this.$tree = $(element); //監聽init事件,觸發 $tree.on('init', $.proxy(options.onInit, this)); this.init(); }; Tree.prototype.init = function() { console.log('tree init!'); this.$tree.trigger('init'); }; var tree = new Tree('#tree', { onInit: function() { console.log(this.$tree.outerHeight()); } }); </script>

自定義事件在使用上與原生事件別無二致,冒泡、阻止預設行為全部支援。唯一差別在觸發來源:原生事件可由瀏覽器 UI 執行緒自動觸發,自定義事件則必須靠程式碼手動 trigger。

二、命名空間怎麼寫,能解決什麼

命名空間的語法類似 CSS 的 class:在事件型別後面用點號接上名稱。

<script> var Tree = function(element, options) { var $tree = this.$tree = $(element); //監聽init事件,觸發 $tree.on('init.my.tree', $.proxy(options.onInit, this)); this.init(); }; Tree.prototype.init = function() { console.log('tree init!'); this.$tree.trigger('init.my.tree'); }; var tree = new Tree('#tree', { onInit: function() { console.log(this.$tree.outerHeight()); } }); </script>

init.my.tree 為 init 掛上了兩個命名空間。注意它是「CSS 類」而非 Java 的 package,所以這兩個名稱是 .my 與 .tree,而不是 my 與 my.tree;名稱前面的點一定要寫,因為 off 時會用到。當監聽與觸發都帶上命名空間,就只有符合該命名空間的監聽器會被呼叫。

這解決了什麼問題?看不用命名空間的反例——同時為 #tree 實例化 Tree 與 Dragable 兩個元件,做出一棵可拖曳的樹:

<script> var Tree = function(element, options) { var $tree = this.$tree = $(element); //監聽init事件,觸發 $tree.on('init', $.proxy(options.onInit, this)); this.init(); }; Tree.prototype.init = function() { console.log('tree init!'); this.$tree.trigger('init'); }; var tree = new Tree('#tree', { onInit: function() { console.log(this.$tree.outerHeight()); } }); var Dragable = function(element, options) { var $element = this.$element = $(element); //監聽init事件,觸發 $element.on('init', $.proxy(options.onInit, this)); this.init(); }; Dragable.prototype.init = function() { console.log('tree init!'); this.$element.trigger('init'); }; var drag = new Dragable('#tree', { onInit: function() { console.log('start drag!'); } }); </script>

Tree 的 onInit 被呼叫了兩次:

原因很直白:同一個元素被多個元件使用,而它們各自定義了同名事件,於是後實例化的元件觸發事件時,把先前元件的監聽也一起帶動了。加上命名空間即可隔離:

<script> var Tree = function(element, options) { var $tree = this.$tree = $(element); //監聽init事件,觸發 $tree.on('init.my.tree', $.proxy(options.onInit, this)); this.init(); }; Tree.prototype.init = function() { console.log('tree init!'); this.$tree.trigger('init.my.tree'); }; var tree = new Tree('#tree', { onInit: function() { console.log(this.$tree.outerHeight()); } }); var Dragable = function(element, options) { var $element = this.$element = $(element); //監聽init事件,觸發 $element.on('init.my.dragable', $.proxy(options.onInit, this)); this.init(); }; Dragable.prototype.init = function() { console.log('drag init!'); this.$element.trigger('init.my.dragable'); }; var drag = new Dragable('#tree', { onInit: function() { console.log('start drag!'); } }); </script>

Tree 的 onInit 不再被重複呼叫。

三、命名空間的匹配規則

上一節的觸發寫法是 trigger('init.my.dragable')(下圖):

對應的監聽是:

如果保持監聽不變,改以下三種觸發方式,結果會如何?

this.$element.trigger('init'); this.$element.trigger('init.dragable'); this.$element.trigger('init.my');

答案是:監聽回調依然會被執行。要看清規則,用這段實驗:

<!DOCTYPE html> <html lang="en"> <head> <title>xxxxx</title> <style type="text/css"> #parent { margin: 100px auto 0 auto; width: 600px; height: 200px; border: 1px solid #ccc; position: relative; } .log { position: absolute; left: 0; width: 100%; height: 100%; overflow: auto; } p { margin: 0; } #btns { margin: 20px auto 0 auto; width: 600px; } </style> </head> <body> <script src="../js/lib/jquery.js"></script> <div id="parent"> <div class="log"></div> </div> <div id="btns"> <button id="btn1" type="button" onclick="$p.trigger('click.n1.n2.n3.n4');">trigger('click.n1.n2.n3.n4')</button> <button id="btn2" type="button" onclick="$p.trigger('click.n1.n2.n3');">trigger('click.n1.n2.n3')</button> <button id="btn3" type="button" onclick="$p.trigger('click.n1.n2');">trigger('click.n1.n2')</button> <button id="btn4" type="button" onclick="$p.trigger('click.n1');">trigger('click.n1')</button> <button id="btn5" type="button" onclick="$p.trigger('click');">trigger('click')</button> </div> <script> function log($e, msg) { var $log = $e.find('.log'); $log.append('<p>' + msg + '</p>'); } var $p = $('#parent'); $p.on('click.n1.n2.n3.n4', function(){ log($p, 'click n1 n2 n3 n4'); }); $p.on('click.n1.n2.n3', function(){ log($p, 'click n1 n2 n3'); }); $p.on('click.n1.n2', function(){ log($p, 'click n1 n2'); }); $p.on('click.n1', function(){ log($p, 'click n1'); }); $p.on('click', function(){ log($p, 'click'); }); </script> </body> </html>

初始化後:

每測一個按鈕前先重新整理頁面,避免結果互相污染,五輪下來:

歸納出的匹配規則:

1)觸發不帶命名空間的事件時,該事件的所有監聽器都會被觸發。

2)觸發帶命名空間的事件時,監聽時包含該命名空間的監聽器才會被觸發。

3)觸發帶多個命名空間的事件時,只有監聽時同時包含那些命名空間的監聽器才會被觸發(第 2 條其實是第 3 條的特例)。

4)只要觸發時帶了命名空間,不帶命名空間的監聽器就不會被觸發。

這套規則對自定義事件完全適用,把上面的 click 換成 hello 結論一致:

<!DOCTYPE html> <html lang="en"> <head> <title>xxxxx</title> <style type="text/css"> #parent { margin: 100px auto 0 auto; width: 600px; height: 200px; border: 1px solid #ccc; position: relative; } .log { position: absolute; left: 0; width: 100%; height: 100%; overflow: auto; } p { margin: 0; } #btns { margin: 20px auto 0 auto; width: 600px; } </style> </head> <body> <script src="../js/lib/jquery.js"></script> <div id="parent"> <div class="log"></div> </div> <div id="btns"> <button id="btn1" type="button" onclick="$p.trigger('hello.n1.n2.n3.n4');">trigger('hello.n1.n2.n3.n4')</button> <button id="btn2" type="button" onclick="$p.trigger('hello.n1.n2.n3');">trigger('hello.n1.n2.n3')</button> <button id="btn3" type="button" onclick="$p.trigger('hello.n1.n2');">trigger('hello.n1.n2')</button> <button id="btn4" type="button" onclick="$p.trigger('hello.n1');">trigger('hello.n1')</button> <button id="btn5" type="button" onclick="$p.trigger('hello');">trigger('hello')</button> </div> <script> function log($e, msg) { var $log = $e.find('.log'); $log.append('<p>' + msg + '</p>'); } var $p = $('#parent'); $p.on('hello.n1.n2.n3.n4', function(){ log($p, 'hello n1 n2 n3 n4'); }); $p.on('hello.n1.n2.n3', function(){ log($p, 'hello n1 n2 n3'); }); $p.on('hello.n1.n2', function(){ log($p, 'hello n1 n2'); }); $p.on('hello.n1', function(){ log($p, 'hello n1'); }); $p.on('hello', function(){ log($p, 'hello'); }); </script> </body> </html>

四、命名空間的冒泡

把實驗改成父子結構,並由子元素觸發事件:

<!DOCTYPE html> <html lang="en"> <head> <title>xxxxx</title> <style type="text/css"> #parent { margin: 100px auto 0 auto; width: 600px; height: 300px; border: 1px solid #ccc; position: relative; } #child { margin: 0 0 0 300px; width: 300px; height: 300px; border: 1px solid #ccc; position: relative; } .log { position: absolute; left: 0; width: 100%; height: 100%; overflow: auto; } p { margin: 0; } #btns { margin: 20px auto 0 auto; width: 600px; } </style> </head> <body> <script src="../js/lib/jquery.js"></script> <div id="parent"> <div class="log"></div> <div id="child"> <div class="log"></div> </div> </div> <div id="btns"> <button id="btn1" type="button" onclick="$c.trigger('hello.n1.n2.n3.n4');">trigger('hello.n1.n2.n3.n4')</button> <button id="btn2" type="button" onclick="$c.trigger('hello.n1.n2.n3');">trigger('hello.n1.n2.n3')</button> <button id="btn3" type="button" onclick="$c.trigger('hello.n1.n2');">trigger('hello.n1.n2')</button> <button id="btn4" type="button" onclick="$c.trigger('hello.n1');">trigger('hello.n1')</button> <button id="btn5" type="button" onclick="$c.trigger('hello');">trigger('hello')</button> </div> <script> function log($e, msg) { var $log = $e.children('.log'); $log.append('<p>' + msg + '</p>'); } var $p = $('#parent'); $p.on('hello.n1.n2.n3.n4', function(){ log($p, 'hello n1 n2 n3 n4'); }); $p.on('hello.n1.n2.n3', function(){ log($p, 'hello n1 n2 n3'); }); $p.on('hello.n1.n2', function(){ log($p, 'hello n1 n2'); }); $p.on('hello.n1', function(){ log($p, 'hello n1'); }); $p.on('hello', function(){ log($p, 'hello'); }); var $c = $('#child'); $c.on('hello.n1.n2.n3.n4', function(){ log($c, 'hello n1 n2 n3 n4'); }); $c.on('hello.n1.n2.n3', function(){ log($c, 'hello n1 n2 n3'); }); $c.on('hello.n1.n2', function(){ log($c, 'hello n1 n2'); }); $c.on('hello.n1', function(){ log($c, 'hello n1'); }); $c.on('hello', function(){ log($c, 'hello'); }); </script> </body> </html>

點擊按鈕觸發的是右側方形 $c 的事件,$p 是它的父元素。五輪測試結果:

結論:子元素帶命名空間的事件冒泡到父元素時,會以相同的命名空間在父元素上觸發同名事件——這可以稱為「帶命名空間的冒泡」。父元素上只有符合匹配規則的監聽器才會被呼叫。原生事件的冒泡機制與此相同:

<!DOCTYPE html> <html lang="en"> <head> <title>xxxxx</title> <style type="text/css"> #parent { margin: 100px auto 0 auto; width: 600px; height: 300px; border: 1px solid #ccc; position: relative; } #child { margin: 0 0 0 300px; width: 300px; height: 300px; border: 1px solid #ccc; position: relative; } .log { position: absolute; left: 0; width: 100%; height: 100%; overflow: auto; } p { margin: 0; } #btns { margin: 20px auto 0 auto; width: 600px; } </style> </head> <body> <script src="../js/lib/jquery.js"></script> <div id="parent"> <div class="log"></div> <div id="child"> <div class="log"></div> </div> </div> <div id="btns"> <button id="btn1" type="button" onclick="$c.trigger('click.n1.n2.n3.n4');">trigger('click.n1.n2.n3.n4')</button> <button id="btn2" type="button" onclick="$c.trigger('click.n1.n2.n3');">trigger('click.n1.n2.n3')</button> <button id="btn3" type="button" onclick="$c.trigger('click.n1.n2');">trigger('click.n1.n2')</button> <button id="btn4" type="button" onclick="$c.trigger('click.n1');">trigger('click.n1')</button> <button id="btn5" type="button" onclick="$c.trigger('click');">trigger('click')</button> </div> <script> function log($e, msg) { var $log = $e.children('.log'); $log.append('<p>' + msg + '</p>'); } var $p = $('#parent'); $p.on('click.n1.n2.n3.n4', function(){ log($p, 'click n1 n2 n3 n4'); }); $p.on('click.n1.n2.n3', function(){ log($p, 'click n1 n2 n3'); }); $p.on('click.n1.n2', function(){ log($p, 'click n1 n2'); }); $p.on('click.n1', function(){ log($p, 'click n1'); }); $p.on('click', function(){ log($p, 'click'); }); var $c = $('#child'); $c.on('click.n1.n2.n3.n4', function(){ log($c, 'click n1 n2 n3 n4'); }); $c.on('click.n1.n2.n3', function(){ log($c, 'click n1 n2 n3'); }); $c.on('click.n1.n2', function(){ log($c, 'click n1'); }); $c.on('click.n1', function(){ log($c, 'click n1'); }); $c.on('click', function(){ log($c, 'click'); }); </script> </body> </html>

特別提醒:瀏覽器自動觸發的原生事件永遠不帶命名空間。所以只要使用者在子元素上點擊或按鍵,子元素與所有父元素的監聽器都會被執行——這未必是你想要的。因此開發元件時,建議一律用帶命名空間的方式綁定與觸發,把瀏覽器自動觸發的影響屏蔽在元件之外。

五、整體圖像

縱向是帶命名空間的冒泡,橫向是按命名空間匹配規則篩選。綜合起來,某元素上的監聽器要被觸發,只有三種途徑:

1)直接該元素觸發同名事件,並通過命名空間匹配;

2)由子元素的事件冒泡上來,再通過匹配規則;

3)若是原生事件,還可能由瀏覽器自動觸發——但最終仍要落到冒泡與匹配規則上。

六、off 的三種移除方式

移除監聽可以只給事件型別:

$p.off('click');

也可以給帶命名空間的事件型別:

$p.off('click.n1');

還可以只給命名空間:

$p.off('.n1');

用下面這個實驗把三者差別測清楚:

<!DOCTYPE html> <html lang="en"> <head> <title>xxxxx</title> <style type="text/css"> #parent { margin: 100px auto 0 auto; width: 600px; height: 300px; border: 1px solid #ccc; position: relative; } .log { position: absolute; left: 0; width: 100%; height: 100%; overflow: auto; } p { margin: 0; } #btns { margin: 20px auto 0 auto; width: 600px; } </style> </head> <body> <script src="../js/lib/jquery.js"></script> <div id="parent"> <div class="log"></div> </div> <div id="btns"> <button id="btn1" type="button" onclick="$p.off('click.n1.n2.n3.n4');">off('click.n1.n2.n3.n4')</button> <button id="btn2" type="button" onclick="$p.off('click.n1.n2.n3');">off('click.n1.n2.n3')</button> <button id="btn3" type="button" onclick="$p.off('click.n1.n2');">off('click.n1.n2')</button> <button id="btn4" type="button" onclick="$p.off('click.n1');">off('click.n1')</button> <button id="btn5" type="button" onclick="$p.off('click');$p.trigger('hello');">off('click')</button> <button id="btn6" type="button" onclick="$p.off('.n1.n2.n3.n4');">off('.n1.n2.n3.n4')</button> <button id="btn7" type="button" onclick="$p.off('.n1.n2.n3');">off('.n1.n2.n3')</button> <button id="btn8" type="button" onclick="$p.off('.n1.n2');">off('.n1.n2')</button> <button id="btn9" type="button" onclick="$p.off('.n1');">off('.n1')</button> </div> <script> function log($e, msg) { var $log = $e.children('.log'); $log.append('<p>' + msg + '</p>'); } var $p = $('#parent'); $p.on('click.n1.n2.n3.n4', function(){ log($p, 'click n1 n2 n3 n4'); }); $p.on('click.n1.n2.n3', function(){ log($p, 'click n1 n2 n3'); }); $p.on('click.n1.n2', function(){ log($p, 'click n1 n2'); }); $p.on('click.n1', function(){ log($p, 'click n1'); }); $p.on('click', function(){ log($p, 'click'); $p.trigger('hello'); }); $p.on('hello.n1.n2.n3.n4', function(){ log($p, 'hello n1 n2 n3 n4'); }); $p.on('hello.n1.n2.n3', function(){ log($p, 'hello n1 n2 n3'); }); $p.on('hello.n1.n2', function(){ log($p, 'hello n1 n2'); }); $p.on('hello.n1', function(){ log($p, 'hello n1'); }); $p.on('hello', function(){ log($p, 'hello'); }); </script> </body> </html>

這裡為 click 與 hello 各掛五個不同命名空間組合的監聽,hello 在 click 的無命名空間回調中觸發。每測一個按鈕前重新整理,測完再點一下那個灰框容器。第五個按鈕除外,因為它把 click 的監聽全移掉了。

結果:click.n1.n2.n3.n4 未被呼叫,hello 不受影響。

結果:click.n1.n2.n3.n4 與 click.n1.n2.n3 未被呼叫,hello 不受影響。

結果:前三個帶命名空間的 click 監聽被移除,hello 不受影響。

結果:四個帶命名空間的 click 監聽被移除,hello 不受影響。

結果:所有 click 回調都未被呼叫,hello 不受影響。

前一半的結論:用「事件型別 + 命名空間」移除時,只會移除該事件型別中、且添加時包含那些命名空間的監聽器,不影響同型別的其他監聽,也不影響其他事件型別。例如移除 click.n1.n2,會帶走 click.n1.n2、click.n1.n2.n3、click.n1.n2.n3.n4,但 click.n1、click、hello 都安然無恙。只用事件型別移除,則會清掉該型別的所有監聽。

接著看第 6 到第 9 個按鈕:

結果:移除了 click.n1.n2.n3.n4 與 hello.n1.n2.n3.n4。

結果:移除了兩個事件各自前三個帶命名空間的監聽。

結果:移除了兩個事件各自前兩個帶命名空間的監聽。

結果:hello 與 click 上所有帶命名空間的監聽都被移除。

後一半的結論:只給命名空間移除時,會橫掃所有事件型別,把所有添加時包含那些命名空間的監聽一併清掉。最後的 off('.n1') 就把兩個事件上所有帶 .n1 的監聽都移走了。

七、本文小結

命名空間在觸發、冒泡、移除三個環節的行為規則都很明確,各節末尾都附了可直接查閱的結論。把這些規則記住,之後寫元件時事件隔離與清理都會從容很多。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved