【原创】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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容