了解CommonJS模块化规范

2023-10-30

1.概述


Node应用由模块组成,采用CommonJS模块规范。
每个文件就是一个模块,有自己的作用域。在一个文件里面定义的变量、函数、类,都是私有的,对其他文件不可见。

// example.js
var x = 5;
var addX = function (value) {
  return value + x;
}

上面代码中,变量x和函数addX,是当前文件example.js私有的,其他文件不可见。

如果想在多个文件分享变量,必须定义为global对象的属性。

global.wrning = true;


上面代码的warning变量,可以被所有文件读取。当然,这样写法是不推荐的。

CommonJS规范规定,每个模块内部,module变量代表当前模块。这个变量是一个对象,它的exports属性(即module.exports)是对外的接口。加载某个模块,其实是加载该模块的module.exports属性。

var x = 5;
var addX = function (value) {
  return value + x;
};
module.exports.x = x;
module.exports.addX = addX;

上面代码通过module.exports输出变量x和函数addX。


require方法用于加载模块:

var example = require('./example.js');

console.log(example.x); // 5
console.log(exampl.addX(1)); // 6

 require方法的详细解释参见《Require命令》一节。

CommonJS模块的特点如下:

  •  所有代码都运行在模块作用域,不会污染全局作用域。
  •  模块可以多次加载,但是只会在第一次加载时运行一次,然后运行结果就被缓存了,以后再加载,就直接读取缓存结果。要想让模块再次运行,必须清除缓存。
  •  模块加载的顺序,按照其在代码中出现的顺序。

 2. module对象
Node内部提供一个Module构建函数。所有模块都是Module的实例。

function Module(id,parent) {
  this.id = id;
  this.exports = {};
  this.parent = parent;
}

每个模块内部,都有一个module对象,代表当前模块。它有以下属性。

 module.id 模块的识别符,通常是带有绝对路径的模块文件名。
 module.filename 模块的文件名,带有绝对路径。
 module.loaded 返回一个布尔值,表示模块是否已经完成加载。
 module.parent 返回一个对象,表示调用该模块的模块。
 module.children 返回一个数组,表示该模块要用到的其他模块。
 module.exports 表示模块对外输出的值。

下面是一个实例文件,最后一行输出module变量。

// example.js
var jquery = require('jquery');
exports.$ = jquery;
console.log(module);

执行这个文件,命令行会输出如下信息。

{
  id: '.',
  exports: { '$': [function] },
  parent: null,
  filename: '/path/to/example.js',
  loaded: false,
  children:[{
        id: '/path/to/node_modules/jquery/dist/jquery.js',
        exports: [Function],
        parent: [Circular],
        filename: '/path/to/node_modules/jquery/dist/jquery.js',
        loaded: true,
        children: [],
        paths: [Object]
        
    }],
  paths:[
    '/home/user/deleted/node_modules',
    '/home/user/node_modules',
    '/home/node_modules',
    '/node_modules'
  ]
}


如果在命令行下调用某个模块,比如node something.js,那么module.parent就是null。如果是在脚本之中调用,比如require('./something.js'),那么module.parent就是调用它的模块。利用这一点,可以判断当前模块是否为入口脚本。

if (!module.parent) {
  // ran with `node something.js`
  app.listen(8088, function() {
    console.log('app listeningon port 8088');
  })
} else {
  // used width `require('./something.js')`
  module.exports = app;
}


 2.1 module.exports属性
module.exports属性表示当前模块对外输出的接口,其他文件加载该模块,实际上就是读取module.exports变量。

var EventEmitter = require('events').EventEmitter;
module.exports = new EventEmitter();

setTimeout(function() {
  module.exports.emit('ready');
},1000);

上面模块会在加载1秒后,发出ready事件。其他文件监听该事件,可以写成下面这样。

var a = require('./a');
a.on('ready',function() {
  console.log('module a is ready');
});


2.2 exports 变量
为了方便,Node为每个模块提供一个exports变量,指向module.exports。这等同在每个模块头部,有一行这样的命令。

var exports = module.exports;


作用是,在对外输出模块接口时,可以向exports对象添加方法。

exports.area = function (r) {
  return Math.PI * r * r;
};

exports.circumferencr = function (r) {
  return 2 * Math.PI * r;
};


