require() 源码解读

2009年，Node.js 项目诞生，所有模块一律为 CommonJS 格式。

时至今日，Node.js 的模块仓库 npmjs.com ，已经存放了15万个模块，其中绝大部分都是 CommonJS 格式。

这种格式的核心就是 require 语句，模块通过它加载。学习 Node.js ，必学如何使用 require 语句。本文通过源码分析，详细介绍 require 语句的内部运行机制，帮你理解 Node.js 的模块机制。

一、require() 的基本用法

分析源码之前，先介绍 require 语句的内部逻辑。如果你只想了解 require 的用法，只看这一段就够了。

下面的内容翻译自《Node使用手册》。

当 Node 遇到 require(X) 时，按下面的顺序处理。

（1）如果 X 是内置模块（比如 require(http）)
a. 返回该模块。
b. 不再继续执行。

（2）如果 X 以 "./" 或者 "/" 或者 "../" 开头
a. 根据 X 所在的父模块，确定 X 的绝对路径。
b. 将 X 当成文件，依次查找下面文件，只要其中有一个存在，就返回该文件，不再继续执行。

c. 将 X 当成目录，依次查找下面文件，只要其中有一个存在，就返回该文件，不再继续执行。

a. 根据 X 所在的父模块，确定 X 可能的安装目录。
b. 依次在每个目录中，将 X 当成文件名或目录名加载。

（4） 抛出 "not found"

请看一个例子。

当前脚本文件 /home/ry/projects/foo.js 执行了 require(bar) ，这属于上面的第三种情况。Node 内部运行过程如下。

首先，确定 x 的绝对路径可能是下面这些位置，依次搜索每一个目录。

 /home/ry/projects/node_modules/bar

/home/ry/node_modules/bar

/home/node_modules/bar

/node_modules/bar

搜索时，Node 先将 bar 当成文件名，依次尝试加载下面这些文件，只要有一个成功就返回。

bar.js

bar.json

bar.node

如果都不成功，说明 bar 可能是目录名，于是依次尝试加载下面这些文件。

bar/package.json（main字段）

bar/index.js

bar/index.json

bar/index.node

如果在所有目录中，都无法找到 bar 对应的文件或目录，就抛出一个错误。

二、Module 构造函数

了解内部逻辑以后，下面就来看源码。

require 的源码在 Node 的 lib/module.js 文件。为了便于理解，本文引用的源码是简化过的，并且删除了原作者的注释。

 function Module(id, parent) {

 this.id = id;

 this.exports = {};

 this.parent = parent;

 this.filename = null;

 this.loaded = false;

 this.children = []; }

module.exports = Module; var module = new Module(filename, parent); 

上面代码中，Node 定义了一个构造函数 Module，所有的模块都是 Module 的实例。可以看到，当前模块（module.js）也是 Module 的一个实例。

每个实例都有自己的属性。下面通过一个例子，看看这些属性的值是什么。新建一个脚本文件 a.js 。

// a.js

console.log(module.id: , module.id);

console.log(module.exports: , module.exports);

console.log(module.parent: , module.parent);

console.log(module.filename: , module.filename);

console.log(module.loaded: , module.loaded);

console.log(module.children: , module.children);

console.log(module.paths: , module.paths); 

运行这个脚本。

$ node a.js

module.id: .

module.exports: {}

module.parent: null

module.filename: /home/ruanyf/tmp/a.js

module.loaded: false

module.children: []

module.paths: [ /home/ruanyf/tmp/node_modules, /home/ruanyf/node_modules, /home/node_modules, /node_modules ] 

可以看到，如果没有父模块，直接调用当前模块，parent 属性就是 null，id 属性就是一个点。filename 属性是模块的绝对路径，path 属性是一个数组，包含了模块可能的位置。另外，输出这些内容时，模块还没有全部加载，所以 loaded 属性为 false 。

新建另一个脚本文件 b.js，让其调用 a.js 。

// b.js

 var a = require(./a.js); 

运行 b.js 。

$ node b.js

module.id: /home/ruanyf/tmp/a.js

module.exports: {}

module.parent: { object }

module.filename: /home/ruanyf/tmp/a.js

module.loaded: false

module.children: []

module.paths: [ /home/ruanyf/tmp/node_modules, /home/ruanyf/node_modules, /home/node_modules, /node_modules ] 

上面代码中，由于 a.js 被 b.js 调用，所以 parent 属性指向 b.js 模块，id 属性和 filename 属性一致，都是模块的绝对路径。

三、模块实例的 require 方法

每个模块实例都有一个 require 方法。

Module.prototype.require = function(path) { return Module._load(path, this); }; 

由此可知，require 并不是全局性命令，而是每个模块提供的一个内部方法，也就是说，只有在模块内部才能使用 require 命令（唯一的例外是 REPL 环境）。另外，require 其实内部调用 Module._load 方法。

下面来看 Module._load 的源码。

