你知道require是什么吗?
引题
用过node的同学应该都知道require是用来加载模块的,那你是否存在如下的疑问呢?
1. require(path)是如何依据path找到对应module呢?
2. 为何在模块定义中,一定要通过module.exports暴漏出接口?module.exports与require存在什么关系
对上述问题进行概括可以抽象出如下两个问题:
1. module的路径分析
2. 文件加载
切入
首先来直观地看看require是什么?
// node环境下执行:
console.log(require.toString) //输入结果为:
'function require(path) {\n return self.require(path);\n }'
上述代码说明require函数仅仅是module.require的封装,这样就需要查看node中的module源代码了。
加载模块的方式
首先来直观来认识一下node的模块加载方式有哪些方式:
case 1:
// 'path'为node的核心模块
var path = require('path')
case2:
// a.js,路径为: basePath/a.js
var myModule = require('./my-module')
// my-module的路径为basePath/node_modules/myModule.js
case 3:
// a.js, 路径: basePath/a.js
var main = require('./')
// basePath下还包括package.json, index.js
路径解析
在node的官方API中,我们可以找到这段描述:
To get the exact filename that will be loaded when require() is called, use the require.resolve() function.
Putting together all of the above, here is the high-level algorithm in pseudocode of what require.resolve does:
......
试试在node环境下用用require.resolve这个API:
require.resolve('./a.js')
// 这样就得到a.js的绝对路径
为了探索缘由,就从node核心代码中的mdoule.js找答案吧:
require.resolve = function(request) {
return Module._resolveFilename(request, self);
}
Module._resolveFilename = function(request, parent) {
// 判断是否为node的核心模块
if (NativeModule.exists(request)) {
return request;
}
// 得到查询路径,格式为数组:[id, [paths]]
var resolvedModule = Module._resolveLookupPaths(request, parent);
var paths = resolvedModule[1];
// 根据path、fileName得到绝对路径
var filename = Module._findPath(request, paths);
return filename;
}
那Module._resolveLookupPaths是如何得到所有查询路径的呢?
- 为node的核心模块,stop
- 以./或../开头,本地查找, stop
- 沿着文件树,得到node_module的所有路径,直到/node_modules,在node_module中查找,stop
- path为目录,则检查package.json文件是否存在main属性,否则默认为index.js
- 最后返回new Error('Cannot find module"' + request + '"');
模块加载
先看require的源代码:
// 我们经常使用的require函数
function require(path) {
return self.require(path);
}
// 调用_load函数,加载所需的模块
Module.prototype.require = function(path) {
return Module._load(path, this);
}
这样模块函数的调用连接到了Module._load函数:
Module.cache = {};
Module._load = function() {
// 检测模块是否已经加载过
var cachedModule = Module._cache[filename];
if (cachedModule) {
return cachedModule.exports;
}
// 模块还未加载,则为模块创建module实例
var module = new Module(filename, parent);
// 新创建的实例存储于cache中
Module._cache[filename] = module;
// 开始获取模块的内容
module.load(filename);
// 对外提供接口
return module.exports;
}
接下来问题的关键就变成了module.load,该方法用于获取module的内容,然后进行解析:
Module.prototype.load = function(filename) {
// 解析出文件的后缀, 存在['.js', '.json', 'node']三种后缀
var extension = path.extname(filename) || '.js';
// 根据后缀,获取相关的模块
Module._extensions[extension](this, filename);
}
node会匹配按照.js、.json、.node三种格式进行模块匹配,根据文件类型的不同采取不同的加载策略,但是以实际开发中以加载.js最多,该种策略最后需要调用Module.prototype._compile进行编译处理:
Module._extensions['.js'] = function(module, filename) {
var content = fs.readFileSync(filename, 'utf8');
module._compile(stripBOM(content), filename);
};
Module.prototype._compile = function(content, filename) {
//将内容放入到(function() { content }),形成闭包,创建私有作用域
var wrapper = Module.wrap(content);
// bind新的执行上下文
var compiledWrapper = runInThisContext(wrapper, { filename: filename });
// 向外暴漏接口:module.exports, require, module,__filename, __dirname,
var args = [self.exports, require, self, filename, dirname];
return compiledWrapper.apply(self.exports, args);
}
这样,我们就可以在require来获取相应地module。
结论
node现在这么火,各种优势铺天盖地涌来,会让刚刚入行的人觉得深不可测,因而往往会让人望而却步。但是只要我们敢于突破第一步,深入下来仔细分析,就会发现其实没有那么晦涩难懂,踏出第一步真的很关键!
参考资料
http://thenodeway.io/posts/get-fancy/how-require-actually-works/
https://github.com/joyent/node/blob/master/lib/module.js
http://nodejs.org/api/modules.html
https://github.com/substack/node-resolve
你知道require是什么吗?的更多相关文章
- WCF : 修复 Security settings for this service require Windows Authentication but it is not enabled for the IIS application that hosts this service 问题
摘要 : 最近遇到了一个奇怪的 WCF 安全配置问题, WCF Service 上面配置了Windows Authentication. IIS上也启用了 Windows Authentication ...
- webpack解惑:require的五种用法
我之前在 <前端搭环境之从入门到放弃>这篇文章中吐槽过,webpack中可以写commonjs格式的require同步语法,可以写AMD格式的require回调语法,还有一个require ...
- express全局安装后无法通过require使用
今天入门了一下express,首先安装依赖. npm install express -g; npm install body-parser -g; npm install cookie-parser ...
- require() 源码解读
2009年,Node.js 项目诞生,所有模块一律为 CommonJS 格式. 时至今日,Node.js 的模块仓库 npmjs.com ,已经存放了15万个模块,其中绝大部分都是 CommonJS ...
- 项目开发(Require + E.js)
最近在做的几个项目,分别用了不同的框架跟方式,有个H5的项目,用了vue框架, 这个项目我还没有正式加入进去, 等手头的这个项目完成就可以去搞vue了, 现在手头的这个项目是一个招聘的项目, 用到了N ...
- Javascript模块化编程(三):require.js的用法
Javascript模块化编程(三):require.js的用法 原文地址:http://www.ruanyifeng.com/blog/2012/11/require_js.html 作者: 阮一峰 ...
- Torch Problems: require some packages doesn't work
I've recently got a problem. require 'cutorch' doesn't work. But it was ok yesterday, although I hav ...
- javascript模块化编程(三):require.js用法
本文来自阮一峰 这个系列的第一部分和第二部分,介绍了Javascript模块原型和理论概念,今天介绍如何将它们用于实战. 我采用的是一个非常流行的库require.js. 一.为什么要用require ...
- PHP中include()与require()的区别说明
require 的使用方法如 require("MyRequireFile.php"); .这个函数通常放在 PHP 程序的最前面,PHP 程序在执行前,就会先读入 require ...
- CCLuaLoadChunksFromZIP加载后的require路径问题
对于require来说,在LUA中的机制就是搜索path路径了.但对于CCLuaLoadChunksFromZIP加载的LUA文件来说,require的路径又是怎么样的呢? 我在服务器上有一个 oox ...
随机推荐
- EF实体框架之CodeFirst三
前两篇博客学习了数据库映射和表映射,今天学习下数据库初始化.种子数据.EF执行sql以及执行存储过程这几个知识. 一.数据库初始化策略 数据库初始化有4种策略 策略一:数据库不存在时重新创建数据库 D ...
- MVC采用HtmlHelper扩展和Filter封装验证码的功能
最近因为有个项目除了登录还有其他很多地方需要用到验证码的功能,所以想到了采用HtmlHelper和ActionFilter封装一个验证码的功能,以便能够重复调用.封装好以后调用很方便,只需在View中 ...
- Android开发的那些坑和小技巧
1.android:clipToPadding 意思是控件的绘制区域是否在padding里面.默认为true.如果你设置了此属性值为false,就能实现一个在布局上事半功陪的效果.先看一个效果图. 上 ...
- [codevs3223]素数密度(筛)
题目:http://codevs.cn/problem/3223/ 分析: 可以算出来最大质因子最大不超过50000,因为如果超过50000,那么平方就超过maxlongint了.所以可以筛出5000 ...
- metaspolit 基础
在kali中使用metasploit,需要先开启PostgreSQL数据库服务和metasploit服务,然后就可以完整的利用msf数据库查询exploit和记录了.这一点比bt5要方便很多,所以现在 ...
- MyEclipse 8.5配置Tomcat 7.0
MyEclipse 8.5配置Tomcat 7.0 在窗口(Windows)->首选项(Prefrences)->MyEclipse->Servers->Tomcat 6.x下 ...
- 【BZOJ 3143】【Hnoi2013】游走 期望+高斯消元
如果纯模拟,就会死循环,而随着循环每个点的期望会逼近一个值,高斯消元就通过列方正组求出这个值. #include<cstdio> #include<cctype> #inclu ...
- JS模式:又一个简单的工厂模式
<!DOCTYPE html> <html> <head> <title></title> </head> <body&g ...
- struts2面试题汇总
一.工作原理 一个请求在Struts2框架中的处理大概分为以下几个步骤 1 客户端初始化一个指向Servlet容器(例如Tomcat)的请求 2 这个请求经过一系列的过滤器(Filter)(这些过滤器 ...
- c#截图
private void Form_Load(object sender, EventArgs e){ //接收web url string colle = string.Empty; stri ...