注意,不能直接将exports变量指向一个值,因为这样等于切断 exports与module.exports的联系。

exports = function(x) {console.log(x)}

上面这样的写法是无效的,因为exports不再指向module.exports了。


下面的写法也是无效的。

exports.hello = function() {
  return 'hello';
};

module.exports = 'Hello world';


上面代码中,hello函数是无法对外输出的,因为module.exports被重新赋值了。

这意味着,如果一个模块的对外接口,就是一个单一的值,不能使用exports输出,只能使用module.exports输出。

module.exports = function(x) {
  console.log(x);
}


如果你觉得,exports与module.exports之间的区别很难区分清,一个简单的处理方法,就是放弃使用exports,只使用module.exports。

3. AMD规范与CommonJS规范的兼容性


CommonJS规范加载模块是同步的,也就是说,只有加载完成,才能执行后面的操作。AMD规范则是非同步加载模块,允许指定回调函数。由于Node.js主要用于服务器编程,模块文件一般都已经存在于本地硬盘,所以加载起来比较快,不用考虑非同步加载的方式,所以CommonJS规范比较适用。但是,如果是浏览器环境,要从服务器端加载模块,这时就必须采用非同步模式,因此浏览器端一般采用AMD规范。

AMD规范使用define方法定义模块,下面就是一个例子:

define(['package/lib'], function(lib){
  function foo(){
    lib.log('hello world!');
  }
  
  return {
    foo: foo
  };
});


AMD规范允许输出的模块兼容CommonJS规范,这时define方法需要写成下面这样:

define(function (require, exports, module){
  var someModule = require("someModule");
  var anotherModule = require("anotherModule");
  
  someModule.doTehAwesome();
  anotherModule.doMoarAwesome();
  
  exports.asplode = function (){
    someModule.doTehAwesome();
    anotherModule.doMoarAwesome();
  };
});


4. require命令
 4.1 基本用法
Node使用CommonJS模块规范,内置的require命令用于加载模块文件。

require命令的基本功能是,读入并执行一个Javascript文件,然后返回该模块的exports对象。如果没哟发现指定模块,会报错。

// example.js
var invisible = function() {
  console.log("invisible");
}

exports.message = "hi";

exports.say = function(){
  console.log(message);
}


运行下面的命令,可以输出exports对象。

var example = require('./example.js');
// example
// {
//   message: 'hi',
//   say: [function]
// }


如果模块输出的是一个函数,那就不能定义在exports对象上面,而要定义在module.exports变量上面。

module.exports = function() {
  console.log('hello world')
}

require('./example2.js')()


上面代码中,require命令调用自身,等于是执行module.exports,因此输出hello world.

 4.2 加载规则
require命令用于加载文件,后缀名默认为.js。

var foo = require('foo');
// 等同于
var foo = require('foo.js');


根据参数的不同格式,require命令去不同路径寻找模块文件。
1) 如果参数字符串以'/'开头,则表示加载的是一个位于绝对路径的模块文件。比如,require('/home/marco/foo.js')将加载/home/marco/foo.js.

2) 如果参数字符串以'./'开头,则表示加载的是一个位于相对路径(跟当前执行脚本的位置相比)的模块文件。比如,require('./circle')将加载当前脚本同一目录的circle.js。

3) 如果参数字符串不以'./'或'/'开头,则表示加载的是一个默认提供的核心模块(位于Node的系统安装目录中),或者一个位于各级node_modules目录的已安装模块(全局安装或局部安装)。
举例来说,脚本/home/user/projects/foo.js执行了require('bar.js')命令,Node会依次搜索以下文件。

 /usr/local/lib/node/bar.js
/home/user/projects/node_modules/bar.js
/home/user/node_modules/bar.js
/home/node_modules/bar.js
/node_modules/bar.js

这样的设计目的是,使得不同的模块可以将所依赖的模块本地化。

4) 如果参数字符串不以'./'或'/'开头,而且是一个路径,比如require('example-module/path/to/file'),则是将先找到example-module的位置,然后再以它为参数,找到后续路径。

5) 如果指定的模块文件没有发现,Node会尝试为文件名添加.js、.json、.node后,再去搜索。.js文件会以文本合适的Javascript脚本文件解析,.json文件会以JSON格式的文本文件解析,.node文件会以编译后的二进制文件解析。

