Node.js 的模块知识汇总


Posted in Javascript onAugust 16, 2017

在写 Node.js 应用程序的时候,你确实可以把所有代码放在巨大原 index.js 文件中,不在乎你的应用程序会变得多大多复杂。Node.js 解释器不会在意这个事情。但在代码组织方面,你很快就会陷入混乱,不能理解代码,而且难以调试。所以,作为一个人,你应该关心代码的结构。这就是使用模块的原因。

你可以把 Node.js 模块当作 JavaScript 库 —— 是整体代码中你想放在一起的某个部分(比如,函数集),你会想把这部分代码相对独立于代码库中的其它部分,可以把事情区分清楚。

就们我们把袜子放在衣柜一个抽屉,把衬衣放在衣柜的另一个抽屉 —— 我们可以把它们组成一天的着装 ——在代码库中,我们将不同的部分保存在不同的模块中,然后将它们有条不紊地合并成一个应用程序。

内建模块

即使我们不创造任何 Node.js 模块,也有模块可用,因为 Node.js 环境提供了内建模块。我们已经遇到过一个模块,就是在博客中寻找如何使用内建的 SHATWG URL 解析器的时候。

在我们自己的代码文件中,我们需要使用已经存在但是在别处声明的代码 —— 这种情况下,URL类是 Node.js 内置模块url中的一部分。

var URL = require('url').URL;

require('url')让我们可以访问url模块。这个模块定义在哪里,是怎么定义的,对我们来说完全不透明 —— 我们所需要知道的只是它的名称 ——url—— 以及它公开的属性,比如URL。

其它内建的模块直接导出我们需要的属性(通常是 JavaScript 对象)。以http模块为例:

var http = require('http');

http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/html'});
  res.end('Hello World!');
}).listen(8080);

这里,请求http模块让我们可以直接访问http对象,我们可以直接使用其方法,比如createServer。

Node 初学者这本书讲述了如何使用 Node.js 写一个完整的 Web 服务器,它就是使用的内建http模块。

外部模块

内建模块随 Node.js 发布,它可以解决很多开发问题,而不需要为每个应用发明新的轮子,但是真正促进 Node.js 编程能力的是由来自 Node.js 社区的开源模块构建起来的庞大生态系统。这些模块也可以集成到我们的代码库中,但是由于它们不是内置的,并且不会随每次安装Node.js 一起安装,所以只在是我们的代码中require是不够的。我们需要先安装包含外部模块的代码库,由于 NPM,Node Package Manager(Node 包管理器) 的存在,这很容易。

请参博客文章,它以如何使用 async 库为例来介绍如何使用外部模块。

此外,Node工匠书还使用了一个章节来介绍了使用 NPM 的细节。

创建你自己的模块

内建模块和外部模块都是别人提供的,但它们不会妨碍你创建自己的 Node.js 模块。

下面的例子创建了一个名为myRandom的模块,它会提供了一个辅助函数,用于返回 0 到 10 之间的数。

文件myRandom.js:

function getRandom(min, max) {
   return Math.random() * (max - min) + min;
}

exports.between1and10 = function() {
   return getRandom(1, 10);
};

你应该把代码放在自己的myRandom.js文件中。由于此文件存在,并通过exports向外提供属性,另一个文件index.js可以使用导出的功能:

文件index.js:

var myRandom = require('./myRandom.js');

console.log(myRandom.between1and10());

require再次发挥作用,它让本地myRandom模块中导出的属性生效 —— 在这里是指between1and10函数。

注意:虽然模块系统允许公开模块的功能,但它也允许隐藏在模块之外不会用到的功能,只要不通过exports导出就好。即使index.js文件请求了myRandom.js文件,它也不能访问未导出的getRandom函数:

var myRandom = require('./myRandom.js');

console.log(myRandom.getRandom(5, 99));

这会导致 TypeError: myRandom.getRandom is not a function.

通过将实现细节隐藏在模块中,只暴露出需要在其它代码中使用的部分,可以很好的组织你的代码。

