Node.js中的模块机制学习笔记


Posted in Javascript onNovember 04, 2014

Javascript自诞生以来,曾经没有人拿它当做一门编程语言。在Web 1.0时代,这种脚本语言主要被用来做表单验证和网页特效。直到Web 2.0时代,前端工程师利用它大大提升了网页上的用户体验,JS才被广泛重视起来。在JS逐渐流行的过程中,它大致经历了工具类库、组件库、前端框架、前端应用的变迁。Javascript先天就缺乏一项功能:模块,而CommonJS规范的出现则弥补了这一缺陷。本文将介绍CommonJS规范及Node的模块机制。

在其他高级语言中,Java有类文件,Python有import机制,PHP有include和require。而JS通过<script>标签引入代码的方式显得杂乱无章。过去人们不得不用命名空间等方式来人为地约束代码,直到CommonJS规范的出现,前后端的Javascript才得以实现大一统。Node借鉴了CommonJS的Modules规范实现了一套非常易用的模块系统。

1. CommonJS模块规范

CommonJS的模块规范分为3个部分:

1).模块引用:通过require()方法并传入一个模块标识来引入一个模块的API到当前上下文中,如var math = require('math');
2).模块定义:通过exports对象来导出当前模块的方法或变量。模块中还存在一个module对象,exports实际上是module的属性。在Node中,一个文件就是一个模块,模块内的“全局变量”对外都不可见,只有挂载在exports上的属性才是公开的,如exports.add = function() {}; exports.PI = 3.1415926;
3).模块标识:实际上就是传递给require()的参数,如上述的'math',它必须是符合camel命名法的字符串,或者是以“.”“..”开头的相对路径或绝对路径,它可以没有文件名后缀“.js”

2. Node模块实现过程

在Node中,模块分为两类:一类是Node本身提供的核心模块,另一类是用户自己编写的文件模块。核心模块有一部分在Node源代码的编译过程中,编译成了二进制文件,在Node启动时核心模块就被直接加载进内存中,所以它的加载速度是最快的。文件模块则是在运行时动态加载,需要经历三个步骤:路径分析,文件定位,编译执行。注意,Node对引入过的模块都会进行缓存,以减少二次引入时的开销,并对相同模块的二次加载都采用最优先从缓存加载的策略。

2.1 路径分析

路径分析主要分析上述提到的模块标识符,主要分为以下几类:

1)、核心模块,如http、fs、path等
2)、.或..开始的相对路径文件模块
3)、以/开始的绝对路径文件模块
4)、自定义文件模块,可能是一个文件或包的形式。Node会根据模块路径数组module.paths来逐个尝试查找目标文件,通常是沿着当前目录逐级向上直到根目录查找名为node_modules的目录,所以这是查找最费时的一种方式。

2.2 文件定位

在路径分析的基础上,文件定位需要注意如下细节:

1)、文件扩展名分析:由于CommonJS规范允许模块标识不填写扩展名,Node会按.js、.json、.node的次序不足扩展名,依次尝试
2)、目录分析和包:若通过上述文件扩展名分析后没有查找到对应文件,却得到一个目录,Node会把目录当做一个包来处理

2.3 编译执行

定位到具体文件后,Node会新建一个模块对象,根据路径载入并编译。对于不同的扩展名,载入方法有所不同:

1)、.js文件:通过fs模块同步读取文件并编译执行
2)、.node文件:这是用C/C++编写的扩展文件,通过dlopen()方法加载
3)、.json文件:通过fs模块同步读取文件,用JSON.parse()解析返回结果
4)、其余扩展名文件:都被当做.js文件载入

我们知道每个模块文件中默认都存在着require、exports、module这3个变量,甚至在Node的API文档中,我们知道每个模块还有filename、dirname这2个变量的存在,它们是从何而来的呢?Node的模块又是怎么做到声明的“全局变量”实际上是不会污染到其他模块的?事实上,Node在编译JS模块过程中会对文件内容进行头尾包装。下面是一个JS文件经过头尾包装的例子:

(function(exports, require, module, __filename, __dirname) {

    /* 中间是JS文件的实际内容 */

    var math = require('math');

    exports.area = function(radius) {

        return Math.PI * radius * radius;

    };

    /* JS文件的实际内容结束 */

});

这样每个模块文件之间都进行了作用域隔离,同时require、exports、module等变量也被注入到了模块的上下文当中。这就是Node对CommonJS模块规范的实现。关于C/C++模块及Node核心模块的编译过程较为复杂,不再赘述。

3. 模块调用栈

有必要明确一下Node中各种模块的调用关系,如下图所示:

Node.js中的模块机制学习笔记

C/C++内建模块是最底层的模块,属于核心模块,主要提供API给Javascript核心模块和第三方Javascript文件模块调用,实际中几乎不会接触到此类模块。Javascript核心模块主要职责有两种:一种是作为C/C++内建模块的封装层和桥接层供文件模块调用,另一种是纯粹的功能模块,不需要跟底层打交道。文件模块通常由第三方编写,包括普通Javascript模块和C/C++扩展模块。

4. 包与NPM

4.1 包结构

包本质上是一个存档文件(一般为.zip或.tar.gz),安装后解压还原为目录。CommonJS的包规范由包结构和包描述文件两部分组成。一个完全符合CommonJS规范的包结构应包含以下文件:

1).package.json:包描述文件
2).bin:存放可执行二进制文件的目录
3).lib:存放Javascript代码的目录
4).doc:存放文档的目录
5).test:存放单元测试用例的目录

4.2 包描述文件

