阮一峰:require() 源码解读

当 Node 遇到 require(X) 时，按下面的顺序处理。 （1）如果 X 是内置模块（比如 require(‘http’）) a. 返回该模块。 b. 不再继续执行。 （2）如果 X 以 “./” 或者 “/” 或者 “../” 开头 a. 根据 X 所在的父模块，确定 X 的绝对路径。 b. 将 X 当成文件，依次查找下面文件，只要其中有一个存在，就返回该文件，不再继续执行。

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

（3）如果 X 不带路径 a. 根据 X 所在的父模块，确定 X 可能的安装目录。 b. 依次在每个目录中，将 X 当成文件名或目录名加载。 （4） 抛出 “not found”

 /home/ry/projects/node_modules/bar /home/ry/node_modules/bar /home/node_modules/bar /node_modules/bar 

 bar bar.js bar.json bar.node 

 bar/package.json（main字段） bar/index.js bar/index.json bar/index.node 

 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); 

 // 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' ] 

 // b.js  var a = require('./a.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' ] 

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

 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; }; 

• Module._resolveFilename() ：确定模块的绝对路径
• 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; }; 

 [   '/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' ]  

 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; }; 

 require.resolve = function(request) {   return Module._resolveFilename(request, self); };  // 用法 require.resolve('a.js') // 返回 /home/ruanyf/tmp/a.js 

 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; }; 

 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;   } }; 

 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) {   // 模块源码 });