插件兼容CommonJS, AMD, CMD 和 原生 JS


模塊標准

CommonJS

CommonJS 有三個全局變量 moduleexports 和 require。但是由於 AMD 也有 require 這個全局變量,故不使用這個變量來進行檢測。

如果想要對外提供接口的話,可以將接口綁定到 exports (即 module.exports) 上。

function MyModule() { // ... } if(typeof module !== `undefined` && typeof exports === `object`) { module.exports = MyModule; }

CMD

CMD 規范中定義了 define 函數有一個公有屬性 define.cmd

CMD 模塊中有兩種方式提供對外的接口,一種是 exports.MyModule = ...,一種是使用 return 進行返回。

AMD

AMD 規范中,define 函數同樣有一個公有屬性 define.amd

AMD 中的參數便是這個模塊的依賴。那么如何在 AMD 中提供接口呢?它是返回一個對象,這個對象就作為這個模塊的接口,故我們可以這樣寫:

function MyModule() { // ... } if(typeof define === `function` && define.amd) { define(function() { return MyModule; }); }

總結

我們除了提供 AMD 模塊接口,CMD 模塊接口,還得提供原生的 JS 接口。
由於 CMD 和 AMD 都可以使用 return 來定義對外接口,故可以合並成一句代碼。

一個直接可以用的代碼如下:

;(function(){ function MyModule() { // ... } var moduleName = MyModule; if (typeof module !== 'undefined' && typeof exports === 'object') { module.exports = moduleName; } else if (typeof define === 'function' && (define.amd || define.cmd)) { define(function() { return moduleName; }); } else { this.moduleName = moduleName; } }).call(function() { return this || (typeof window !== 'undefined' ? window : global); });


另外一種寫法:


/閉包執行一個立即定義的匿名函數
!function(factory) {

    //factory是一個函數,下面的koExports就是他的參數

    // Support three module loading scenarios
    if (typeof require === 'function' && typeof exports === 'object' && typeof module === 'object') {
        // [1] CommonJS/Node.js
        // [1] 支持在module.exports.abc,或者直接exports.abc
        var target = module['exports'] || exports; // module.exports is for Node.js
        factory(target);
    } else if (typeof define === 'function' && define['amd']) {
        // [2] AMD anonymous module
        // [2] AMD 規范 
        //define(['exports'],function(exports){
           //    exports.abc = function(){}
        //});
        define(['exports'], factory);
    } else {
        // [3] No module loader (plain <script> tag) - put directly in global namespace
        factory(window['ko'] = {});
    }
}(function(koExports){

    //ko的全局定義 koExports是undefined 對應着上面的[3] 這種情況
    var ko = typeof koExports !== 'undefined' ? koExports : {};

    //定義一個ko的方法
    ko.abc = function(s){
        alert(s);
    }
});

//[3]中情況的調用
ko.abc("msg");


兼容CommonJS和CMD(SeaJS)規范的。例子:

;(function(factory) {

// CommonJS/NodeJS
if(typeof require === 'function' && typeof exports === "object" && typeof module === "object") {
factory(require, exports, module);
}
// CMD/SeaJS
else if(typeof define === "function") {
define(factory);
}
// No module loader
else {
factory(function(){}, window['idcard']={}, {});
}

}(function(require, exports, module) {

 

// something...

 

exports.hello = function() {
return 'hello212';
}


}));

 

 

AMD、CMD、UMD 模塊的寫法

 

簡介

最近幾年,我們可以選擇的Javascript組件的生態系統一直在穩步增長。雖然陡增的選擇范圍是極好的,但當組件混合匹配使用時就會出現很尷尬的局面。開發新手們會很快發現不是所有組件都能彼此“和平相處”。

為了解決這個問題,兩種競爭關系的模塊規范AMD和CommonJS問世了,它們允許開發者遵照一種約定的沙箱化和模塊化的方式來寫代碼,這樣就能避免“污染生態系統”。

AMD

隨着RequireJS成為最流行的實現方式,異步模塊規范(AMD)在前端界已經被廣泛認同。

下面是只依賴jquery的模塊foo的代碼:

還有稍微復雜點的例子,下面的代碼依賴了多個組件並且暴露多個方法:

定義的第一個部分是一個依賴數組,第二個部分是回調函數,只有當依賴的組件可用時(像RequireJS這樣的腳本加載器會負責這一部分,包括找到文件路徑)回調函數才被執行。

注意,依賴組件和變量的順序是一一對應的(例如,jquery->$, underscore->_)。

同時注意,我們可以用任意的變量名來表示依賴組件。假如我們把$改成$$,在函數體里面的所有對jQuery的引用都由$變成了$$。

還要注意,最重要的是你不能在回調函數外面引用變量$和_,因為它相對其它代碼是獨立的。這正是模塊化的目的所在!

CommonJS

如果你用Node寫過東西的話,你可能會熟悉CommonJS的風格(node使用的格式與之相差無幾)。因為有Browserify,它也一直被前端界廣泛認同。

就像前面的格式一樣,下面是用CommonJS規范實現的foo模塊的寫法:

還有更復雜的例子,下面的代碼依賴了多個組件並且暴露多個方法:

 

UMD: 通用模塊規范

既然CommonJs和AMD風格一樣流行,似乎缺少一個統一的規范。所以人們產生了這樣的需求,希望有支持兩種風格的“通用”模式,於是通用模塊規范(UMD)誕生了。

不得不承認,這個模式略難看,但是它兼容了AMD和CommonJS,同時還支持老式的“全局”變量規范:


保持跟上面例子一樣的模式,下面是更復雜的例子,它依賴了多個組件並且暴露多個方法:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM