痛觉残留——Node原理

模块原理

在开始 Node 原理剖析之前，想讲一个十分简单的题目：module.exports 和 exports 有什么区别？这道题也算是面试必问题目之一了，答不出来面试基本就凉凉了。这里为尚未了解到的猿同胞们再解释一遍。

1.exports 是 module.exports 的一个引用，即 exports = module.exports = {}，二者所存的地址变量指向同一个对象。
2.暴露其实只会暴露出 module.exports 指向的对象，所以如果 exports 所存的地址指向另一个对象，则无法暴露，这也是为什么不能直接给 exports 赋值（exports = xxx）。

再深问一点：为什么暴露的是 module.exports？可能已经有猿同胞了解过。

1.Node 执行每个 js 文件时，其实是把内容包裹在一个函数中，然后执行这个函数。
2.这个函数传入的参数共有 exports、require、module、__filename、__dirname，所以我们可以在 js 文件中直接使用这些参数。而其它模块导入时会导入 module 的 exports 属性值，而不是 exports 引用。

那继续深挖：Node 是如何给文件包裹函数的？如何执行这个函数？exports / module.exports 和 require 是如何实现的？本篇就将解答这三个问题。

论据：Node 自带许多模块，且目前仍遵循 CommonJS 规范：

1.在 CommonJS 规范中，一个文件就是一个模块。
2.在 CommonJS 规范中，exports 暴露模块数据，require 导入模块数据。
3.Node 模块中，fs 文件模块可以读取文件为二进制或字符串。（显然二进制或字符串都无法执行）
4.Node 模块中，vm 模块具有安全虚拟机环境可以将字符串转化为代码执行。

结论：require 导入模块数据 + 文件 = 模块 => require 读取文件。因此，在 require 函数中，本质是根据传入的路径参数，用 fs 模块读取相应的文件为字符串，在字符串前后拼接被转化成字符串的函数，用 vm 虚拟机执行函数。

在使用 vm 虚拟机之前，补充一个知识点，runInThisContext 和 runInNewContext 的区别。

引入 vm 模块，通过 vm 的 runInThisContext 方法执行字符串，该字符串必须可以转化为代码执行。

image
image

可见是可以执行的，那么可不可以植入变量，尤其是虚拟机所处文件的变量。

image
image

报错 str 未定义，可见虚拟机外部变量是无法访问的，但我们知道，node 是存在全局变量的，虚拟机和虚拟机所在文件共处一个 node 环境，那么全局变量能否植入。

image
image

又正常输出了，那如何将虚拟机和虚拟机所在文件所处环境分开，那就需要使用 runInNewContext。

image
image

再次报错，可见 runInNewContext 无法访问 global 中的变量。

回到正题，继续看 Node 如何实现 require，首先肯定需要定义一个 require 函数，忽略内部的 try finally，require 函数体仅剩一句，self 就代表执行 require 的模块，相当于执行每个模块自身的 require 方法。

// 原版
function require(path) {
  try {
    exports.requireDepth += 1;
    return self.require(path);
  } finally {
    exports.requireDepth -= 1;
  }
}
// 忽略try finally
function require(path) {
    return self.require(path);
}

而模块自身的 require 方法所在文件引入了 assert 断言库，断言库内容我在《遗落之城——Unit Test》中有写过。这里断言 path 必须存在且必须是 string 类型，成功后调用模块的_load 静态方法，而_load 本质其实是加载已被加载过的模块，并不是真正加载模块的函数。

Module.prototype.require = function (path) {
  assert(path, "missing path");
  assert(typeof path === "string", "path must be a string");
  return Module._load(path, this, /* isMain */ false);
};

先贴上_load 方法的完整代码，再一句句分析。

1.Module._resolveFilename 是将 request 相对路径情况转为绝对路径，如果 request 是绝对路径就原样返回，还有一种情况是 node 原生模块，也会原样返回，同时 filename 也会作为该模块的唯一标识。
2.先从 Module 的静态属性_cache（缓存）上查找，如果已有缓存，则直接返回缓存的 exports。
3.通过 NativeModule.nonInternalExists 判断是否是原生模块，如果是则调用原生模块 NativeModule 的 require 方法返回该模块的 exports。
4.两种情况都不满足，就说明是尚未加载的自定义模块，会新建一个 Module 对象，将 Module 对象以 filename 为 key 放入缓存中，之后其它模块引入相同模块时就可以直接从缓存中取了，最后通过 tryModuleLoad 加载该模块，并返回该模块的 module.exports。