6) 如果想得到require命令加载的确切文件名,使用require.resolve()方法。

4.3目录的加载规则
通常,我们会把相关的文件放在一个目录里面,便于组织。这时,最好为该目录设置一个入口文件,让require方法可以通过这个入口文件,加载整个目录。

在目录中放置一个package.json文件,并且将入口文件写入main字段。下面是一个例子。

// package.json
{
  "name": "some-library",
  "main": "./lib/some-library.js"
}


require发现参数字符串指向一个目录以后,会自动查看该目录的package.json文件,然后加载main字段指定的入口文件。如果package.json文件没有main字段,或者根本就没有package.json文件,则会加载该目录下的index.js文件或index.node文件。

 4.4 模块的缓存

第一次加载某个模块时,Node会缓存该模块。以后再加载该模块,就直接从缓存取出该模块的module.exports属性。

require('./example.js');
require('./example.js').message = 'hello';
require('./example.js').message
// 'hello'


上面代码中,连续三次使用require命令,加载同一个模块。第二次加载的时候,为输出的对象添加了一个meaasge属性。但是第三次加载的时候,这个meaasge属性依然存在,这就证明require命令并没有重新加载模块文件,而是输出了缓存。

如果想要多次执行某个模块,可以让该模块输出一个函数,然后每次require这个模块的时候,重新执行以下输出的函数。

所有缓存的模块保存在require.cache之中,如果想删除模块的缓存,可以像下面这样写。

// 删除指定模块的缓存
delete require.cache[moduleName]

// 删除所有模块的缓存
Object.keys(require.cache).forEach(function(key){
  delete require.cache[key];
})


注意,缓存是根据绝对路径是比模块的,如果同样的模块名,但是保存在不同的路径,require命令还是会重新加载该模块。

 4.5 环境变量NODE_PATH
Node执行一个脚本时,会先查看环境变量NODE_PATH。它是一组以冒号分隔的绝对路径。在其他位置找不到指定模块时,Node会去这些路径查找。

可以将NODE_PATH添加到.bashrc。
> export NODE_PATH = "/usr/local/lib/node"

所以,如果遇到复杂的相对路径,比如下面这样。

var myModule = require('../../../../lib/myModule');


有两种解决办法,一是将该文件加入node_modules目录,二是修改NODE_PATH环境变量,package.json文件可以采用下面的写法。

{
  "name": "node_path",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "NODE_PATH=lib node index.js"
  },
  "author": "",
  "license": "ISC"
}


NODE_PATH是历史遗留下来的一个路径解决方案,通常不应该使用,而应该使用node_modules目录机制。

 4.6 模块的循环加载
如果发生模块的循环加载,即A加载B,B又加载A,则B将加载A的不完整版本。

// a.js
exports.x = 'a1';
console.log('a.js', require('./b.js').x);
exports.x = 'a2';

// b.js
exports.x = 'b1';
console.log('b.js', require('./a.js').x);
exports.x = 'b2';

// main.js
console.log('main.js', require('./a.js').x);
console.log('main.js', require('./b.js').x);


上面代码是三个Javascript文件。其中,a.js加载了b.js,而b.js又加载a.js。这时,Node返回a.js的不完整版本,所以执行结果如下。

$ node main.js
b.js a1
a.js b2
main.js a2
main.js b2


修改main.js,再次加载a.js和b.js。

// main.js
console.log('main.js', require('./a.js').x);
console.log('main.js', require('./b.js').x);
console.log('main.js', require('./a.js').x);
console.log('main.js', require('./b.js').x);


执行上面代码,结果如下。

$ node main.js
b.js a1
a.js b2
main.js a2
main.js b2
main.js a2
main.js b2


上面代码中,第二次加载a.js和b.js时,会直接从缓存读取exports属性,所以a.js和b.js内部的console.log语句都不会执行了。

 4.7 require.main
require方法有一个main属性,可以用来判断模块是直接执行,还是被调用执行。
直接执行的时候(node module.js),require.main属性指向模块本身。

require.main === module
// true


调用执行的时候(通过require加载该脚本执行),上面的表达式返回false。

 5. 模块的加载机制
CommonJS模块的加载机制是,输入的是被输出的值的拷贝。也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。请看下面这个例子。
下面是一个模块文件lib.js。