包描述文件是一个JSON文件——package.json,位于包的根目录下,是包的重要组成部分,用于描述包的概况信息。后面要提到的NPM的所有行为都与这个文件的字段息息相关。下面将以知名Web框架express项目的package.json文件为例说明一些常用字段的含义。

1).name:包名
2).description:包简介
3).version:版本号,需遵照“语义化的版本控制”,参照http://semver.org/
4).dependencies:使用当前包所需要依赖的包列表。这个属性十分重要,NPM会通过这个属性自动加载依赖的包
5).repositories:托管源代码的位置列表

其余字段的用法可以参照NPM package.json说明

4.3 NPM常用功能

NPM(node package manager),通常称为node包管理器。它的主要功能就是管理node包,包括:安装、卸载、更新、查看、搜索、发布等。

4.3.1 NPM包安装

Node包的安装分两种:本地安装、全局安装。两者的区别如下:

1).本地安装npm install <package-name>:package会被下载到当前所在目录,也只能在当前目录下使用。
2).全局安装npm install -g <package-name>:package会被下载到到特定的系统目录下,安装的package能够在所有目录下使用。

4.3.2 NPM包管理

下面以grunt-cli(grunt命令行工具)为例,列出常用的包管理命令:

1).npm install:安装package.json文件的dependencies和devDependencies字段声明的所有包
2).npm install grunt-cli@0.1.9:安装特定版本的grunt-cli
3).npm install grunt-contrib-copy --save:安装grunt-contrib-copy,同时保存该依赖到package.json文件
4).npm uninstall grunt-cli:卸载包
5).npm list:查看安装了哪些包
6).npm publish <folder>:发布包

Javascript 相关文章推荐
js/jQuery对象互转(快速操作dom元素)
Feb 04 Javascript
jquery插件开发之实现google+圈子选择功能
Mar 10 Javascript
jquery ajax 如何向jsp提交表单数据
Aug 23 Javascript
ES6中如何使用Set和WeakSet
Mar 10 Javascript
使用js获取地址栏参数的方法推荐(超级简单)
Jun 14 Javascript
js实现选项卡内容切换以及折叠和展开效果【推荐】
Jan 08 Javascript
Javascript基础回顾之(三) js面向对象
Jan 31 Javascript
vue给组件传递不同的值方法
Sep 29 Javascript
微信运维交互机器人的示例代码
Nov 12 Javascript
详解微信小程序中var、let、const用法与区别
Jan 11 Javascript
详解JavaScript中精度失准问题及解决方法
Feb 04 Javascript
vue实现移动端H5数字键盘组件使用详解
Aug 25 Javascript
Node.js异步I/O学习笔记
Nov 04 #Javascript
JavaScript中的ubound函数使用实例
Nov 04 #Javascript
JavaScript实现检查页面上的广告是否被AdBlock屏蔽了的方法
Nov 03 #Javascript
网页中表单按回车就自动提交的问题的解决方案
Nov 03 #Javascript
详解jquery中$.ajax方法提交表单
Nov 03 #Javascript
jquery处理json对象
Nov 03 #Javascript
js格式化时间小结
Nov 03 #Javascript
You might like
浅谈web上存漏洞及原理分析、防范方法(安全文件上存方法)
2013/06/29 PHP
ThinkPHP的cookie和session冲突造成Cookie不能使用的解决方法
2014/07/01 PHP
php 使用expat方式解析xml文件操作示例
2019/11/26 PHP
用js遍历 table的脚本
2008/07/23 Javascript
正则表达式判断是否存在中文和全角字符和判断包含中文字符串长度
2008/09/27 Javascript
jQuery切换网页皮肤并保存到Cookie示例代码
2014/06/16 Javascript
JavaScript学习笔记之定时器
2015/01/22 Javascript
jquery ztree实现模糊搜索功能
2016/02/25 Javascript
详解Nodejs之静态资源处理
2017/06/05 NodeJs
基于wordpress的ajax写法详解
2018/01/02 Javascript
webpack打包js的方法
2018/03/12 Javascript
p5.js入门教程和基本形状绘制
2018/03/15 Javascript
WebSocket的通信过程与实现方法详解
2018/04/29 Javascript
Vue使用CDN引用项目组件,减少项目体积的步骤
2020/10/30 Javascript
了不起的11个JavaScript代码重构最佳实践小结
2021/01/11 Javascript
[01:14]3.19DOTA2发布会 三代刀塔人第二代
2014/03/25 DOTA
详解Python多线程Selenium跨浏览器测试
2017/04/01 Python
详解Python 序列化Serialize 和 反序列化Deserialize
2017/08/20 Python
Django中使用celery完成异步任务的示例代码
2018/01/23 Python
python用for循环求和的方法总结
2019/07/08 Python
Python 占位符的使用方法详解
2019/07/10 Python
pycharm安装及如何导入numpy
2020/04/03 Python
python 利用zmail库发送邮件
2020/09/11 Python
详解python程序中的多任务
2020/09/16 Python
OpenCV利用python来实现图像的直方图均衡化
2020/10/21 Python
CSS3实现红包抖动效果
2020/12/23 HTML / CSS
HTML5开发动态音频图的实现
2020/07/02 HTML / CSS
几道数据库的概念性面试题
2014/05/30 面试题
给排水专业应届生求职信
2013/10/12 职场文书
平面设计岗位职责
2013/12/14 职场文书
大学毕业自我评价
2014/02/02 职场文书
校园学雷锋活动月总结
2014/03/09 职场文书
2014年社区妇联工作总结
2014/12/02 职场文书
小学生暑假安全保证书
2015/07/13 职场文书
2019事业单位个人工作总结范文
2019/08/26 职场文书
初中生入团申请书范文(五篇)
2019/10/16 职场文书