萬盛學電腦網

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

將 jQuery 與插件封裝為 SeaJS (CMD) 模組的標準化指南

背景

SeaJS 採用 CMD 規範,要求模組具備 define(id?, deps?, factory) 格式。jQuery 及其插件原為全域變數模式,需包裝才能納入模組化建構流程。

一、封裝 jQuery 核心為基礎模組

// 文件:lib/jquery/2.1.1/jquery.js
define('jquery', function(require, exports, module) {
    // 這裡直接貼上 jQuery 完整原始碼(含 /*! jQuery v2.1.1 ... */ 版權標頭)
    // ... jQuery 完整程式碼 ...
    
    // 關鍵:釋放全域 $、jQuery 佔用,回傳 jQuery 實例供模組引用
    return $.noConflict(true);
});

SeaJS 設定別名與路徑

seajs.config({
    base: '/assets/js/',
    alias: {
        'jquery': 'lib/jquery/2.1.1/jquery',
        '$': 'lib/jquery/2.1.1/jquery' // 習慣用 $ 當別名
    },
    map: [
        // 開發環境對映到源碼,正式環境對映到 min 版
        [/^(.*\/jquery)$/, '$1.min']
    ]
});

業務模組引用 jQuery

// 文件:src/modules/user/list.js
define(function(require, exports, module) {
    var $ = require('jquery'); // 或 require('$')
    
    $(function() {
        $('.user-table tr').hover(function() {
            $(this).toggleClass('highlight');
        });
    });
    
    exports.init = function() { /* ... */ };
});

二、封裝 jQuery 插件(以 jquery.lazyload 為例)

// 文件:lib/jquery-plugins/lazyload/1.9.7/lazyload.js
define('jquery-lazyload', ['jquery'], function(require, exports, module) {
    var $ = require('jquery');
    
    // 貼上插件原始碼,通常格式為 (function($){ ... })(jQuery)
    // 此處假設插件已採 UMD 寫法或直接擴充 $.fn
    // 若插件未回傳值,手動回傳 $ 以利鏈式調用
    return $;
});

使用插件

define(function(require, exports, module) {
    var $ = require('jquery');
    require('jquery-lazyload'); // 執行插件安裝,掛載到 $.fn.lazyload
    
    $('img.lazy').lazyload({ effect: 'fadeIn', threshold: 200 });
});

三、封裝自訂工具類別(如原文的日期格式化類)

// 文件:src/utils/date-formatter.js
define(function(require, exports, module) {
    var $ = require('jquery'); // 若工具類不依賴 jQuery 可省略
    
    var WEEKDAYS = ['星期日','星期一','星期二','星期三','星期四','星期五','星期六'];
    
    function pad(n) { return n < 10 ? '0' + n : '' + n; }
    
    var DateFormatter = {
        // 格式化字串支援:YYYY, MM, DD, HH, mm, ss, W (星期)
        format: function(date, fmt) {
            if (!(date instanceof Date)) date = new Date(date);
            if (isNaN(date.getTime())) return '';
            
            var o = {
                'YYYY': date.getFullYear(),
                'MM': pad(date.getMonth() + 1),
                'DD': pad(date.getDate()),
                'HH': pad(date.getHours()),
                'mm': pad(date.getMinutes()),
                'ss': pad(date.getSeconds()),
                'W': WEEKDAYS[date.getDay()]
            };
            
            return fmt.replace(/YYYY|MM|DD|HH|mm|ss|W/g, function(m) { return o[m]; });
        },
        
        parse: function(str, fmt) {
            // 簡易解析,生產環境建議用 moment.js 或 date-fns
            var map = { YYYY: 'getFullYear', MM: 'getMonth', DD: 'getDate', HH: 'getHours', mm: 'getMinutes', ss: 'getSeconds' };
            var vals = {};
            fmt.replace(/YYYY|MM|DD|HH|mm|ss/g, function(m) {
                var idx = str.indexOf(m.replace(/[YMDHms]/g, '')); // 簡易對應,實際需正則提取
            });
            return new Date(vals.YYYY, (vals.MM||1)-1, vals.DD||1, vals.HH||0, vals.mm||0, vals.ss||0);
        }
    };
    
    module.exports = DateFormatter; // CMD 標準導出
});

四、建構流程整合

// 使用 spm / gulp-seajs-combo / webpack + sea.js loader 進行打包
// 開發時:seajs.use('src/main');
// 正式部署:合併壓縮為單檔,SeaJS 運行時自動解析依賴圖

避坑指南

  • 不要在 define 內操作全域 $:務必用 require('jquery') 取得區域實例。
  • 插件依賴順序:define('plugin', ['jquery'], ...) 確保 jQuery 先載入。
  • 版本衝突:專案若需多版本 jQuery,利用 $.noConflict(true) 並在各模組獨立 require。
  • 循環依賴:SeaJS 支援循環依賴,但建議重構避免。
copyright © 萬盛學電腦網 all rights reserved