DIV CSS 佈局教程網

JavaScript 模組化開發入門:SeaJS 完整指南
編輯:關於JavaScript     

前言

SeaJS 是一個遵循 CommonJS 規範的 JavaScript 模組載入框架,能讓前端程式碼真正模組化。它解決的是早期 JavaScript 開發中最頭痛的一組問題:依賴關係一團亂、程式碼彼此糾纏。用得好,可讀性與可維護性都會明顯提升。

SeaJS 從設計之初就抱持 KISS(Keep It Simple, Stupid)精神,後續幾個版本的演進也都朝這個方向前進。

基本原則

・一切皆為模組:SeaJS 的模組概念近似物件導向中的類——模組可以擁有資料與方法,也能區分公開與私有,公開成員供其他模組呼叫。

・每個模組定義在各自的 js 檔案中,一個檔案對應一個模組。

模組的定義: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) {
    // code of function…
};

define 可以接收三個參數,依傳入數量而有不同的指派規則:

・只傳一個參數時,該參數視為 factory;
・傳兩個參數時,第二個是 factory,第一個若是陣列則視為 deps,否則視為 id;
・傳三個參數時,三者分別對應 id、deps、factory。

不過包含官方範例在內,實務上幾乎都只傳入一個工廠函數:

define(function (require, exports, module) {
    // code of the module
});

建議就跟官方保持一致。那麼 id 與 deps 怎麼辦?id 是模組的識別字串,只有一個參數時它會被自動設為該 js 檔案的絕對路徑(例如 example.com 下的 a.js,其模組 id 就是 https://example.com/a.js),一般沒有必要手動傳;deps 通常也不需要,需要哪些模組用 require 載入即可。

工廠函數 factory

工廠函數是模組的主體,三個參數分別是:

・require:模組載入函數,用來宣告依賴;
・exports:介面點,掛上去的資料或方法會對外公開;
・module:模組的元資訊。

module 是個物件,包含 module.id(模組 ID)、module.dependencies(依賴模組 ID 的陣列)、module.exports(與 exports 指向同一個物件)。這三個參數都可以依需要省略。

三種撰寫風格

第一種,以 exports 掛載介面:

define(function (require, exports, module) {
    var a = require('a');
    var b = require('b');        // 引入模組

    var data1 = 1;               // 私有資料
    var fun1 = function () {     // 私有方法
        return a.run(data1);
    };

    exports.data2 = 2;           // 公開資料
    exports.fun2 = function () { return 'hello'; };   // 公開方法
});

第二種,直接回傳物件:

define(function (require) {
    var a = require('a');
    var b = require('b');

    var data1 = 1;
    var fun1 = function () { return a.run(data1); };

    return {
        data2: 2,
        fun2: function () { return 'hello'; }
    };
});

第三種,若模組只回傳一個物件,還能再簡化:

define({
    data2: 2,
    fun2: function () { return 'hello'; }
});

這一種特別適合定義純 JSON 資料模組。

載入模組的三個 API

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();
});

如果入口模組只有一個,還可以在載入 sea.js 的 script 標籤上加 data-main 屬性來省略 seajs.use:

<script src="./sea.js" data-main="./init"></script>

require 是模組內引用其他模組的主要方式:

var m = require('./a');

require.async 則是異步版本。SeaJS 在頁面載入時會靜態分析並一次抓齊所有依賴;若希望某支 js 直到真正用到時才下載,就改用 require.async,這才算是名副其實的按需載入。

全域設定

seajs.config({
    base: 'path',
    alias: { 'app': 'path/app/' },
    charset: 'utf-8',
    timeout: 20000,
    debug: false
});

base 是基址路徑;alias 用來替冗長的常用路徑取縮寫;charset 對應 script 標籤的 charset;timeout 是檔案下載的最長等待時間(毫秒)。

與既有函式庫共存

要讓現成的 JS 庫能在 SeaJS 中運作,只需依模組規範包一層即可,例如 jQuery:

define(function () {
    /* 此處放入 jquery 原始碼 */
});

完整範例

檔案清單:index.html(主頁面)、sea.js、jquery.js、init.js(入口模組,依賴 data、jquery、style)、data.js(純 JSON 資料模組)、style.css。

html:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<div id="content">
  <p class="author"></p>
  <p class="blog"><a href="#">Blog</a></p>
</div>
<script src="sea.js"></script>
<script>seajs.use('init');</script>
</body>
</html>

javascript:
// init.js
define(function (require, exports, module) {
    var $ = require('./jquery');
    var data = require('./data');
    var css = require('./style.css');
    $('.author').html(data.author);
    $('.blog').attr('href', data.blog);
});

// data.js
define({ author: 'ZhangYang', blog: 'https://blog.codinglabs.org' });

css:
.author { color: red; font-size: 10pt; }
.blog { font-size: 10pt; }

兩個提醒:第一,記得把 jQuery 原始碼包進 define 中;第二,Sea.js 2.3.0 之後已移除載入 css 的功能,為了相容舊專案,這項能力改以插件形式提供——可以在 sea.js 之後另外載入插件,或把插件程式碼直接併入 sea.js。順帶釐清兩個容易混淆的名稱:seajs-css 讓 SeaJS 能像 link 標籤那樣載入一個 css 檔,seajs-style 則是提供 importStyle 方法來載入一段 css 字串。

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