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.js 中,atest() 供 b 調用,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.js 中反向調用 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(); } } });

這樣等到執行 atest() 時才去取 a,那時 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 對象,在它上面掛方法。以 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 風格的模塊,直接這樣引入,它內部的匿名函數不會被執行,方法自然也就沒掛上去。改法是手動把它的匿名函數調用起來,並把 $ 傳進去:

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

這是網上搜來的解法,原理上我理解得還不算透徹,但確實能跑通。

jQuery UI 帶來的 DOM 重渲染問題

requirejs 加載完就立即執行,如果某個 UI 插件會刷新 DOM,頁面的事件很可能就此失效。

典型場景:模塊加載後給 $('#test') 綁了 click,接著用了某個會重新渲染 DOM 的 UI 插件,節點被換掉,事件跟著丟了。

解決辦法有兩個方向:把事件綁定推遲到 DOM 渲染完成之後手動觸發;或者用事件捕獲/委託代替直接綁定(改造成本較高,不太推薦)。

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

 require("xxx").initEvents();

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

以上就是這輪模塊化改造中遇到的主要問題與處理方式,希望能給同樣在折騰的人一個參考。

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