DIV CSS 佈局教程網

RequireJS 多頁面應用實戰:define、require 與 config 完整解析
編輯:關於JavaScript     

本文整理 RequireJS 的核心觀念,並用一個多頁面應用的實例把知識串起來。RequireJS 主要就三個 API:define 創建模組、require 載入模組、config 進行設定。

一、在 HTML 中掛載 JS

page1.html:

<!DOCTYPE html>
<html>
<head>
<title>Page 1</title>
<script data-main="scripts/page1" src="scripts/lib/require.js"></script>
</head>
<body>
<a href="page2.html">Go to Page 2</a>
</body>
</html>

page2.html:

<!DOCTYPE html>
<html>
<head>
<title>Page 2</title>
<script data-main="scripts/page2" src="scripts/lib/require.js"></script>
</head>
<body>
<a href="page1.html">Go to Page 1</a>
</body>
</html>

知識點:data-main 指定網頁的主模組,它會被 RequireJS 優先載入。由於預設副檔名就是 js,所以 page1.js 可以簡寫成 page1。

基準路徑 baseUrl 的優先順序:用 require 載入模組時若省略 .js,會從 baseUrl 底下找;若名稱帶 .js、以 / 開頭,或含有 http/https 協定,則依實際寫的路徑查找。優先級為 config > data-main > 預設 baseUrl。不設定 data-main 與 config 時,baseUrl 就是引入 require.js 那個 HTML 頁面所在目錄;一旦設了 data-main,baseUrl 會變成主模組所在目錄(上例中即 /scripts)。

二、用 config 調整模組設定

在多頁面應用中,把設定抽到共用檔案裡是實務上的標準做法。本例用 common.js 統一管理,各頁面先載入這份設定,再在回呼中載入自己需要的模組。

require.config({
  baseUrl: 'scripts/app',
  paths: {
    jquery: [
      'https://lib.sinaapp.com/js/jquery/1.9.1/jquery-1.9.1.min',
      '../lib/jquery'
    ]
  }
});

常用設定項說明:

baseUrl:所有模組的查找根路徑。若載入的 js 以 .js 結尾、以 / 開頭或含協定,則不受 baseUrl 影響。

paths:為那些不在 baseUrl 底下的模組做路徑映射,起始位置相對於 baseUrl(除非以 / 開頭或含協定)。注意 paths 中不能寫 .js 副檔名,因為解析機制會自動補上;另外可以設成陣列提供多個候選路徑,例如 CDN 載入失敗時自動改抓本地檔案——上面的寫法就是這個用意。

shim:為那些沒有用 define 宣告依賴關係的老舊函式庫做設定,兩個關鍵參數是 exports(要暴露的變數名)與 deps(依賴陣列)。

require.config({
  baseUrl: '/scripts/lib',
  shim: {
    zepto: { exports: '$' },
    backbone: { deps: ['underscore', 'zepto'], exports: 'Backbone' },
    'zepto.animate': ['zepto']
  }
});

三、載入模組

page1.js:

require(['./common'], function(common) {
  require(['sayPage1'], function(sayPage1) {
    sayPage1.hello();
  });
});

page2.js:

require(['./common'], function(common) {
  require(['sayPage2'], function(sayPage2) {
    sayPage2.hello();
  });
});

知識點:require 接受兩個參數——依賴模組的陣列,以及這些模組都載入完成後才會被呼叫的回呼函式;載入的模組會作為回呼的參數傳入。這裡刻意把第二次 require 寫在回呼裡,就是為了確保 config 已經執行完、路徑能被正確解析。

四、定義模組

sayPage1.js:

define(['jquery'], function($) {
  function sayHi() {
    $('body').append('<h1>Hello page1!</h1>');
  }
  return { hello: sayHi };
});

知識點:define 同樣接受兩個參數,第一個是依賴模組陣列,第二個是回呼函式,回呼的返回值就是對外暴露的物件。

最後補充一點:正式上線前,記得用 r.js 把這些模組合併壓縮,RequestReduce、gulp 或 webpack 也都能勝任,能省下大量 HTTP 請求。

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