Node.js的模块机制

本文参考Node.js v8.1.3 Documentation

在 Node.js 中,文件和模块是一一对应的,一个文件就是一个独立的模块。
模块内, Function 和 object 通过exports对象的方法添加到模块根部。

模块容器

模块内的变量是私有的。因为在Node.js 中,模块被执行前,是包裹在函数容器里的。

(function(exports, require, module, __filename, __dirname) {
// Module code actually lives in here
});

这么做除了实现特定于模块的全局变量时,也能使,用let等声明的变量不在全局声明。换句话说,如果我不用let在模块内声明变量,那这个变量是定义在全局的。
如下是一个简单的模块,写出来只是觉得很少有模块还带参数的...真有一天要带估计也得这么写吧。

module.exports = (width) => {
  return {
    area: () => width ** 2
  };
};

模块读取机制

只取一部分,全部看这里。(All Together)[https://nodejs.org/dist/latest-v8.x/docs/api/modules.html#modules_all_together]

require(X) from module at path Y
1. If X is a core module,
   a. return the core module
   b. STOP
2. If X begins with '/'
   a. set Y to be the filesystem root
3. If X begins with './' or '/' or '../'
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
4. LOAD_NODE_MODULES(X, dirname(Y))
5. THROW "not found"

LOAD_AS_FILE(X)
1. If X is a file, load X as JavaScript text.  STOP
2. If X.js is a file, load X.js as JavaScript text.  STOP
3. If X.json is a file, parse X.json to a JavaScript Object.  STOP
4. If X.node is a file, load X.node as binary addon.  STOP

LOAD_INDEX(X)
1. If X/index.js is a file, load X/index.js as JavaScript text.  STOP
2. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
3. If X/index.node is a file, load X/index.node as binary addon.  STOP

LOAD_AS_DIRECTORY(X)
1. If X/package.json is a file,
   a. Parse X/package.json, and look for "main" field.
   b. let M = X + (json main field)
   c. LOAD_AS_FILE(M)
   d. LOAD_INDEX(M)
2. LOAD_INDEX(X)

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS

缓存

模块在第一次被加载时是会被缓存的,所以在那之后的require行为都将返回同一个对象,模块内的代码也不会因为多次的require而被执行多次。
然而,模块的缓存是依据于他们的文件名的,而模块又可以根据调用模块的位置而解析为不同的文件名(后半句没懂)。所以不保证require('foo')总是返回同样的对象。
还有一个注意的事项,在一些不区分大小写的文件系统或操作系统,require('./foo')require('./FOO')是返回不同的结果的,无论二者是否为相同的文件。

循环

考虑下面的情况。
a.js

console.log('a starting');    //3
exports.done = false;    //4
const b = require('./b.js');    //5
console.log('in a, b.done = %j', b.done);    //12
exports.done = true;    //13
console.log('a done');    //14

b.js

console.log('b starting');    //6
exports.done = false;    //7
const a = require('./a.js');    //8
console.log('in b, a.done = %j', a.done);    //9
exports.done = true;    //10
console.log('b done');    //11

main.js

console.log('main starting');    //1
const a = require('./a.js');    //2
const b = require('./b.js');    //15
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);    //16

以下是运行main.js的输出

main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true

main.js被运行的时,先加载a.js,然后a.js又加载了b.js。此时,b.js想加载'a.js'。为了防止出现无限循环的清空,一个未完成的a.js副本会exportsb.js,然后完成b.js的加载,加载完的对象 exportsa.js
整理一下运行的顺序。 (标柱)这里稍微提一下的是,15步因为缓存,所以没有再次执行b.js的代码。然后第一次运行b.js里中的const a = require('./a.js'); //8 虽然这里最开始是副本,但是等a.js加载完后,其中的变量a,也是加载完成后的状态了。

module对象

像之前(模块容器)提到,module并不是全局对象,而是每个模块内的对象。

module.children

  • 数组

模块所需的对象

module.exports

  • 对象

有些人希望导出的部分,是当前模块(类)的实例。

a.js

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

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

b.js

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

module.exports必须被立即执行,不能放在任何的回调中。
exports 也只是一个普通的变量,默认情况下被赋值为 module.exports,其有作用域,也能被另外赋值。

附:模块语法

import

//导入默认的成员
import defaultMember from "module-name"; 
//导入整个模块,并将该模块在当前作用域命名为 `name`
import * as name from "module-name"; 
/* 以上二者的区别为,前者仅导入 default 关键字导出的成员。而后者导入的的是所有具名导出的成员,并凑成对象命名为 name*/


//导入模块的指定(`member`)成员(具名)
import { member } from "module-name"; 
//导入具名成员 member 并重命名为alias;
import { member as alias } from "module-name"; 

//导入多个具名成员
import { member1 , member2 } from "module-name"; 

//以下代码将MyModule,foo,bar插入到当前作用域。其中,MyModule是"my-module"模块中的export default 暴露的模块,而foo和bar则只是“my-module”代码中 export 暴露的对象中的 foo和 bar 属性。
import MyModule, { foo,bar} from "module-name"; 

//能够运行该模块的内容,但是不进行任何操作。
import "module-name";

export

export var myVar1 = ...;
export class MyClass {
    ...
}
export default 123;


const MY_CONST = ...;
function myFunc() {
    ...
}
export { MY_CONST, myFunc };
export { foo, bar } from 'src/other_module';

参考:ECMAScript 6 modules: the final syntax

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

推荐阅读更多精彩内容