Module._load = function(request, parent, isMain) { // 计算绝对路径

 var filename = Module._resolveFilename(request, parent); // 第一步：如果有缓存，取出缓存

 var cachedModule = Module._cache[filename]; if (cachedModule) { return cachedModule.exports; // 第二步：是否为内置模块

 if (NativeModule.exists(filename)) { return NativeModule.require(filename); } // 第三步：生成模块实例，存入缓存

 var module = new Module(filename, parent);

 Module._cache[filename] = module; // 第四步：加载模块

 try {

 module.load(filename);

 hadException = false; } finally { if (hadException) {

 delete Module._cache[filename]; } } // 第五步：输出模块的exports属性

 return module.exports; }; 

上面代码中，首先解析出模块的绝对路径（filename），以它作为模块的识别符。然后，如果模块已经在缓存中，就从缓存取出；如果不在缓存中，就加载模块。

因此，Module._load 的关键步骤是两个。

Module._resolveFilename = function(request, parent) { // 第一步：如果是内置模块，不含路径返回

 if (NativeModule.exists(request)) { return request; } // 第二步：确定所有可能的路径

 var resolvedModule = Module._resolveLookupPaths(request, parent); var id = resolvedModule[0]; var paths = resolvedModule[1]; // 第三步：确定哪一个路径为真

 var filename = Module._findPath(request, paths); if (!filename) { var err = new Error("Cannot find module " + request + "");

 err.code = MODULE_NOT_FOUND; throw err; } return filename; }; 

上面代码中，在 Module.resolveFilename 方法内部，又调用了两个方法 Module.resolveLookupPaths() 和 Module._findPath() ，前者用来列出可能的路径，后者用来确认哪一个路径为真。

为了简洁起见，这里只给出 Module._resolveLookupPaths() 的运行结果。

 [ /home/ruanyf/tmp/node_modules, /home/ruanyf/node_modules, /home/node_modules, /node_modules /home/ruanyf/.node_modules, /home/ruanyf/.node_libraries，

 $Prefix/lib/node ] 

上面的数组，就是模块所有可能的路径。基本上是，从当前路径开始一级级向上寻找 node_modules 子目录。最后那三个路径，主要是为了历史原因保持兼容，实际上已经很少用了。

有了可能的路径以后，下面就是 Module._findPath() 的源码，用来确定到底哪一个是正确路径。

Module._findPath = function(request, paths) { // 列出所有可能的后缀名：.js，.json, .node

 var exts = Object.keys(Module._extensions); // 如果是绝对路径，就不再搜索

 if (request.charAt(0) === /) {

 paths = []; } // 是否有后缀的目录斜杠

 var trailingSlash = (request.slice(-1) === /); // 第一步：如果当前路径已在缓存中，就直接返回缓存

 var cacheKey = JSON.stringify({request: request, paths: paths}); if (Module._pathCache[cacheKey]) { return Module._pathCache[cacheKey]; } // 第二步：依次遍历所有路径

 for (var i = 0, PL = paths.length; i PL; i++) { var basePath = path.resolve(paths[i], request); var filename; if (!trailingSlash) { // 第三步：是否存在该模块文件

 filename = tryFile(basePath); if (!filename !trailingSlash) { // 第四步：该模块文件加上后缀名，是否存在

 filename = tryExtensions(basePath, exts); } } // 第五步：目录中是否存在 package.json 

 if (!filename) {

 filename = tryPackage(basePath, exts); } if (!filename) { // 第六步：是否存在目录名 + index + 后缀名 

 filename = tryExtensions(path.resolve(basePath, index), exts); } // 第七步：将找到的文件路径存入返回缓存，然后返回

 if (filename) {

 Module._pathCache[cacheKey] = filename; return filename; } } // 第八步：没有找到文件，返回false 

 return false; }; 

经过上面代码，就可以找到模块的绝对路径了。

有时在项目代码中，需要调用模块的绝对路径，那么除了 module.filename ，Node 还提供一个 require.resolve 方法，供外部调用，用于从模块名取到绝对路径。

require.resolve = function(request) { return Module._resolveFilename(request, self); }; 

// 用法

require.resolve(a.js)

// 返回 /home/ruanyf/tmp/a.js

五、加载模块

有了模块的绝对路径，就可以加载该模块了。下面是 module.load 方法的源码。

Module.prototype.load = function(filename) { var extension = path.extname(filename) || .js; if (!Module._extensions[extension]) extension = .js;

 Module._extensions[extension](this, filename);

 this.loaded = true; }; 

上面代码中，首先确定模块的后缀名，不同的后缀名对应不同的加载方法。下面是 .js 和 .json 后缀名对应的处理方法。

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

 module._compile(stripBOM(content), filename); };

Module._extensions[.json] = function(module, filename) { var content = fs.readFileSync(filename, utf8); try {

 module.exports = JSON.parse(stripBOM(content)); } catch (err) {

 err.message = filename + :  + err.message; throw err; } }; 

这里只讨论 js 文件的加载。首先，将模块文件读取成字符串，然后剥离 utf8 编码特有的BOM文件头，最后编译该模块。

module._compile 方法用于模块的编译。

Module.prototype._compile = function(content, filename) { var self = this; var args = [self.exports, require, self, filename, dirname]; return compiledWrapper.apply(self.exports, args); }; 

上面的代码基本等同于下面的形式。

 (function (exports, require, module, __filename, __dirname) { // 模块源码

}); 

也就是说，模块的加载实质上就是，注入exports、require、module三个全局变量，然后执行模块的源码，然后将模块的 exports 变量的值输出。

（完）

手写简易版flexible.js以及源码分析 我们的移动端布局通常会有rem结合媒体查询的实现，但是，淘宝有这样的一个flexible.js框架，根据不同的width给网页中html根节点设置不同的font-size，大大提高了我们的开发效率，今天阿牛便带你手写一个简易版flexible.js并解读，了解他的大致原理。
koa源码阅读[0] koa源码阅读[0] Node.js也是写了两三年的时间了，刚开始学习Node的时候，hello world就是创建一个HttpServer，后来在工作中也是经历过Express、Koa1.x、Koa2.x以及最近还在研究的结合着TypeScript的routing-controllers（驱动依然是Express与Koa）。
阮一峰 阿里技术专家。著名技术博客作者，技术方向为 React + Node，自由软件运动的支持者