// lib.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  counter:counter,
  icCounter: incCounter
}


上面代码输出内部变量counter和改写这个变量的内部方法incCounter。
然后,加载上面的模块。

// main.js
var counter = require('./lib').counter;
var incCounter = require('./lib').incCounter;

console.log(counter); // 3
incCounter();
console.log(counter); // 3


上面代码说明,counter输出以后,lib.js模块内部的变化就影响不到counter了。

然后,加载上面的模块。

// main.js
var counter = require('./lib').counter;
var incCounter = require('./lib').incCounter;

console.log(counter); // 3
incCounter();
console.log(counter); // 3


上面代码说明,counter输出以后,lib.js模块内部的变化就影响不到counter了。

 5.1  require的内部处理流程
require命令是CommonJS规范之中,用来加载其他模块的命令。它其实不是一个全局命令,而是指向当前模块的module.require命令,而后者又调用Node的内部命令Module._load。

Module._load = function(request, parent, isMain) {
  // 1. 检查Module._cache,是否缓存之中有指定模块
  // 2. 如果缓存之中没有,就创建一个新的Module实例
  // 3. 将它保存到缓存
  // 4. 使用module.load()加载指定的模块文件,
  //    读取文件内容之后,使用module.complie()执行文件代码
  // 5. 如果加载/解析过程报错,就从缓存删除该模块
  // 6. 返回该模块的module.exports
};


上面的第4步,采用module.compile()执行指定模块的脚本,逻辑如下:

Module.prototype._compile = function(content, filename) {
  // 1. 生成一个require函数,指向module.require
  // 2. 加载其他辅助方法到require
  // 3. 将文件内容放到一个函数之中,该函数可调用require
  // 4. 执行该函数
};


上面的第1步和第2步,require函数及其辅助方法主要如下。

  •  require( ): 加载外部模块
  •  require.resolve( ): 将模块名解析到一个绝对路径
  •  require.main: 指向主模块
  •  require.cache: 指向所有缓存的模块
  •  require.extensions: 根据文件的后缀名,调用不同的执行函数

一旦require函数准备完毕,整个所要加载的脚本内容,就被放到一个新的函数之中,这样可以避免污染全局环境。该函数的参数包括require、module、exports,以及其他一些参数。

(function (exports, require, module, __filename, __dirname){
  // YOUR CODE INJECTED HERE!    
});


Module._compile方法是同步执行的,所以Module._load要等它执行完成,才会向用户返回module.exports的值。


 

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

了解CommonJS模块化规范 的相关文章

