《NodeJS开发教程4-模块机制》

谈到NodeJS的模块机制,这还得从JavaScript这门语言说起。JavaScript语言可谓是编程中比较资深的一种语言了。从上个世纪(对就是上个世纪)就开始流行了,起初只是作为一些静态网页的简单控制脚本和特效脚本而存在,而且书写规范也没有标准的官方定义,<script>标签引入JavaScript代码,零零散散的整个网站应用到处都是它的踪迹,这种书写方式对于一些小型的简单web应用还能够胜任,但是随着技术的发展,出现了像jquery,easyui等这样的封装库,大大提升了开发效率,但是毕竟还是一些封装库,对于后期出现的前端工程化应用却只能作为工程支持库的冰山一角,这时候Javascript模块机制就应运而生了。首先要讲的就是CommonJS规范,它是一种标准,也是NodeJS常用的一种模块书写规范。

模块是Node.js 应用程序的基本组成部分,文件和模块是一一对应的。换言之,一个 Node.js 文件就是一个模块,这个文件可能是JavaScript 代码、JSON 或者编译过的C/C++ 扩展。

CommonJS模块规范

CommonJS规范的提出主要是为了弥补JavaScript没有标准的缺陷,以达到像Java,C#,Python等具备开发大型应用的基础能力。我们可以像Java那样一个文件定义一个类(模块),工程里进行相互引用。有了这项能力,我们就可以用NodeJS开发以下应用:

  • 命令行工具
  • 服务器端JavaScript应用程序
  • 桌面图形应用程序(后面会专门去讲NodeJS图形应用开发)
    CommonJS规范规范主要包括:1.模块引用 2.模块定义3.模块标识三个部分。
    1.模块引用
    模块通过require()进行引用,示例:
var http=require("http");//引入http模块

2.模块定义
上面我们引入的是官方定义的http模块,当然我们也可以引入我们自定义的模块,首先我们需要通过exports定义,如下:
新建 lession_exports.js 代码如下:

/*模块接口方法定义(导出)*/
exports.add=function(a,b)
{
    return a+b;
};

接着新建 lession_require.js 进行引入我们刚刚自定义的模块(模块中含有一个add方法)

/*模块机制*/
var modules_define=require("./lession_exports");//require("./lession_exports.js")这样引入也可以
var result=modules_define.add(15,16);
console.log("调用模块add方法,结果:"+result);
------------------------
运行输出结果:
   调用模块add方法,结果:31

刚刚我们定义并导出了一个方法,那可能你会问了:我想导出一个类(或对象)该怎么办?接下来我们就来讲一下怎么导出一个对象的方法。
新建 lession_modules_exports.js 代码如下:

/*模块接口方法定义(导出)*/
//定义一个类
function People(name)
{
    this.name=name;
    this.sleep=function()
    {
        console.log(this.name+" 睡觉了");
    };
    this.speak=function()
    {
        console.log(this.name+" 说话了");
    };
}

module.exports=People;//导出

在我们前面创建的 lession_require.js 文件中添加代码:

var People=require("./lession_modules_exports.js");//引入定义的类
var people=new People("Codingyu");//实例化一个类对象people
people.sleep();//调用people实例对象的sleep方法
people.speak();//调用people实例对象的speak方法

---------------------
执行__ node lession_require.js __,输出结果如下:
  Codingyu 睡觉了
  Codingyu 说话了

以上是NodeJS模块机制CommonJS规范的基本使用。接下来我们再谈一下AMD规范和CMD规范以及怎么编写前后端兼容的模块。

AMD模块规范

