浅析node.js的模块加载机制


Posted in Javascript onMay 25, 2018

在node.js中,模块使用CommonJS规范,一个文件是一个模块

node.js中的模块可分为三类

  1. 内部模块 - node.js提供的模块如 fs,http,path等
  2. 自定模块 - 我们自己写的模块
  3. 第三方模块 - 通过npm安装的模块

node.js提供了大量的模块供我们使用,比如 想解析一个文件的路径,可以使用path模块下的相应方法实现:

const path = require('path');
//返回目标文件的绝对路径
console.log(path.resolve('./1.txt'));

运行结果:

/Users/cuiyue/workspace/test/1.txt

使用require引入相应的模块,即可使用。

__dirname和__filename

node.js的每个模块都有这两个参数,它们都是一个绝对路径的地址,区别是__filename存放了从根目录到当前文件名的路径,__dirname只存放从根目录到模块的所在目录:

console.log(__dirname);
console.log(__filename);

运行结果:

/Users/cuiyue/workspace/test
/Users/cuiyue/workspace/test/module.js

vm模块

vm模块是node.js提供在V8虚拟机中编译和运行的工具,node.js中的模块内部实现就是通过此模块完成。

说说vm的基本用法。

在js环境中有一个eval函数,它可以运行js的代码字符串,比如:

eval('console.log("Hello javascript.")'); //输出Hello javascript.

可以看到,eval函数的参数是一段字符串,它可以运行字符串形式的js代码,但它可以使用上下文环境中的变量:

var num=100;
eval('console.log(num)'); //输出100

以上是可以正确访问num的值。

vm模块提供了方法创建一个安全的沙箱,在指定的上下文环境中运行代码,不受外界干扰。

const vm = require('vm');
var num = 100;
vm.runInThisContext('console.log(num)');

运行结果:

console.log(num)
            ^
ReferenceError: num is not defined

可以看到代码报错了,说明在vm创建了指定的上下文环境中,拿不到外界的参量。

CommonJS规范

在以前,由于javascript的历史原因导致它的模块机制很差,由于这些缺点使得javascript不太善于开发大型应用,于是提出了CommonJS规范以弥补javascript的不足。

CommonJS规范主要分为三块内容:模块导入导出、模块定义、模块标识。

模块导入导出

CommonJS中使用require()函数进行模块的引入。

const mymodule = require('mymodule');

使用exports导出模块

module.exports = {
  name: 'Tom'
};

引用的名称可以不带路径,若不带路径表示引入的是node提供的模块或是npm安装的第三方模块(node_modules)

模块定义

module对象:在每一个模块中,module对象代表该模块自身。

export属性:module对象的一个属性,它向外提供接口。

模块标识

模块标识指的是传递给require方法的参数,必须是符合小驼峰命名的字符串,或者以 .、..、开头的相对路径,或者绝对路径。

node中模块解析流程

  1. 首先接收参数,把传入的模块名称解析成绝对路径
  2. 若没有后缀名称,依次拼接.js .json .node尝试加载,仍到不到模块则报错
  3. 取得正确的路径后判断缓存中是否存在此模块,若有则取出
  4. 若缓存中不存在则加载此文件,在外包裹一层闭包并执行它

以上为大致流程,下面尝试着写一下模块。

代码的基本结构:

/**
 * Module类,用于处理模块加载
 */
function Module() {}

//模块的缓存
Module._cacheModule = {};

//不同扩展名的加载策略
Module._extensions = {};

//根据moduleId解析绝对路径,
Module._resolveFileName = function(moduleId) {};

//入口函数
function req(moduleId) {}

附上全部代码:

const path = require('path');
const fs = require('fs');
const vm = require('vm');

/**
 * Module类,用于处理模块加载
 */
function Module(file) {
 this.id = file; //当前模块的id,它使用完整的绝对路径标识,因此是唯一的
 this.exports = {}; //导出
 this.loaded = false; //模块是否已加载完毕
}

//模块的缓存
Module._cacheModule = {};

Module._wrapper = ['(function(exports,require,module,__dirname,__filename){', '});'];

//不同扩展名的加载策略
Module._extensions = {
 '.js': function(currentModule) {
  let js = fs.readFileSync(currentModule.id, 'utf8'); //读取出js文件内容
  let fn = Module._wrapper[0] + js + Module._wrapper[1];
  vm.runInThisContext(fn).call(
   currentModule.exports,
   currentModule.exports,
   req,
   currentModule,
   path.dirname(currentModule.id),
   currentModule.id);
  return currentModule.exports;
 },
 '.json': function(currentModule) {
  let json = fs.readFileSync(currentModule.id, 'utf8');
  return JSON.parse(json); //转换为JSON对象返回
 },
 '.node': ''
};

//加载模块(实例方法)
Module.prototype.load = function(file) {
 let extname = path.extname(file); //获取后缀名
 return Module._extensions[extname](this);
};

//根据moduleId解析绝对路径,
Module._resolveFileName = function(moduleId) {
 let p = path.resolve(moduleId);

 if (!path.extname(moduleId)) { //传入的模块没有后缀
  let arr = Object.keys(Module._extensions);

  //循环读取不同扩展名的文件
  for (var i = 0; i < arr.length; i++) {
   let file = p + arr[i]; //拼接上后缀名成为一个完整的路径
   try {
    fs.accessSync(file);
    return file; //若此文件存在返回它
   } catch (e) {
    console.log(e);
   }
  }
 } else {
  return p;
 }
};

function req(moduleId) {
 let file = Module._resolveFileName(moduleId);

 if (Module._cacheModule[file]) { //若缓存中存在此模块
  return Module._cacheModule[file];
 } else {
  let module = new Module(file);
  module.exports = module.load(file);
  return module.exports;
 }
}