Module._load = function (request, parent, isMain) {
    if (parent) {
        debug('Module._load REQUEST %s parent: %S', request, parent.id);
    }

    var filename = Module._resolveFilename(request, parent, isMain);

    var cachedModule = Module._cache[filename];
    if (cachedModule) {
        return cachedModule.exports;
    }

    if (NativeModule.nonInternalExists(filename)) {
        debug('load native module %s', request);
        return NativeModule.require(filename);
    }

    var module = new Module(filename, parent);

    if (isMain) {
        process.mainModule = module;
        module.id = '.';
    }

    Module._cache[filename] = module;

    tryModuleLoad(module, filename);

    return module.exports;
}

Module 对象要注意的点并不多，将 id 初始化为绝对路径，将 exports 初始化为空对象，还添加了一个和 loaded 属性，初值为 false，这个属性值会在 tryModuleLoad 成功调用完成后变为 true，表示该模块加载完成。

function Module(id, parent) {
    this.id = id;
    this.exports = {};
    this.parent = parent;
    if (parent && parent.children) {
        parent.children.push(this);
    }

    this.filename = null;
    this.loaded = false;
    this.children = []
}

tryModuleLoad 也只是尝试加载，如果加载失败，就会从 Module 的缓存中删除该模块，而到这里，真正的加载函数 load 方法才冒出水面。

function tryModuleLoad(module, filename) {
    var threw = true;
    try {
        module.load(filename);
        threw = false;
    } finally {
        if (threw) {
            delete Module._cache[filename]
        }
    }
}

同样先贴上 load 方法的完整代码再一句句分析。

1.先断言该模块未被加载，然后将绝对路径赋值给该模块的 filename 属性（filename 相当于和 id 同值）。
2.最核心的代码其实就是通过 path.extname 获取扩展名，无扩展名或 Module._extensions 上午该扩展名对应的方法时，都会赋值扩展名为.js。
3.Module 的_extensions 静态属性是 object 对象，key 为扩展名，值为加载对应扩展名模块的方法函数。最后相当于通过扩展名拿到对应函数执行，执行完成后，将该模块加载完成状态 loaded 改为 true。

Module.prototype.load = function (filename) {
    debug('load %j for module %j', filename, this.id);

    assert(!this.loaded);
    this.filename = filename;
    this.paths = Module._nodeModulePaths(path.dirname(filename));

    var extension = path.extname(filename) || '.js';
    if (!Module._extensions[extension]) extension = '.js';
    Module._extensions[extension](this, filename);
    this.loaded = true;
}

_extensions 共有三种扩展名及对应的方法：.json、.js、.node。主要分析前两种，因为.node 一般为 C/C++文件，这里就不涉及相关知识了。另一方面，.json 和.js 都调用了 internalModule.stripBOM 方法，作用是剥离 utf8 编码特有的 BOM 文件头，也没必要细究。

首先是.json 文件，加载流程非常简单，直接通过 fs 模块读取文件为字符串，然后通过 JSON.parse 转为 json 对象赋值给 module.exports 函数。

Module._extensions['.json'] = function (module, filename) {
    var content = fs.readFileSync(filename, 'utf8');
    try {
        module.exports = JSON.parse(internalModule.stripBOM(content))
    } catch (err) {
        err.message = filename + ':' + err.message;
        throw err;
    }
}

其次是.js，也是先用 fs 模块读取为字符串，但注意_compile 编译完并未做赋值。

Module._extensions['.js'] = function (module, filename) {
    var content = fs.readFileSync(filename, 'utf8');
    module._compile(internalModule.stripBOM(content), filename);
}

_compile 是对读取完的 js 文件进行编译，表面上函数很复杂，但需要关注的地方并不多，先看 var wrapper = Module.wrap(content)，fs 读取完的字符串作为参数传给 wrap 函数。

