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的10个性能优化技巧
Jul 15 NodeJs
Nodejs为什么选择javascript为载体语言
Jan 13 NodeJs
nodejs搭建本地http服务器教程
Mar 13 NodeJs
nodejs学习笔记之路由
Mar 27 NodeJs
NodeJs使用Mysql模块实现事务处理实例
May 31 NodeJs
详解HTTPS 的原理和 NodeJS 的实现
Jul 04 NodeJs
nodejs前端自动化构建环境的搭建
Jul 26 NodeJs
NodeJs项目中关闭ESLint的方法
Aug 09 NodeJs
Nodejs核心模块之net和http的使用详解
Apr 02 NodeJs
使用nodejs分离html文件里的js和css详解
Apr 12 NodeJs
M2实现Nodejs项目自动部署的方法步骤
May 05 NodeJs
NodeJS读取分析Nginx错误日志的方法
May 14 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 随机数的深入理解
2013/06/05 PHP
分享3个php获取日历的函数
2015/09/25 PHP
php抓取网站图片并保存的实现方法
2015/10/29 PHP
php微信公众号开发之秒杀
2018/10/20 PHP
PHP文件打开关闭及读写操作示例解析
2020/08/06 PHP
Javascript 面向对象 继承
2010/05/13 Javascript
JS和函数式语言的三特性
2014/03/05 Javascript
jQuery中关于ScrollableGridPlugin.js(固定表头)插件的使用逐步解析
2014/07/17 Javascript
node.js中的fs.statSync方法使用说明
2014/12/16 Javascript
百度地图api如何使用
2015/08/03 Javascript
浅析jQuery Ajax请求参数和返回数据的处理
2016/02/24 Javascript
JavaScript结合Bootstrap仿微信后台多图文界面管理
2016/07/22 Javascript
jQuery实现的事件绑定功能基本示例
2017/10/11 jQuery
详解如何去除vue项目中的#——History模式
2017/10/13 Javascript
使用Bootstrap和Vue实现用户信息的编辑删除功能
2017/10/25 Javascript
Angular模版驱动表单的使用总结
2018/05/05 Javascript
js键盘事件实现人物的行走
2020/01/17 Javascript
python虚拟环境 virtualenv的简单使用
2020/01/21 Javascript
python从网络读取图片并直接进行处理的方法
2015/05/22 Python
TensorFLow用Saver保存和恢复变量
2018/03/10 Python
python中cPickle类使用方法详解
2018/08/27 Python
Python 中包/模块的 `import` 操作代码
2019/04/22 Python
对Python 简单串口收发GUI界面的实例详解
2019/06/12 Python
python图形界面开发之wxPython树控件使用方法详解
2020/02/24 Python
浅谈SciPy中的optimize.minimize实现受限优化问题
2020/02/29 Python
Python如何使用paramiko模块连接linux
2020/03/18 Python
python3中datetime库,time库以及pandas中的时间函数区别与详解
2020/04/16 Python
matplotlib教程——强大的python作图工具库
2020/10/15 Python
员工薪酬福利制度
2014/01/17 职场文书
超市国庆节促销方案
2014/02/20 职场文书
竞选纪律委员演讲稿
2014/09/13 职场文书
社区好人好事材料
2014/12/26 职场文书
超市主管竞聘书
2015/09/15 职场文书
2019暑假学生安全口号
2019/06/27 职场文书
写作指导:怎么书写竞聘演讲稿?
2019/07/04 职场文书
vue使用watch监听属性变化
2022/04/30 Vue.js