RequireJS 是 AMD(非同步模組定義)規範的經典實現,解決了傳統 <script> 標籤載入順序耦合、全域污染、依賴管理混亂等問題。本文從核心概念到實戰配置,帶你快速上手模組化開發。
傳統腳本載入痛點:
<script src="a.js"> 必須在 b.js 之前,手動維護極易出錯。window,命名衝突頻發。<script> 會阻塞 HTML 解析與渲染。AMD 定義:非同步載入模組及其依賴,並在載入完成後透過回呼執行工廠函數。
| API | 用途 | 簽名 |
|---|---|---|
define | 定義模組 | define(id?, deps?, factory) |
require | 載入依賴/啟動應用 | require(deps, callback) |
require.config | 全域配置 | require.config(options) |
<!-- HTML -->
<script data-main="js/main" src="js/lib/require.js"></script>
data-main 指定入口模組(自動加 .js),RequireJS 載入後會:
data-main 所在目錄為 baseUrl。main.js。main.js 內的 require/define。require.configrequire.config({
// 根路徑,預設為 data-main 目錄
baseUrl: 'js/app',
// 別名映射:不在 baseUrl 下的模組
paths: {
'jquery': 'lib/jquery-3.6.0.min',
'lodash': 'lib/lodash.min',
'backbone': 'lib/backbone.min',
'text': 'lib/require/text' // 文字模板外掛
},
// 非 AMD 模組包裝
shim: {
'backbone': {
deps: ['underscore', 'jquery'],
exports: 'Backbone'
},
'underscore': { exports: '_' },
'jquery': { exports: '$' }
},
// 預先載入依賴
deps: ['jquery'],
// 等待秒數
waitSeconds: 15
});
define// 簡單值模組
define('config', {
apiBase: '/api/v1',
timeout: 5000
});
// 依賴其他模組的工廠函數
define(['jquery', 'lodash', 'config'], function($, _, config) {
// 私有邏輯
function privateHelper() { /* ... */ }
// 公開 API
return {
fetchUser: function(id) {
return $.getJSON(config.apiBase + '/users/' + id);
},
formatName: function(user) {
return _.startCase(user.firstName + ' ' + user.lastName);
}
};
});
require(啟動應用)// main.js 入口
require(['app/router', 'app/views/header', 'domReady!'], function(Router, HeaderView) {
// DOM 就緒後啟動路由
new HeaderView().render();
Router.start();
});
domReady! 是 RequireJS 內建外掛,確保 DOM 就緒再執行回呼。
define(['b'], function(b){...}) 中若 b 又依賴 a,需在 a 的 factory 內 require('b') 延遲載入。paths: { jquery: ['//cdn.jsdelivr.net/jquery/3.6.0/jquery.min', 'lib/jquery.min'] } 陣列寫法自動降級。r.js 優化器合併壓縮(見下文)。window,所有依賴靠參數傳遞。開發時模組分散利於維護,生產需合併壓縮。請參考 《優化 RequireJS 專案:r.js 合併壓縮完整實戰》 了解建構流程。