Node.js 模块加载机制 Require()-阿里云开发者社区

开发者社区> 沉默术士> 正文

Node.js 模块加载机制 Require()

简介:
+关注继续查看

require()

不要把这里的Require()和RequireJS混为一谈。不过有意思的是,Typescript的模块定义,甚至同时支持这两种模块机制。

导入和使用外部模块,只是简单的一句require(),看看angular/material/docs下的编译文件gulpfile.js的代码片段。对模块导入和使用有个直观的感觉。

var gulp = require('gulp');
var concat = require('gulp-concat');
var fs = require('fs');

... 

//对模块gulp的使用
gulp.task('demos', function() { ...  

//对模块gulp-concat的使用
gulp.src([
    'node_modules/angularytics/dist/angularytics.js',
    'dist/docs/js/**/*.js'
  ])
    .pipe(concat('docs.js'))

//对模块fs的使用
fs.writeFileSync(dest + '/demo-data.js', file);

gulp.task 用于定义了一个任务;cancat用于合并文件;fs是一个对磁盘文件操作的模块。可以看出,有模块的引入,代码更为清晰而明确,这些常用模块相当于对基本语言功能的扩展。

这里,关键词require()把一切联系在一起。那么这句简单的语句背后发生了什么事情呢?

require其实不是一个语言的关键词,在文章后面的研究,我们就可以看到。
还没有使用过require()或者对它实现机制不感兴趣的开发人员,可以略个这一部分。确实,后面实现机制不太影响使用。
以下大部分内容都来自原文: How require() Actually Works

因为NodeJS是开源的,我们可以追溯require()到node的核心代码中去。但是,我们找到的不是一个简单的函数,而是一个文件module.js。这个文件实现了node的整个模块加载系统。涵盖的过程有加载、编译和缓存。而我们使用的require()只是其冰上一角。

module.js

function Module(id, parent) {
    this.id = id;
    this.exports = {};
    this.parent = parent;
    //...

我们可以看到module.js首先定义了一个类型(函数)Module。这个类型有两个功能。一个,它是所有模块的基类,之后每个模块都是这个Module的一个实例。这也是我们前面探讨的module.exports最终来源。 这个Module的第二个功能就是完成Node模块的加载过程。我们使用的require()最终就是调用module.require方法,而这个方法又调用了另外一个内部方法Module._load。最终的这个load方法才是真正加载模块文件的地方,也就是我么将要分析研究的。

Module._load

Module._load = function(request, parent, isMain) {
    //1. Check Module._cache for the cached module.
    //2. Create a new module instance if cache empty
    //3. Save it to the cache
    //4. Call module.load() with your the given filename, this will call module.compile() after reading the file contents.
    //5. If there was error loading /parsing the file, delete the bad module from cache.
    //6. return module.exports
};

Module._load负责装载新模块和管理模块的缓存。缓存机制在每个模块载入时减少重复读取文件,从而提高系统性能。另外,共享模块实例还可以使得单例模块在整个项目中保留状态。 如果在缓存中没有找到该模块,Module._load就会为该文件创建一个新的Module实例。并用该实例读取文件内容,然后发送给Module._compile。 注意到在上面第6步,返回了module.exports。这个返回语句可以解释,为什么在你的模块文件中要把公开的接口(方法)赋给module.exports(或者别名exports);这也解释了,require()返回的变量,可以直接调用导入模块的方法。到此,可以看到没有任何神奇或特别的地方。

module._compile

Module.prototype._compile = function(content, filename) {
    // 1. Create the standalone require function that calls module require.
    // 2. Attach other helper methods to require.
    // 3. Wraps the JS code in a function that provides require, module, etc. variables locally to the module scope.
    // 4. Run that function.

这个方法,一开始就创建require函数,这就是我们非常熟悉的那个require()(模块装载机制不仅仅有载入模块的处理,也有导入和调用的流程,这里可以看作调用方的流程,如我们提到的main.js)。而这个个函数本身只是简单的封装了Module.require和添加了一些帮助属性和方法,如下:

  • require() 就是我们使用的require()
  • require.main 主模块
  • require.cache 所有缓存的模块
  • require.extensions 不同文件类型(后缀)的编译方法

在构建require之后,所有原文件的代码被封装的一个新函数中,这个函数把require,module,exports作为参数。 这也可以解释为什么我们可以直接调用require(),为什么exports是module.exports的别名。

(function(exports,require, module, __filename, __dirname){
    //原模块文件的所有代码注入在这
});
了解模块
模```  
式(Module Pattern)的人,很容易看出这段看时毫无意义的重新分帐,就是模块模式,就是为了防止模块文件中的定义污染系统的命名空间(记住javascript时全局变量)。 最后,这个新创建的函数直接被运行,这其实也是完整模块模式的一部分,最后那对空括弧就是运行部分:

(function(...){

//...

})();

如果不熟悉模块模式(Module Patter),可以看看我另外一篇文章深入探索AngularJS的一个章节《模块模式 - Module Pattern》


小结

至此,我们就走完了模块加载的全部流程。从创建模块module.exports到调用require,以及调用实现的内部过程。虽然这些对你代码还没有任何影响,原来该怎么做还怎么做。但是,可以让你写同样代码时,心里更有底,不再强行记忆模块的语法。最重要的事通过学习良好的代购架构,提高自己的架构水平。
文章转载自 开源中国社区 [http://www.oschina.net]

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
9482 0
未能从程序集“System.ServiceModel”中加载类型“System.ServiceModel.Activation.HttpModule”。
作者:jiankunking 出处:http://blog.csdn.net/jiankunking 在Windows Server 2008中的IIS服务器中部署WCF服务程序时,通过浏览器访问报出如下错误: “/TestService”应用程序中的服务器错误。 未能从程序集“System.ServiceModel, Version=3.0.0.0, Culture=neutral, P
1548 0
Resx 文件无效,未能加载 .RESX 文件中使用的类型
错误信息提示: 错误 339 Resx 文件无效。未能加载 .RESX 文件中使用的类型 Forms.ListItems, Forms, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null。请确保已在项目中添加了必需的引用。 第 136 行,位置 5。 E:\Forms\Form2.resx 136 5 Forms <?
2713 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
10841 0
Firmware 加载原理分析【转】
转自:http://blog.csdn.net/dxdxsmy/article/details/8669840   [-] 原理分析 实现机制 总结   前言                     前段时间移植 wifi 驱动到 Android 的内核上,发现 firmware 的加载始终出错,问了几个人,都不是很了解,没办法,只好自己研究一下。
895 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
13166 0
+关注
5518
文章
253
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载