這篇著重講 SeaJS 的實際用法:怎麼裝、怎麼寫模塊、怎麼載入、怎麼配置。
SeaJS 項目托管在 GitHub 上,主頁為 https://github.com/seajs/seajs/。從 git 庫的 build 目錄可以下到 sea.js(壓縮版)或 sea-debug.js(未壓縮,適合開發期排查)。放進項目後用 <script> 引入即可。
引入 SeaJS 後,寫 JavaScript 就等於寫一個又一個模塊。模塊的概念有點像面向對象裡的類——可以擁有數據和方法,可以分公共與私有,公共部分供其他模塊調用。另外有一條約定:一個模塊對應一個單獨的 js 文件。
SeaJS 文檔對 define 的說明並不完整,從源碼可以看到它接受三個參數:
/**
* Defines a module.
* @param {string=} id The module id.
* @param {Array|string=} deps The module dependencies.
* @param {function()|Object} factory The module factory function.
*/
fn.define = function (id, deps, factory) {
// ...
}
不同參數個數下的解析規則是:
factoryfactory;第一個若是數組則給 deps,否則給 idid、deps、factory但包括官方示例在內,幾乎所有地方都只傳一個工廠函數:
define(function (require, exports, module) {
// 模塊代碼
});
建議遵循這個標準寫法。此時 id 會默認取該 js 文件的絕對路徑(例如 example.com 下的 a.js,id 就是 https://example.com/a.js),沒有特別必要不要手動傳。deps 一般也不用傳,用到什麼模塊用 require 加載即可。
require——模塊加載函數,用於聲明依賴exports——接口點,掛在上面的數據和方法會暴露給外部module——模塊的元數據對象,含 module.id、module.dependencies、module.exports(與 exports 指向同一對象)模式一:基於 exports
define(function (require, exports, module) {
var a = require('a');
var b = require('b');
var data1 = 1; // 私有數據
var func1 = function () { // 私有方法
return a.run(data1);
};
exports.data2 = 2; // 公共數據
exports.func2 = function () { // 公共方法
return 'hello';
};
});
模式二:直接返回對象,功能與上面等價:
define(function (require) {
var a = require('a');
var b = require('b');
var data1 = 1;
var func1 = function () { return a.run(data1); };
return {
data2: 2,
func2: function () { return 'hello'; }
};
});
模式三:只返回對象的簡化寫法,特別適合純 JSON 數據模塊:
define({
data: 1,
func: function () { return 'hello'; }
});
SeaJS 支持三類標識:
require("https://example/js/a") 載入 https://example/js/a.js./ 開頭,相對於調用 require 所在的 js 文件。在 https://example/js/b.js 中寫 require("./c") 會載入 https://example/js/c.js./ 開頭,則相對全局配置的 base 尋址SeaJS 會自動補 .js 後綴,但三種情況例外:載入 css 時(require("./module1-style.css"))、路徑含 ? 時、路徑以 # 結尾時。
seajs.use 用於載入入口模塊,相當於 C 程序的 main 函數,也是整個依賴圖的根:
seajs.use('./a'); // 單一模式
seajs.use('./a', function (a) { a.run(); }); // 回調模式
seajs.use(['./a', './b'], function (a, b) { // 多模塊模式
a.run();
b.run();
});
入口模塊只有一個時,可以用 script 標簽的 data-main 屬性代替,讓 HTML 更簡潔:
<script src="./sea.js" data-main="./init"></script>
require 是主要的模塊加載方法:
var m = require('/path/to/module/file');
SeaJS 的自動加載機制是這樣的:先下載入口模塊,用正則表達式掃描代碼中所有 require 調用,按其中的路徑標識下載對應 js 文件,再對新下載的文件重複這個過程。整個過程類似圖的遍歷(因為可能存在循環依賴,依賴結構是圖而非樹)。
由此推出的一條硬性規則:傳給 require 的路徑標識必須是字符串字面量,不能是表達式。以下寫法都會導致正則匹配失敗:
require('module' + '1'); // 錯
require('Module'.toLowerCase()); // 錯
require.async 實現按需加載:
require.async('/path/to/module/file', function (m) {
// 回調
});
這樣只有真正用到該模塊時,對應文件才會被下載。
seajs.config({
base: 'path/to/jslib/',
alias: { 'app': 'path/to/app/' },
charset: 'utf-8',
timeout: 20000,
debug: false
});
base 是基址尋址的根路徑,設為 https://example.com/js/3-party/ 後,require('jquery') 會載入 https://example.com/js/3-party/jquery.js。alias 為長路徑起縮寫。charset 是 script 標簽的字符集。timeout 是下載超時(毫秒)。debug 控制是否工作在調試模式。
把 jQuery 這類庫接入 SeaJS,只需按模塊規則包一層:
define(function () {
// {{{ jQuery 原有代碼開始
/*! jQuery JavaScript Library v1.6.1 ... */
// ...
// }}} jQuery 原有代碼結束
return $.noConflict();
});
SeaJS 原本集成了打包工具 spm,後來為保持 KISS 而拆成獨立項目。其核心思想是將所有模塊代碼合併壓縮後併入入口模塊,由於 SeaJS 的特性,HTML 不需任何改動就能在開發與生產環境間切換。不過 spm 一直未發正式版,且各項目使用的合併壓縮工具差異較大,理解原理後完全按自己項目的情況寫一個打包腳本更實際。