Module.prototype._compile = function (content, filename) {
    var contLen = content.length;
    if (contLen >= 2) {
        if (content.charCodeAt(0) === 35 /*#*/ &&
            content.charCodeAt(1) === 33 /*!*/ ) {
            if (contLen === 2) {
                content = '';
            } else {
                var i = 2;
                for (; i < contLen; ++i) {
                    var code = content.charCodeAt(i);
                    if (code === 10 /*\n*/ || code === 13 /*\r*/ )
                        break;
                }
                if (i === contLen)
                    content = '';
                else {
                    content = content.slice(i);
                }
            }
        }
    }

    var wrapper = Module.wrap(content);

    var compiledWrapper = vm.runInThisContext(wrapper, {
        filename: filename,
        lineOffset: 0,
        displayErrors: true
    });

    var inspectorWrapper = null;
    if (process._debugWaitConnect && process._eval == null) {
        if (!resolvedArgv) {
            if (process.argv[1]) {
                resolvedArgv = Module._resolveFilename(process.argv[1], null, false);
            } else {
                resolvedArgv = 'repl';
            }
        }

        if (filename === resolvedArgv) {
            delete process._debugWaitConnect;
            inspectorWrapper = getInspectorCallWrapper();
            if (!inspectorWrapper) {
                const Debug = vm.runInDebugContext('Debug');
                Debug.setBreakPoint(compiledWrapper, 0, 0);
            }
        }
    }

    var dirname = path.dirname(filename);

    var require = internalModule.makeRequireFunction(this);

    var depth = internalModule.requireDepth;
    if (depth === 0) stat.cache = new Map();
    var result;

    if (inspectorWrapper) {
        result = inspectorWrapper(compiledWrapper, this.exports, this.exports, require, this, filename, dirname);
    } else {
        result = compiledWrapper.call(this.exports, this.exports, require, this, filename, dirname);
    }
    if (depth === 0) stat.cache = null;
    return result;
};

wrap 函数的 script 参数接收字符串后，返回一个被转化为字符串的函数所包裹的字符串，这样读取到的文件内容就相当于位于函数体中了。回到_compile 函数，紧接着便调用了 vm.runInThisContext 方法，但需要注意的是，执行结果相当于定义了一个函数，并将函数存在 compiledWrapper 变量中，而并不是调用这个函数。

NativeModule.wrap = function (script) {
    return NativeModule.wrapper[0] + script + NativeModule.wrapper[1];
};
NativeModule.wrapper = [
    '(function (exports, require, module, __filename, __dirname) { ',
    '\n});'
];
Module.wrapper = NativeModule.wrapper;
Module.wrap = NativeModule.wrap;

忽略掉中间冗余无需关注的部分，最后需要关注的只剩 result = compiledWrapper.call(this.exports, this.exports, require, this, filename, dirname)（自定义模块都会执行 else 情况）。

1.通过 call 方法执行 compiledWrapper 所存的函数。
2.将函数的 this 指向_load 函数中 new Module 创建对象的 exports，这也是为什么我们在文件中调用 this 会输出暴露的数据。
3.将 exports 属性、require 方法、module 对象自身、module 对象的 filename（同时也是 id）作为文件名、module 对象所在的文件夹路径 dirname，共同作为函数参数传入。
4.其中 filename 是函数最开始传入的参数，dirname 通过 load 函数的 var dirname = path.dirname(filename)语句获取。
5.至于 require，可以看到执行了一句 var require = internalModule.makeRequireFunction(this)，而这句函数就是给模块创建一个 require 方法，也就是开始的 require 函数。
6.注意到，执行完的结果 result 变量虽然 return 了但在_extensions['.js']中并没有做赋值操作，反而是通过 call 函数，将暴露的数据和 new Module 创建对象的 exports 绑定。

最后，再提一遍，在_load 函数中有 return module.exports，这样 module.exports 所存的地址层层返回给 require 结果，就是返回到调用 require 的模块中，这样调用 require 的模块也就拿到了被导入模块所暴露的数据。

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