Javascript 相关文章推荐
遍历jquery对象的代码分享
Nov 02 Javascript
JS中的public和private对象,即static修饰符
Jan 18 Javascript
JS实现下拉框的动态添加(附效果)
Apr 03 Javascript
使用js声明数组,对象在jsp页面中(获得ajax得到json数据)
Nov 05 Javascript
js如何设置在iframe框架中指定div不显示
Dec 04 Javascript
JS 拼凑字符串的简单实例
Sep 02 Javascript
Vue 实用分页paging实例代码
Apr 12 Javascript
微信小程序导航栏滑动定位功能示例(实现CSS3的positionsticky效果)
Jan 24 Javascript
layer实现登录弹框,登录成功后关闭弹框并调用父窗口的例子
Sep 11 Javascript
vue-cli3单页构建大型项目方案
Apr 07 Javascript
Vue如何基于vue-i18n实现多国语言兼容
Jul 17 Javascript
在vue中created、mounted等方法使用小结
Jul 21 Javascript
vue绑定设置属性的多种方式(5)
Aug 16 #Javascript
jQuery中each循环的跳出和结束实例
Aug 16 #jQuery
随机生成10个不重复的0-100的数字(实例讲解)
Aug 16 #Javascript
vue动态路由实现多级嵌套面包屑的思路与方法
Aug 16 #Javascript
基于js 本地存储(详解)
Aug 16 #Javascript
基于Vue实例生命周期(全面解析)
Aug 16 #Javascript
基于JQuery的Ajax方法使用详解
Aug 16 #jQuery
You might like
用PHP 4.2书写安全的脚本
2006/10/09 PHP
如何把PHP转成EXE文件
2006/10/09 PHP
php 空格,换行,跳格使用说明
2009/12/18 PHP
php模拟js函数unescape的函数代码
2012/10/20 PHP
php 无法加载mcrypt.dll的解决办法
2013/04/03 PHP
PHP文件去掉PHP注释空格的函数分析(PHP代码压缩)
2013/07/02 PHP
PHP中error_reporting()用法详解
2015/08/31 PHP
php设置页面超时时间解决方法
2015/09/22 PHP
php之可变函数的实例详解
2017/09/13 PHP
jquery 事件对象属性小结
2010/04/27 Javascript
基于Jquery的实现回车键Enter切换焦点
2010/09/14 Javascript
javascript 禁用IE工具栏,导航栏等等实现代码
2013/04/01 Javascript
jQuery中iframe的操作(点击按钮新增窗口)
2016/04/20 Javascript
js+html5实现canvas绘制网页时钟的方法
2016/05/21 Javascript
详解浏览器渲染页面过程
2017/02/09 Javascript
JS实现的四级密码强度检测功能示例
2017/05/11 Javascript
webpack4.0打包优化策略整理小结
2018/03/30 Javascript
vue+echarts实现动态绘制图表及异步加载数据的方法
2018/10/17 Javascript
vue-iview动态新增和删除的方法
2020/06/17 Javascript
[00:52]黑暗之门更新 新英雄孽主驾临DOTA2
2016/08/24 DOTA
python去掉字符串中重复字符的方法
2014/02/27 Python
Python求解平方根的方法
2015/03/11 Python
对python添加模块路径的三种方法总结
2018/10/16 Python
python 处理微信对账单数据的实例代码
2019/07/19 Python
Pytorch maxpool的ceil_mode用法
2020/02/18 Python
解决pyPdf和pyPdf2在合并pdf时出现异常的问题
2020/04/03 Python
python FTP编程基础入门
2021/02/27 Python
css3中transition属性详解
2014/09/02 HTML / CSS
德国古洛迷亚百货官网:GALERIA Kaufhof
2017/06/20 全球购物
机电专业毕业生求职信
2014/07/01 职场文书
忠诚教育心得体会
2014/09/03 职场文书
领导干部“四风”问题批评与自我批评材料
2014/09/24 职场文书
2014年助理工程师工作总结
2014/11/14 职场文书
高考升学宴答谢词
2015/01/20 职场文书
Python基础之赋值,浅拷贝,深拷贝的区别
2021/04/30 Python
Redis模仿手机验证码发送的实现示例
2021/11/02 Redis