【原创】node模块机制

1、模块化的意义

随着程序代码越写越多,在一个文件里代码就会越来越长,越来越不容易维护。为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在Node环境中,一个.js文件就称之为一个模块(module)。

(1)提高了代码的可维护性

(2)提高代码的可重用性,编写代码不必从零开始,可以引入第三方模块

(3)避免函数名和变量名冲突,相同名字的函数和变量完全可以分别存在不同的模块中

2、CommonJS的模块规范

(1)CommonJS概念

CommonJS就是为JS的表现来制定规范,因为js没有模块的功能所以CommonJS应运而生,它希望js可以在任何地方运行,不只是浏览器中,而且可以编写服务器端JavaScript应用程序、命令行工具、桌面图形界面应用程序等。

Node与浏览器以及W3C组织、CommonJS组织、ECMAScript之间的关系如下图:

关系图

CommonJS定义的模块分为:{模块引用(require)} {模块定义(exports)} {模块标识(module)}

require()用来引入外部模块;exports对象用于导出当前模块的方法或变量,唯一的导出口;module对象就代表模块本身。

(2)模块引用(require)、模块定义(exports)、模块标识(module)

在greet.js中创建一个函数greet函数,使用module.exports把greet函数作为模块的暴露出去:

greet.js

在hello.js中引用greet函数


hello.js

(a)模块引入方式一:

模块引入方式二

(b)模块引入方式二:Node会依次在内置模块、全局模块和当前模块下查找greet.js

模块引入方式二

模块引入方式一,模块在文件系统使用相对路径引用,对于组织程序特定代码有帮助,但是不利于程序之间以及和他人共享代码。Node的模块引入机制(模块引入方式二)可以不必知道模块在文件系统具体位置。这个机制使用node_module目录。

模块引入方式二机制图

3、Node的模块实现

(1)模块加载

在Node中引入模块步骤:a.路径分析;b.文件定位;c.编译执行

Node中,模块分为两类:一类是Node提供的称为核心模块,另一类称用户编写的称为文件模块。

两类模块加载方式:

a、核心模块部分在Node源代码编译过程中,编译进了二进制执行文件。在Node进程启动时,部分核心模块被直接加载进内存中,所以这部分核心模块引入时,文件定位和编译执行两个步骤可以省略掉,并且在路径分析中优先判断,所以他的加载速度最快。

b、文件模块在运行时加载,需要完整的路径分析、文件定位、编译执行过程,速度比核心模块慢。

(2)优先从缓存中加载

Node能把模块作为对象缓存起来。如果程序中南的两个文件引入了相同的模块,第一个require会把模块返回的数据存到内存中,这样第二个require就不用再去访问和计算模块的源文件了。即:在同一个进程中用require加载一个模块得到的是相同的对象。不论是核心模块还是文件模块,require方法对相同模块的二次加载都一律采用缓存优先的方式。不同之处在于核心模块的缓存检查先于文件模块的缓存检查。

4、包与NPM

(1)包和NPM的意义

Node组织了自身的核心模块,也使第三方文件模块可以有序编写和使用,npm和包将模块联系在一起,相互之间直接引用。

包组织模块的示意图

(2)包结构

包实际是存档文件,完全符合commonjs规范的包目录:

a、package.json:包描述文件。

b、bin:存放可执行二进制文件

c、lib:存放JavaScript代码

d、doc:存放文档

e、test:存放单元测试用例代码

(3)NPM

CommonJS包规范是理论,NPM是其中一种实践。NPM帮助完成第三方模块的发布、安装和依赖等。

a、npm钩子命令

package.json中scripts字段在包安装卸载过程中提供钩子机制,示例如下:

scripts示例

b、发布包

我们可以使用node.js模块,同时也可以编写发布好的node.js模块供其他开发者使用。

第一步:到https://www.npmjs.com/signup注册账号;

第二步:到项目运行命令 npm adduser,输入第一步注册的用户信息;

第三步:执行npm publish

发布成功之后会返回项目名称@版本信息,并且能到NPM官网搜索到该模块。

参考文档:

《Node.js实战(第2版)》[英] 亚历克斯•杨 等 (作者) 吴海星 (译者)

http://www.commonjs.org/

https://www.liaoxuefeng.com/wiki/001434446689867b27157e896e74d51a89c25cc8b43bdb3000

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