Nodejs极简入门教程(一):模块机制


Posted in NodeJs onOctober 25, 2014

JavaScript 规范(ECMAScript)没有定义一套完善的能适用于大多数程序的标准库。CommonJS 提供了一套 JavaScript 标准库规范。Node 实现了 CommonJS 规范。

模块基础

在 Node 中,模块和文件是一一对应的。我们定义一个模块:

// circle.js

var PI = Math.PI;

 

// 导出函数 area

exports.area = function(r) {

    return PI * r * r;

}

 

// 导出函数 circumference

exports.circumference = function(r) {

    return 2 * PI * r;

};

这里将需要导出的函数加入到 exports 对象。模块的局部变量外部无法访问(例如,上例中的 PI 变量)。调用 require 载入模块 circle.js:
var circle = require('./circle.js');

console.log('The area of a circle of radius 4 is '

           + circle.area(4));

附带提及一下的是,模块中,存在一个 module 对象,表示模块本身,exports 则为 module 的属性。

模块的加载

Node 会对加载过的模块进行缓冲,避免再次加载的开销:

// test.js

console.log("I'm here");

多次加载模块 test.js

// 仅仅输出一次 "I'm here"

require('./test');

require('./test');

当加载文件没有后缀时,Node 会尝试添加后缀并加载:

1..js(JavaScript 源文件)
2..node(C/C++ 扩展模块)
3..json(JSON 文件)

模块主要有几类:

1.核心模块。核心模块已经被编译到了 Node 中,我们在其源码中的 lib 目录可以找到这些核心模块。常见的核心模块:net、http、fs 模块等

2.文件模块。文件模块通过一个相对或者绝对路径加载,例如我们上面看到的 circle.js

3.自定义模块。自定义模块位于 node_modules 目录中,我们通过 npm 安装的各种模块就放置在 node_modules 目录中

核心模块总是优先被加载,假如有一个自定义模块 http,那么加载时仍然会加载核心模块 http 而非自定义模块 http。在加载自定义模块时,首先查找当前目录下的 node_modules 目录,而后查找父目录下的 node_modules 目录,以此类推,直到根目录。

require 加载的模块不是一个文件,而是一个目录时,这样的目录被叫做包(package)。包中存在一个名为 package.json 的文件(包描述文件),例如:

{ "name" : "some-library",

  "main" : "./lib/some-library.js" }

其中 main 指出需要被加载的模块。如果包中不存在 package.json 或者 package.json 中未指定 main 模块,那么 Node 将会尝试加载 index.js、index.node、index.json。

在加载 JavaScript 模块时,被加载的模块被包裹在一个函数中:

function(module, exports, __filename, __dirname, ...) {

    JavaScript module

}

每个 JavaScript 模块访问到的 module、exports、__filename、__dirname 等实际上是通过函数参数传递进来的。由于这种包裹,才使得模块的局部变量外部无法访问。但有时候也会出现让人难以理解的问题,例如:

test1.js

exports = {

    name: 'Name5566',

}

test2.js

module.exports = {

    name: 'Name5566',

}

加载这两个模块:

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

console.log(test1.name); // undefined

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

console.log(test2.name); // Name5566

exports 作为参数传递给模块,我们通过 exports.x 自然可以给 exports 对象添加属性(或方法),但直接给 exports 赋值(例如,exports = x)仅仅是改变了形参而非实参的值,因此:

1.为 exports 添加属性时,使用 exports
2.为 exports 赋值时,使用 module.exports

按 CommonJS 的规范,一个完整的包应该包含有:

1.package.json 包描述文件
2.bin 二进制文件目录
3.lib JavaScript 代码目录
4.doc 文档目录
5.test 测试代码目录

NPM 是一个 Node 的一个包管理工具。常见用法:

查看命令的文档:

npm help install

查看命令 install 的文档。

安装一个包:

npm install redis

安装 redis 这个包。install 命令会将包安装在当前目录下的 node_modules 目录中。

移除一个包:

npm remove redis

