插件兼容CommonJS, AMD, CMD 和 原生 JS
2017-02-13 14:59
204 查看
模块标准
CommonJS
CommonJS有三个全局变量
module、
exports和
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)规范的。例子:
[/code]
;(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的代码:
JavaScript
// 文件名: foo.js
define(['jquery'], function ($) {
// 方法
function myFunc(){};
// 暴露公共方法
return myFunc;
});
还有稍微复杂点的例子,下面的代码依赖了多个组件并且暴露多个方法:
JavaScript
// 文件名: foo.js
define(['jquery', 'underscore'], function ($, _) {
// 方法
function a(){}; //
私有方法,因为没有被返回(见下面)
function b(){}; //
公共方法,因为被返回了
function c(){}; //
公共方法,因为被返回了
// 暴露公共方法
return {
b: b,
c: c
}
});
定义的第一个部分是一个依赖数组,第二个部分是回调函数,只有当依赖的组件可用时(像RequireJS这样的脚本加载器会负责这一部分,包括找到文件路径)回调函数才被执行。
注意,依赖组件和变量的顺序是一一对应的(例如,jquery->$, underscore->_)。
同时注意,我们可以用任意的变量名来表示依赖组件。假如我们把$改成$$,在函数体里面的所有对jQuery的引用都由$变成了$$。
还要注意,最重要的是你不能在回调函数外面引用变量$和_,因为它相对其它代码是独立的。这正是模块化的目的所在!
CommonJS
如果你用Node写过东西的话,你可能会熟悉CommonJS的风格(node使用的格式与之相差无几)。因为有Browserify,它也一直被前端界广泛认同。就像前面的格式一样,下面是用CommonJS规范实现的foo模块的写法:
JavaScript
// 文件名: foo.js
// 依赖
var $ = require('jquery');
// 方法
function myFunc(){};
// 暴露公共方法(一个)
module.exports = myFunc;
还有更复杂的例子,下面的代码依赖了多个组件并且暴露多个方法:
JavaScript
// 文件名: foo.js
var $ = require('jquery');
var _ = require('underscore');
// methods
function a(){}; // 私有方法,因为它没在module.exports中
(见下面)
function b(){}; // 公共方法,因为它在module.exports中定义了
function c(){}; // 公共方法,因为它在module.exports中定义了
// 暴露公共方法
module.exports = {
b: b,
c: c
};
UMD: 通用模块规范
既然CommonJs和AMD风格一样流行,似乎缺少一个统一的规范。所以人们产生了这样的需求,希望有支持两种风格的“通用”模式,于是通用模块规范(UMD)诞生了。不得不承认,这个模式略难看,但是它兼容了AMD和CommonJS,同时还支持老式的“全局”变量规范:
JavaScript
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD
define(['jquery'], factory);
} else if (typeof exports === 'object') {
// Node, CommonJS之类的
module.exports = factory(require('jquery'));
} else {
// 浏览器全局变量(root 即 window)
root.returnExports = factory(root.jQuery);
}
}(this, function ($) {
// 方法
function myFunc(){};
// 暴露公共方法
return myFunc;
}));
保持跟上面例子一样的模式,下面是更复杂的例子,它依赖了多个组件并且暴露多个方法:
JavaScript
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD
define(['jquery', 'underscore'], factory);
} else if (typeof exports === 'object') {
// Node, CommonJS之类的
module.exports = factory(require('jquery'), require('underscore'));
} else {
// 浏览器全局变量(root 即 window)
root.returnExports = factory(root.jQuery, root._);
}
}(this, function ($, _) {
// 方法
function a(){}; // 私有方法,因为它没被返回
(见下面)
function b(){}; // 公共方法,因为被返回了
function c(){}; // 公共方法,因为被返回了
// 暴露公共方法
return {
b: b,
c: c
}
}));
转载自:http://www.cnblogs.com/zzsdream/p/5158968.html
相关文章推荐
- 插件兼容CommonJS, AMD, CMD 和 原生 JS
- [转] 插件兼容CommonJS, AMD, CMD 和 原生 JS
- 兼容CommonJS规范,AMD规范,CMD规范的JS写法
- [js模块规范]总结JS模块规范CommonJS,AMD,CMD区别
- js模块化编程之彻底弄懂CommonJS和AMD/CMD!
- 再谈 JS中的模块规范(CommonJS,AMD,CMD)来自玉伯的seajs分析
- js模块化编程之CommonJS和AMD/CMD
- 理解JS中的模块规范(CommonJS,AMD,CMD)
- JS中的模块规范(CommonJS,AMD,CMD)
- 再谈 JS中的模块规范(CommonJS,AMD,CMD)来自玉伯的seajs分析
- js模块化编程之彻底弄懂CommonJS和AMD/CMD!
- 浅析JS模块规范:AMD,CMD,CommonJS
- js模块化编程之彻底弄懂CommonJS和AMD/CMD
- 让你的javascript支持AMD,CMD和原生JS
- 浅析JS中的模块规范(CommonJS,AMD,CMD)
- 浅析JS中的模块规范(CommonJS,AMD,CMD)
- js模块化编程之彻底弄懂CommonJS和AMD/CMD
- 原生js写的一个弧形菜单插件
- 原生JS绑定滑轮滚动事件,兼容浏览器
- AMD and CMD are dead之KMDjs内核之分号