随机推荐

  • 机器视觉解决方案 首选诺威特

    机器视觉解决方案 首选诺威特 诺威特简介 诺威特 NOVTEC 成立于2003年 总部位于江苏苏州 是专业从事测试解决方案的高科技企业 为企业和研究机 构提供大量高端的测试仪器设备解决方案 使用人工智能Artificial intellig
  • QT 使用QZXing生成,解析二维码跟条码

    1 下载QZXing库 为什么要下载QZXing库 而不直接使用编译好的库文件 因为每个人使用的编译环境是不一样的 使用的编译器也不尽相同 不同编译器编译出来的库放到不同编译器下则不一定能够使用 至少我是这么理解的 使用别人的也经常出现崩溃
  • 【华为OD机试】告警抑制【2023 B卷

    时间限制 C C 1秒 其他语言 2秒 空间限制 C C 262144K 其他语言524288K 64bit IO Format lld 语言限定 C clang11 C clang 11 Pascal fpc 3 0 2 Java jav
  • vbs中遍历子目录寻找特定文件

    转载 https blog csdn net hywerr article details 70228086 递归函数如下 Function FileExsitInDirectory fso As Object filename As St
  • 64位操作系统(WIN10)+32位LabVIEW(2020)+64位MySQL,Windows10系统下用32位ODBC连接MySQL

    1 首先得安装 Connector ODBC 就是MySQL的ODBC驱动 这个是与应用程序相关的 而不是与操作系统相关的 也就是说 不管你的系统是X64还是X86 只要你的应用程序是X86的那么 Connector ODBC 就要安装X8
  • cordova环境搭建以及打包apk

    1 安装node JS 2 安装ant 载连接 http ant apache org 下载完成之后解压到你想安装的目录 比如D ant 然后将目录添加到系统变量里 步骤如下 右击我的电脑 点击属性 左侧菜单点击高级系统设置 在弹窗中点击环
  • 【发现】国产007里面星爷挖子弹时看的电影~~~~

    Educating Mandy 春潮烂漫海棠红 影片名称 Educating Mandy 春潮烂漫海棠红 主演女优 Traci Lords 翠希 劳艾德 呵呵 今天逛论坛的时候看到了 转载于 https www cnblogs com bo
  • 动物识别专家系统(Java实现已开源)

    动物识别专家系统 产生式系统 问题定义 系统实现 规则 事实和产生式的表示 类的设计 匹配顺序 推理机 结果演示 源代码 产生式系统 规则库 规则库是用于描述相应领域内知识的产生式集合 它是产生式系统求解问题的基础 其中对领域知识表达的完整
  • RabbitMQ之Work Queues

    工作队列 又称任务队列 的主要思想是避免立即执行资源密集型任务 而不得不等待它完成 相反我们安排任务在之后执行 我们把任务封装为消息并将其发送到队列 在后台运行的工作进 程将弹出任务并最终执行作业 当有多个工作线程时 这些工作线程将一起处理
  • 实战案例之瀑布流效果

    前言 从服务器获取需要展示的数据 图片大小不一致 大中 中 小 每次从服务器获取三条数据 依次插入到三列中 每一列的宽度是一样的 弊端 可能导致某一列特别的高 而某一列特别的矮 瀑布流 需求分析 最终期望三列的高度差距应该是不大的才可以 最
  • .net core 集成Redis

    第一步 引用StackExchange Redis 第二步 初始化 private string constr 127 0 0 1 6379 allowadmin true connect ConnectionMultiplexer Con
  • 【图像重建】基于ADMM的tv正则化最小化稀疏实现图像重建附matlab代码

    1 简介 2 部分代码 This simple demo examines if TVAL3 works normally Please try more demos in the Demos directory which would s
  • Unity的C#编程教程_28_switch语句

    switch 其实就是 else if 的替代品 可以让代码更简洁清晰 如果你用了 2 个或者以上的 eles if 那就考虑下能否改成 switch 比如一个游戏得分评价系统 using System Collections using
  • Tiled-免费2D游戏场景Tile编辑器

    Tiled 1 是一款免费2D游戏场景Tile编辑器 Tiled支持正方形 平行四边形和六边形Tile 同时Tiled也支持在场景上画矩形 用户手册 Tiled有详细的用户手册 2 罗列了编辑器所有的功能 有不少高级功能 适合程序员了解 场
  • 思科交换机密码破解

    思科交换机密码破解 A 1 打开电脑中SecureCRT软件 或者下载windows7 超级终端 v1 01 绿色版 hypertrm exe 把port COM3 不具体 需要查看电脑的端口具体为多少 和Baud rate 波特率 默认为
  • 生成测试数据的4种方法、5种工具介绍

    在软件测试中 测试数据是测试用例的基础 对测试结果的准确性和全面性有着至关重要的影响 因此 在进行软件测试时 需要生成测试数据以满足测试场景和要求 本文将介绍什么情况下需要生成测试数据 如何生成测试数据 以及一些常用的测试数据生成工具 1
  • mac Android studio3.2版本安装+环境搭建

    Android studio3 2安装 1 下载android studio 2 下载sdk manager 3 打开sdk manager 4 sdk manager需要设置代理才可以正常更新 mirrors zzu edu cn 80
  • Element-ui 表单的基础使用

    1 基本三大组件
  • 4-6 三部排序Java

    快排变体 极限思维 全部为0 必为p 一般的排序有许多经典算法 如快速排序 希尔排序等 但实际应用时 经常会或多或少有一些特殊的要求 我们没必要套用那些经典算法 可以根据实际情况建立更好的解法 比如 对一个整型数组中的数字进行分类排序 使得
  • 了解CommonJS模块化规范

    1 概述 Node应用由模块组成 采用CommonJS模块规范 每个文件就是一个模块 有自己的作用域 在一个文件里面定义的变量 函数 类 都是私有的 对其他文件不可见 example js var x 5 var addX function