萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

RequireJS 入門指南:AMD 模組化、配置優化與實戰工作流

RequireJS 是 AMD(非同步模組定義)規範的經典實現,解決了傳統 <script> 標籤載入順序耦合、全域污染、依賴管理混亂等問題。本文從核心概念到實戰配置,帶你快速上手模組化開發。

為什麼需要 AMD?

傳統腳本載入痛點:

  • 順序耦合:<script src="a.js"> 必須在 b.js 之前,手動維護極易出錯。
  • 全域污染:所有變數掛載 window,命名衝突頻發。
  • 同步阻塞:<script> 會阻塞 HTML 解析與渲染。

AMD 定義:非同步載入模組及其依賴,並在載入完成後透過回呼執行工廠函數。

RequireJS 核心 API

API用途簽名
define定義模組define(id?, deps?, factory)
require載入依賴/啟動應用require(deps, callback)
require.config全域配置require.config(options)

快速上手:data-main 啟動入口

<!-- HTML -->
<script data-main="js/main" src="js/lib/require.js"></script>

data-main 指定入口模組(自動加 .js),RequireJS 載入後會:

  1. 以 data-main 所在目錄為 baseUrl。
  2. 非同步載入 main.js。
  3. 執行 main.js 內的 require/define。

配置詳解 require.config

require.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') 延遲載入。
  • CDN 載入失敗備援:paths: { jquery: ['//cdn.jsdelivr.net/jquery/3.6.0/jquery.min', 'lib/jquery.min'] } 陣列寫法自動降級。
  • 開發/生產環境區分:開發用未壓縮版、source map;生產跑 r.js 優化器合併壓縮(見下文)。
  • 避免全域污染:模組內嚴禁掛載 window,所有依賴靠參數傳遞。

下一步:專案優化

開發時模組分散利於維護,生產需合併壓縮。請參考 《優化 RequireJS 專案:r.js 合併壓縮完整實戰》 了解建構流程。

copyright © 萬盛學電腦網 all rights reserved