console.log(req('./a.js')());

a.js的文件内容:

module.exports = function() {
 console.log('This message from a.js');
 console.log(__dirname);
 console.log(__filename);
}

最终运行结果:

This message from a.js
/Users/cuiyue/workspace/test
/Users/cuiyue/workspace/test/a.js

重要代码说明

_resolveFileName

_resolveFileName方法的主要作用是把传入的模块解析成绝对路径,这样才可以进行下一步,根据完整的路径加载模块。

因此要进行判断,如果传入的模块不存在,则要报错;如果传入的模块已经有扩展名了,就不要拼接了;若没有扩展名,依次以.js .json .node的顺序拼接成完成的模块进行加载。

_extensions

此对象中封装了加载不同类型模块的处理方法,其中若是.json类型则使用fs读取文件直接转换成JSON对象并返回。

若是.js文件则读取后,拼接闭包,将exports,require,module,__dirname,__filename五大参数拼接好,使用vm模块的沙箱机制运行,得到的结果放入module.exports返回。

总结

以上就是node.js的模块加载的简单逻辑,实际上node.js的源码远远比上面的代码复杂,光是处理模块路径、判断合法等操作就写了N行。而且我这里没有写缓存以及其它的复杂逻辑,但核心差不多就是这些,核心的核心就是用fs.readFileSync读取js文件,把内容拼接到一个大大的闭包中,这也解释了为什么我们自己写的所有node模块中都会有require方法,exports导出,以及__dirname和__filename参数。

了解了node.js的模块加载逻辑,在以后写node.js就更可避免一些误解,写出精细的代码。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
Jquery中offset()和position()的区别分析
Feb 05 Javascript
Jquery中基本选择器用法实例详解
May 18 Javascript
jQuery使用animate创建动画用法实例
Aug 07 Javascript
一起学写js Calender日历控件
Apr 14 Javascript
使用JavaScript判断手机浏览器是横屏还是竖屏问题
Aug 02 Javascript
javascript prototype原型详解(比较基础)
Dec 26 Javascript
BootstrapTable refresh 方法使用实例简单介绍
Feb 20 Javascript
js实现悬浮窗效果(支持拖动)
Mar 09 Javascript
详解Vue中数组和对象更改后视图不刷新的问题
Sep 21 Javascript
vue2中引用及使用 better-scroll的方法详解
Nov 15 Javascript
Node如何后台数据库使用增删改查功能
Nov 21 Javascript
vue项目启动出现cannot GET /服务错误的解决方法
Apr 26 Javascript
webpack4的迁移的使用方法
May 25 #Javascript
最后说说Vue2 SSR 的 Cookies 问题
May 25 #Javascript
详解webpack4多入口、多页面项目构建案例
May 25 #Javascript
js中的 || 与 &amp;&amp; 运算符详解
May 24 #Javascript
vue axios整合使用全攻略
May 24 #Javascript
vue路由拦截及页面跳转的设置方法
May 24 #Javascript
使用Vue自定义指令实现Select组件
May 24 #Javascript
You might like
isset和empty的区别
2007/01/15 PHP
基于header的一些常用指令详解
2013/06/06 PHP
浅析php fwrite写入txt文件的时候用 \r\n不能换行的问题
2013/08/06 PHP
php的zip解压缩类pclzip使用示例
2014/03/14 PHP
不使用php api函数实现数组的交换排序示例
2014/04/13 PHP
PHP之sprintf函数用法详解
2014/11/12 PHP
php从文件夹随机读取文件的方法
2015/06/01 PHP
Laravel日志用法详解
2016/10/09 PHP
javascript实现校验文件上传控件实例
2015/04/20 Javascript
在微信、支付宝、百度钱包实现点击返回按钮关闭当前页面和窗口的方法
2016/08/05 Javascript
浅析Javascript的自动分号插入(ASI)机制
2016/09/29 Javascript
正则中的回溯定义与用法分析【JS与java实现】
2016/12/27 Javascript
jquery处理checkbox(复选框)是否被选中实例代码
2017/06/12 jQuery
JavaScript操作文件_动力节点Java学院整理
2017/06/30 Javascript
移动端触摸滑动插件swiper使用方法详解
2017/08/11 Javascript
JS简单实现父子窗口传值功能示例【未使用iframe框架】
2017/09/20 Javascript
vue语法之拼接字符串的示例代码
2017/10/25 Javascript
vue实现的上拉加载更多数据/分页功能示例
2019/05/25 Javascript
微信小程序通过js实现瀑布流布局详解
2019/08/28 Javascript
Python获取网页上图片下载地址的方法
2015/03/11 Python
详解Python中的__new__()方法的使用
2015/04/09 Python
Python itertools模块详解
2015/05/09 Python
python cx_Oracle模块的安装和使用详细介绍
2017/02/13 Python
对django xadmin自定义菜单的实例详解
2019/01/03 Python
Python shelve模块实现解析
2019/08/28 Python
python numpy 矩阵堆叠实例
2020/01/17 Python
后端开发使用pycharm的技巧(推荐)
2020/03/27 Python
python爬虫可以爬什么
2020/06/16 Python
python开根号实例讲解
2020/08/30 Python
scrapy结合selenium解析动态页面的实现
2020/09/28 Python
HTML5 常用语法一览(列举不支持的属性)
2010/01/26 HTML / CSS
一级方程式赛车官方网上商店:F1 Store(支持中文)
2018/01/12 全球购物
CheapTickets香港机票预订网站:CheapTickets.hk
2019/06/26 全球购物
生产车间主任的个人自我鉴定
2013/10/25 职场文书
2014乡镇干部纪律作风整顿思想汇报
2014/09/13 职场文书
流动人口婚育证明
2014/10/19 职场文书