DIV CSS 佈局教程網

RequireJS 加 jQuery 做模塊化時踩過的日常坑
編輯:關於JavaScript     

手上的一個老項目 JS 越寫越重,單文件上千行早已失控,實在需要按職責拆開。在 requirejs 和 seajs 之間猶豫了一陣,最後倒向 requirejs,理由很樸素:官方文檔寫得夠細。

但文檔詳盡不代表不會踩坑,jQuery UI 的接入就折騰了一會兒。下面按實際遇到的順序記錄。

先把 AMD 和 CMD 分清楚

AMD 是異步模塊定義,代表實現是 requirejs;CMD 是通用模塊定義,代表是 seajs。

兩者都異步加載 JS,差別在執行時機。requirejs 一旦加載完成就立刻執行;seajs 要等到主函數裡真正用到時才執行。

seajs 的首屏加載負擔更輕,但執行被推遲到使用階段,理論上存在中途卡頓的可能(這一點我沒有實測過,僅供參考)。requirejs 則是開局就把所有依賴執行掉,副作用是:如果模塊裡存在頂層執行語句,實際執行順序未必符合你的預期。

所以:習慣異步思維、看中文檔完善度,選 requirejs;對執行順序有硬性要求又講究開發順手,seajs 也是選項。

循環依賴

a 依賴 b、b 又依賴 a,就會拋出循環依賴異常。先把它復現出來。

主頁面:

 <!DOCTYPE html> <html> <head> </head> <body> <script data-main="test.js" src="lib/require.js"></script> </body> </html>

入口文件:

 requirejs.config({ baseUrl: './' }); requirejs(['js/a'],function (a){ console.log("in test"); a.testfromb(); });

a 模塊,atest() 供外部調用,testfromb() 內部去調 b:

 define(function(require){ var b = require("js/b"); console.log("in a"); return { atest:function(){ console.log("test in a"); }, testfromb:function(){ console.log("testfromb in a"); b.btest(); } } });

b 模塊反向依賴 a:

 define(function(require){ var a = require("js/a"); console.log("in b"); return { btest:function(){ console.log("test in b"); a.atest(); } } });

控制檯拋出:

 Uncaught Error: Module name "js/a" has not been loaded yet for context: _ 

官方文檔的立場是:這屬於設計缺陷,應從源頭避免。真的繞不開時,把 require 延後到使用的那一刻:

 define(function(require){ // var a = require("js/a"); console.log("in b"); return { btest:function(){ console.log("test in b"); require("js/a").atest(); } } });

這樣 a 在真正被需要時已經加載完畢,輸出變成:

 in b a.js:3 in a test.js:6 in test a.js:9 testfromb in a b.js:6 test in b a.js:6 test in a

需要注意方向性:同樣的改法放到 a 那邊就未必有效,因為加載鏈是從 b 起始的。反過來看,循環依賴本身就是模塊職責劃分不清的信號,值得重新審視邊界。

接入 jQuery

這步最簡單,配好路徑直接用:

 requirejs.config({ baseUrl: './', paths:{ 'jquery':'lib/jquery' } }); requirejs(['jquery'], function ($){ $('#test').html('test'); });

接入 jQuery 插件

插件的通用模式是接收 jQuery 對象並在其上擴展方法。以 jquery-ui 與 jquery-dataTables 為例,先聲明依賴:

 requirejs.config({ baseUrl: './', paths:{ 'jquery':'lib/jquery', 'jquery-ui':'lib/jquery-ui', 'jquery-dataTables':'lib/jquery.dataTables' }, shim:{ 'jquery-ui':['jquery'], 'jquery-dataTables':['jquery'] } }); requirejs(['jquery','jquery-ui','jquery-dataTables'], function ($){ .... });

插件都建立在 jQuery 之上,所以要在 shim 裡明確這層依賴關係,加載順序才有保障。

也可以換成 CommonJS 風格:

 define(function(require){ var $ = require('jquery'); require('jquery-ui'); require('jquery-dataTables'); //下面都是測試,可以忽略 var _test = $('#test'); _test.selectmenu({ width : 180, change : function(event, ui) { console.log('change'); } }); return { test:function(){ //測試jquery-ui _test.append($('<option>test1</option><option>test1</option>')); _test.selectmenu("refresh"); //測試jquery-datatables var _table = $('table'); _table.dataTable(); } } });

此時會遇到:

 Uncaught TypeError: _table.dataTable is not a function 

根因是 dataTables 並非 AMD 風格的模塊,直接引入並不會執行它內部的匿名函數,方法自然沒有掛到 jQuery 上。繞過辦法是手動調用那個匿名函數並把 $ 傳進去:

 */ return $.fn.dataTable; //}));原來是這樣 }($)));//這裡增加執行這個匿名函數,並且傳入$對象。 }(window, document));

這個方案是網上搜到的,原理我理解得還不夠透徹,但實測可行。

jQuery UI 引起的 DOM 重渲染

requirejs 加載即執行,如果 UI 插件會刷新 DOM,之前綁定的事件很可能一起丟失。

典型場景:模塊加載後給 $('#test') 綁了 click,隨後某個 UI 插件重新渲染了 DOM,節點被替換,事件失效。

解決方向有兩個:把事件綁定推遲到 DOM 渲染完成後再手動觸發;或者改用事件捕獲/委託(改造量大,不太推薦)。

比如在負責 DOM 重構的模塊中,渲染邏輯之後補一句:

 require("xxx").initEvents(); 

我在頁面裡用過 jquery-steps,它會重排整個結構,最開始綁的事件因此全部失效,只能等它渲染完再綁一遍。

以上就是這輪模塊化改造中整理出的常見問題與處理方式,希望能給同樣在折騰的人一點參考。

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