移除 redis 这个包。remove 命令会将当前目录下的包移除掉。
NodeJs 相关文章推荐
Nodejs中的this详解
Mar 26 NodeJs
详解Nodejs的timers模块
Dec 22 NodeJs
利用nodejs监控文件变化并使用sftp上传到服务器
Feb 18 NodeJs
nodejs中全局变量的实例解析
Mar 07 NodeJs
详解nodejs微信公众号开发——5.素材管理接口
Apr 11 NodeJs
nodejs socket实现的服务端和客户端功能示例
Jun 02 NodeJs
nodejs之get/post请求的几种方式小结
Jul 26 NodeJs
Nodejs调用WebService的示例代码
Sep 29 NodeJs
NodeJs项目中关闭ESLint的方法
Aug 09 NodeJs
NodeJS实现同步的方法
Mar 02 NodeJs
NodeJS 文件夹拷贝以及删除功能
Sep 03 NodeJs
nodejs处理tcp连接的核心流程
Feb 26 NodeJs
基于NodeJS的前后端分离的思考与实践(六)Nginx + Node.js + Java 的软件栈部署实践
Sep 26 #NodeJs
基于NodeJS的前后端分离的思考与实践(五)多终端适配
Sep 26 #NodeJs
基于NodeJS的前后端分离的思考与实践(四)安全问题解决方案
Sep 26 #NodeJs
基于NodeJS的前后端分离的思考与实践(三)轻量级的接口配置建模框架
Sep 26 #NodeJs
基于NodeJS的前后端分离的思考与实践(二)模版探索
Sep 26 #NodeJs
基于NodeJS的前后端分离的思考与实践(一)全栈式开发
Sep 26 #NodeJs
Nodejs Post请求报socket hang up错误的解决办法
Sep 25 #NodeJs
You might like
php中文字符截取防乱码
2008/03/28 PHP
Laravel框架Eloquent ORM修改数据操作示例
2019/12/03 PHP
PHP常量及变量区别原理详解
2020/08/14 PHP
图片完美缩放
2006/09/07 Javascript
javascript document.images实例
2008/05/27 Javascript
跨浏览器开发经验总结(三)   警惕“IE依赖综合症”
2010/05/13 Javascript
javascript权威指南 学习笔记之null和undefined
2011/09/25 Javascript
非常有用的40款jQuery 插件推荐(系列二)
2011/12/25 Javascript
基于jQuery.Validate验证库知识点的详解
2013/04/26 Javascript
jquery实现submit提交表单
2015/02/03 Javascript
js实现使用鼠标拖拽切换图片的方法
2015/05/04 Javascript
jquery 获取select数组与name数组长度的实现代码
2016/06/20 Javascript
Ionic2系列之使用DeepLinker实现指定页面URL
2016/11/21 Javascript
Javascript设计模式之装饰者模式详解篇
2017/01/17 Javascript
JavaScript纯色二维码变成彩色二维码
2020/07/23 Javascript
用vue封装插件并发布到npm的方法步骤
2017/10/18 Javascript
Layui数据表格之获取表格中所有的数据方法
2018/08/20 Javascript
解决jQuery使用append添加的元素事件无效的问题
2018/08/30 jQuery
为jquery的ajax请求添加超时timeout时间的操作方法
2018/09/04 jQuery
[49:28]VP vs Optic 2018国际邀请赛小组赛BO2 第二场 8.16
2018/08/17 DOTA
简单介绍Python下自己编写web框架的一些要点
2015/04/29 Python
python比较2个xml内容的方法
2015/05/11 Python
最大K个数问题的Python版解法总结
2016/06/16 Python
python 实现仿微信聊天时间格式化显示的代码
2020/04/17 Python
Python定义一个Actor任务
2020/07/29 Python
如何将anaconda安装配置的mmdetection环境离线拷贝到另一台电脑
2020/10/15 Python
python爬取天气数据的实例详解
2020/11/20 Python
python动态规划算法实例详解
2020/11/22 Python
如何打开WebSphere远程debug
2014/10/10 面试题
linux面试题参考答案(11)
2016/11/26 面试题
2014年最新大专生职业生涯规划书范文
2014/09/13 职场文书
2014年为民办实事工作总结
2014/12/20 职场文书
大学辅导员述职报告
2015/01/10 职场文书
写给领导的感谢信
2015/01/22 职场文书
大学升旗仪式主持词
2015/07/04 职场文书
人生感悟经典句子
2019/08/20 职场文书