DIV CSS 佈局教程網

Bootstrap 原始碼解析:JavaScript 外掛的整體架構
編輯:關於JavaScript     

Bootstrap 的 JS 外掛有高度一致的骨架。讀懂一個,其他十幾個都能快速上手;想自己寫外掛時,這套骨架也是很好的範本。

一、外掛的統一結構

以下是 alert 外掛的完整程式碼,每個外掛都定義在類似的作用域中:

 +function ($) { 'use strict'; // ALERT CLASS DEFINITION // ====================== var dismiss = '[data-dismiss="alert"]' var Alert = function (el) { $(el).on('click', dismiss, this.close) } Alert.VERSION = '3.3.7' Alert.TRANSITION_DURATION = 150 Alert.prototype.close = function (e) { var $this = $(this) var selector = $this.attr('data-target') if (!selector) { selector = $this.attr('href') selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') // strip for ie7 } var $parent = $(selector === '#' ? [] : selector) if (e) e.preventDefault() if (!$parent.length) { $parent = $this.closest('.alert') } $parent.trigger(e = $.Event('close.bs.alert')) if (e.isDefaultPrevented()) return $parent.removeClass('in') function removeElement() { // detach from parent, fire event then clean up data $parent.detach().trigger('closed.bs.alert').remove() } $.support.transition && $parent.hasClass('fade') ? $parent .one('bsTransitionEnd', removeElement) .emulateTransitionEnd(Alert.TRANSITION_DURATION) : removeElement() } // ALERT PLUGIN DEFINITION // ======================= function Plugin(option) { return this.each(function () { var $this = $(this) var data = $this.data('bs.alert') if (!data) $this.data('bs.alert', (data = new Alert(this))) if (typeof option == 'string') data[option].call($this) }) } var old = $.fn.alert $.fn.alert = Plugin $.fn.alert.Constructor = Alert // ALERT NO CONFLICT // ================= $.fn.alert.noConflict = function () { $.fn.alert = old return this } // ALERT DATA-API // ============== $(document).on('click.bs.alert.data-api', dismiss, Alert.prototype.close) }(jQuery); //通過將作用域內的Alert類賦值給jQuery的alert對象的Constructor屬性,在IIFE作用域外也可以使用Alert類,比如這行代碼 var Alert = $.fn.alert.Constructor 

所有外掛都遵循同樣的規則,這也為自訂外掛提供了規範。大致可歸納為三點:

1. HTML 佈局規則:基於元素自訂屬性的宣告式佈局,例如 data-target。

2. JavaScript 實作步驟:遵循 jQuery 外掛開發的標準流程,事件命名保持一致。

3. 外掛呼叫方式:支援 HTML 宣告式與 JS 呼叫式兩種。

1.1 HTML 佈局規則

預設情況下,所有外掛都能透過特定的 HTML 標記與自訂屬性來啟用。頁面載入時,JS 會自動偵測這些標記並綁定事件,不需額外套用程式碼。

點擊按鈕即可關閉警告框:

 <div class="alert"> <button type="button" class="close" data-dismiss="alert"></button> <strong>警告!</strong>你輸入的項目不合法! </div> 

下拉選單:在 button 上加 data-toggle="dropdown",點擊時預設隱藏的 dropdown-menu 就會顯示。

 //例子:下拉菜單.html <div class="btn-group"> <button type="button" class="btn btn-default" data-toggle="dropdown"> 我的書籍<span class="caret"></span> </button> <ul class="dropdown-menu"> <li><a href="#">編程</a></li> <li><a href="#">設計</a></li> <li><a href="#">深入</a></li> </ul> </div> 

1.2 JavaScript 實作步驟

1. 宣告立即呼叫函式,例如 +function($){ "use strict"; }(window.jQuery);

參數中傳入 jQuery 物件有兩個好處:一是函式內部的 $ 是局部變數而非全域變數,可避免變數污染;二是內部程式碼全部私有,外部無法存取,只能透過第三步掛在 $.fn 上的唯一入口使用,等於保護了實作細節。

前面那個 + 的作用,是防止上一段程式碼沒有正常結束(例如漏了分號),導致前後被編譯器視為同一個表達式而報錯。

 +function($){ "use strict"; }(window.jQuery); 

2. 定義外掛類別與原型方法,例如 Alert 與 prototype.close

先定義選擇器,所有符合該自訂屬性的元素都能觸發後續事件:

 var dismiss = '[data-dismiss="alert"]'; var Alert = function(el) { //傳入元素,如果元素內部有dismiss上設置的自定義屬性,則click事件會觸發原型上的close方法 $(el).on('click',dismiss,this.close); }; Alert.prototype.close = function(e) { } 

3. 在 jQuery 上定義外掛並重設構造函式,例如 $.fn.alert.Constructor = Alert

 function Plugin(option) { return this.each(function () { var $this = $(this) //獲取存儲的Alert對象,如果是第一次執行變量data的值為undefined var data = $this.data('bs.alert') //緩存沒有,就new一個alert對象,存儲在元素的jQuery對象上的'bs.alert'數據字段 if (!data) $this.data('bs.alert', (data = new Alert(this))) //支持傳入方法名參數,執行該方法,這裡就是data.close() if (typeof option == 'string') data[option].call($this) }) } //jQuery插件的定義使用了標准的方式,在fn上進行擴展,在jQuery上定義alert插件 //保留其他插件的$.fn.alert代碼(如果定義)以便在noConflict之後,可以繼續使用改舊代碼 //先備份之前插件的舊代碼,以便在後面防沖突的時候使用 var old = $.fn.alert $.fn.alert = Plugin //在附加擴展之後,重新設置插件的構造器(即Constructor屬性),這樣就可以通過Constructor屬性查詢到插件的真實類函數,使用new操作符實例化的時候也不會出錯 //js區分大小寫,所以這裡的Constructor只是一個普通屬性,跟constructor不同,通過將作用域內的Alert類賦值給jQuery的alert對象的Constructor屬性,在IIFE作用域外也可以使用Alert類 $.fn.alert.Constructor = Alert 

這裡有兩個實作巧思:一是把外掛實例快取在元素的 data 上,避免重複 new;二是 option 可以是物件也可以是要執行的函式名稱字串,所以 $('#x').modal('show') 這種寫法才行得通。

若不宣告第三步,HTML 宣告式仍然可用。所以第三步是專門為偏好用 JS 觸發事件的人準備的。需要注意的是,如果第三步不做,第四步的防衝突功能也就跟著失效了。

4. 防衝突處理,例如 $.fn.alert.noConflict

目的是讓 Bootstrap 外掛與其他 UI 庫的同名外掛並存。

 $.fn.alert.noConflict = function() { //恢復以前的代碼 $.fn.alert = old //將$.fn.alert.noConflict()設置為BootStrap的alert插件 return this } 

若 A 庫已有同名的 $.fn.alert,Bootstrap 在載入時先透過 old 備份,呼叫 $.fn.alert.noConflict() 後即還原為 A 庫的版本;而 Bootstrap 自己的外掛則可以透過 var alert = $.fn.alert.noConflict() 存到另一個變數上繼續使用。

5. 綁定觸發事件(data-api)

有了 $.fn.alert 這個預設擴充,就可以用 JS 主動觸發;而這一段則負責讓宣告式的 HTML 也能運作:

 /* ALERT DATA-API 這段JavaScript代碼將click委托事件監聽器綁定在document元素上,並給click事件賦予命名空間 jQuery將事件綁定在document文檔對象上的好處,就是js事件代理的優點 */ $(document).on('click.bs.alert.data-api',dismiss,Alert.prototype.close) 

把事件綁在 document 上(事件代理)的好處,是動態加入的元素也自動生效,同時減少個別綁定的數量。

命名空間的價值在於可以精準地觸發或解綁特定事件。從 jQuery 1.7 起,.on() 與 .off() 統一了事件綁定機制,是操作 DOM 事件的推薦方式。有時候我們既手動觸發,也需要解除綁定:

 $('.item').on('click', doThisCoolThing); $('.item').on('click', doThisOtherCoolThing); $('.item').trigger('click'); // 兩個click事件都觸發 $('.item').off('click'); // 兩個click事件都解綁 

加上命名空間後就能精準指定:

 $('.item').on('click.navigate', doThisCoolThing); $('.item').on('click.notify', doThisOtherCoolThing); $('.item').trigger('click.navigate'); // 只有帶有navigate這個命名空間的方法才會觸發 $('.item').off('click.notify'); // 只有帶有notify這個命名空間的方法才會解綁 

也可以叠加多個命名空間,用其中任一即可生效。依照「產品.模組.事件」的規範命名,事件的層次會更清楚:

 $('.item').on('click.navigate.notify', doThisCoolThing); $('.item').trigger('click.navigate'); // 將觸發click事件 $('.item').off('click.notify'); // 將解綁click事件 

延伸閱讀:
https://www.andismith.com/blog/2011/11/on-and-off/
https://www.andismith.com/blog/2013/02/jquery-on-and-off-namespacing/

1.3 外掛呼叫方式

1. 用 JS 呼叫,支援多種形式(無參數、傳物件字面值、傳要執行的函式名稱):

 $("#myModal").modal(); $("#myModal").modal({keyboard:false}); $("#myModal").modal('show'); 

每個外掛都有 Constructor 屬性指向原始建構函式,也可以透過 $('#選擇器').data('bs.外掛名稱') 取得該元素的特定外掛實例。

2. HTML 宣告式:直接在標籤上寫 data-* 自訂屬性即可。

若想停用 data-api:

 //命名空間為data-api的全部事件禁用 $(document).off('.data-api'); //禁用特定插件的默認行為,禁用該插件所在命名空間下事件即可 $(document).off('.alert.data-api'); //禁用該alert插件的click事件 $(document).off('click.alert.data-api'); 

以上就是 Bootstrap JavaScript 外掛架構的完整解析,希望對你的學習有所幫助。

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