Node.js 的模块知识汇总
在写Node.js应用程序的时候,你确实可以把所有代码放在巨大原index.js文件中,不在乎你的应用程序会变得多大多复杂。Node.js解释器不会在意这个事情。但在代码组织方面,你很快就会陷入混乱,不能理解代码,而且难以调试。所以,作为一个人,你应该关心代码的结构。这就是使用模块的原因。
你可以把Node.js模块当作JavaScript库——是整体代码中你想放在一起的某个部分(比如,函数集),你会想把这部分代码相对独立于代码库中的其它部分,可以把事情区分清楚。
就们我们把袜子放在衣柜一个抽屉,把衬衣放在衣柜的另一个抽屉——我们可以把它们组成一天的着装——在代码库中,我们将不同的部分保存在不同的模块中,然后将它们有条不紊地合并成一个应用程序。
内建模块
即使我们不创造任何Node.js模块,也有模块可用,因为Node.js环境提供了内建模块。我们已经遇到过一个模块,就是在博客中寻找如何使用内建的SHATWGURL解析器的时候。
在我们自己的代码文件中,我们需要使用已经存在但是在别处声明的代码——这种情况下,URL类是Node.js内置模块url中的一部分。
varURL=require('url').URL;
require('url')让我们可以访问url模块。这个模块定义在哪里,是怎么定义的,对我们来说完全不透明——我们所需要知道的只是它的名称——url——以及它公开的属性,比如URL。
其它内建的模块直接导出我们需要的属性(通常是JavaScript对象)。以http模块为例:
varhttp=require('http'); http.createServer(function(req,res){ res.writeHead(200,{'Content-Type':'text/html'}); res.end('HelloWorld!'); }).listen(8080);
这里,请求http模块让我们可以直接访问http对象,我们可以直接使用其方法,比如createServer。
Node初学者这本书讲述了如何使用Node.js写一个完整的Web服务器,它就是使用的内建http模块。
外部模块
内建模块随Node.js发布,它可以解决很多开发问题,而不需要为每个应用发明新的轮子,但是真正促进Node.js编程能力的是由来自Node.js社区的开源模块构建起来的庞大生态系统。这些模块也可以集成到我们的代码库中,但是由于它们不是内置的,并且不会随每次安装Node.js一起安装,所以只在是我们的代码中require是不够的。我们需要先安装包含外部模块的代码库,由于NPM,NodePackageManager(Node包管理器)的存在,这很容易。
请参博客文章,它以如何使用async库为例来介绍如何使用外部模块。
此外,Node工匠书还使用了一个章节来介绍了使用NPM的细节。
创建你自己的模块
内建模块和外部模块都是别人提供的,但它们不会妨碍你创建自己的Node.js模块。
下面的例子创建了一个名为myRandom的模块,它会提供了一个辅助函数,用于返回0到10之间的数。
文件myRandom.js:
functiongetRandom(min,max){ returnMath.random()*(max-min)+min; } exports.between1and10=function(){ returngetRandom(1,10); };
你应该把代码放在自己的myRandom.js文件中。由于此文件存在,并通过exports向外提供属性,另一个文件index.js可以使用导出的功能:
文件index.js:
varmyRandom=require('./myRandom.js'); console.log(myRandom.between1and10());
require再次发挥作用,它让本地myRandom模块中导出的属性生效——在这里是指between1and10函数。
注意:虽然模块系统允许公开模块的功能,但它也允许隐藏在模块之外不会用到的功能,只要不通过exports导出就好。即使index.js文件请求了myRandom.js文件,它也不能访问未导出的getRandom函数:
varmyRandom=require('./myRandom.js'); console.log(myRandom.getRandom(5,99));
这会导致TypeError:myRandom.getRandomisnotafunction.
通过将实现细节隐藏在模块中,只暴露出需要在其它代码中使用的部分,可以很好的组织你的代码。