之前我们讲NodeJS前后端通吃,既可以做前端又可以做后端服务器,那这样我们在开发中就可以前后端有些模块功能共享代码,加快开发进度。但是如果前后端都使用CommonJS规范,会有一个问题,CommonJS规范require加载模块是同步的,在服务器端调用直接读取磁盘是瞬间的极快的,对于加载速度没有任何影响,但是对于前端来说,由于前端是通过网络加载的,所以会产生require速度问题。AMD模块规范对于模块的引入是异步的,所以比较适合前端的模块管理。接下来我们就来举个栗子,但是在举栗子之前我们需要先简单掌握一下node里的一个很强大的包管理功能----NPM(我在这一章节会仔细去讲解npm包管理https://www.jianshu.com/p/445d0168d691

在NodeJS中使用AMD模块规范和后面要讲的CMD模块规范,需要使用npm去下载 ‘amdefine’:

npm install amdefine

amdefine安装完毕后,接下来我们
新建 lession_exports_amd.js 代码如下:

/*AMD模块定义导出*/
//首先需要在文件中引入amdefine模块
if (typeof define !== 'function') {
    var define = require('amdefine')(module);
}
//定义自己的模块
define(function()
{
    var exports={};
    exports.add=function(a,b)
    {
        return a+b;
    };
    return exports;//导出对象
});

接着新建 lession_require_amd.js 去测试一下,代码如下:

/*AMD模块机制*/
//首先需要在文件中引入amdefine模块
if (typeof define !== 'function') {
    var define = require('amdefine')(module);
}
//定义自己的模块
//方法原型:define(["dep1","dep2"],function(dep1,dep2){});
define(["./lession_exports_amd"],function(exportAMD)
{
    var result=exportAMD.add(15,16);//调用另一个使用AMD规范定义的模块接口方法
    console.log("通过AMD规范调用接口add方法结果:"+result);
    return {};
});

OK!我们可以运行一下lession_require_amd.js,测试一下AMD模块规范的使用,结果输出:

通过AMD规范调用接口add方法结果:31

CMD模块规范

CMD模块规范其实是建立在AMD规范之上的,是由国内的玉伯提出,与AMD规范主要区别在于定义模块和依赖引入的部分:

define(function(require,exports,module)
{
   ......
});

require,exports,module通过形参的方式传递给模块,在需要依赖引入时,随时调用require("xxx"),和CommonJS很像。
再举个栗子,新建 lession_exports_cmd.js ,代码如下:

/*CMD模块定义导出*/
//首先需要在文件中引入amdefine模块
if (typeof define !== 'function') {
    var define = require('amdefine')(module);
}
//定义自己的模块
define(function(require,exports,module)
{
    var my={};
    my.add=function(a,b)
    {
        return a+b;
    };
    module.exports=my;
});

接着新建 lession_require_cmd.js 去测试一下CMD规范,代码如下:

/*CMD模块机制*/
//首先需要在文件中引入amdefine模块
if (typeof define !== 'function') {
    var define = require('amdefine')(module);
}
//定义自己的模块
define(function(require,exports,module)
{
    var my=require("./lession_exports_cmd");
    var result=my.add(15,16);//调用另一个使用CMD规范定义的模块接口方法
    console.log("通过CMD规范调用接口add方法结果:"+result);
});

执行lession_require_cmd.js,结果输出:

通过CMD规范调用接口add方法结果:31

AMD、CMD、CommonJS不同的规范,前端说:我们使用AMD/CMD,后端说:我们使用CommonJS,刚刚我们讲,有一些前后端通用的模块代码,那我们能做到前后端模块规范兼容统一吗?答案是肯定的,举个栗子
新建 lession_exports_compat.js 代码如下:

/*兼容模式模块定义导出*/
//定义自己的模块
(function(name,definition)
{
    var hasDefine=typeof define==="function";//是否有define的定义
    var hasExports=typeof module!=="undefined"&&module.exports;//是否有module和exports的定义
    if(hasDefine)
    {
        //AMD或者CMD环境
        define(definition);
    }else if(hasExports)
    {
        //CommonJS规范(普通node模块)
        module.exports=definition();
    }else{
        //普通window环境将模块直接挂载到window对象上
        this[name]=definition();
    }
})('my',function () {
    //真正定义模块内容的地方
    var my={};
    my.add=function(a,b)
    {
        return a+b;
    };
    return my;
});

接下来再创建测试文件 lession_require_compat.js,代码如下:

/*兼容模式模块定义导出*/
//首先需要在文件中引入amdefine模块----兼容模式测试可以不引入直接使用CommonJS规范
// if (typeof define !== 'function') {
//     var define = require('amdefine')(module);
// }
//定义自己的模块
(function(name,definition)
{
    var hasDefine=typeof define==="function";//是否有define的定义
    var hasExports=typeof module!=="undefined"&&module.exports;//是否有module和exports的定义
    if(hasDefine)
    {
        //AMD或者CMD环境
        define(definition);
    }else if(hasExports)
    {
        //CommonJS规范(普通node模块)
        module.exports=definition();
    }else{
        //普通window环境将模块直接挂载到window对象上
        this[name]=definition();
    }
})('myrequire',function () {
    //正在引入模块使用的地方
    var my=require("./lession_exports_compat");
    var result=my.add(15,16);
    console.log(result);
    return {};
});

很简单吧!大体结构就是一个自执行函数,上面我代码里注掉的地方,打开它便会产生AMD/CMD环境,注释它则会默认产生CommonJS环境,这样定义的模块我们前后端就可以随意copy过来使用了(当然还有一些前后端不同API环境的影响)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容

  • 前言 js是从网页小脚本演变过来的,至今,前端的js库,也不像一个真正的模块。前端js经历了工具类库、组件库、前端...
    白昔月阅读 3,274评论 2 11
  • 1 Node.js模块的实现 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都着...
    zlx_2017阅读 1,232评论 0 1
  • 1 Node.js模块的实现# 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都...
    七寸知架构阅读 2,054评论 1 50
  • 模块通常是指编程语言所提供的代码组织机制,利用此机制可将程序拆解为独立且通用的代码单元。所谓模块化主要是解决代码分...
    MapleLeafFall阅读 1,166评论 0 0
  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,610评论 2 41