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 相关文章推荐
14款NodeJS Web框架推荐
Jul 11 NodeJs
nodejs中的fiber(纤程)库详解
Mar 24 NodeJs
Nodejs从有门道无门菜鸟起飞必看教程
Jul 20 NodeJs
详解nodejs 文本操作模块-fs模块(一)
Dec 22 NodeJs
nodejs6下使用koa2框架实例
May 18 NodeJs
浅谈nodejs中的类定义和继承的套路
Jul 26 NodeJs
ubuntu编译nodejs所需的软件并安装
Sep 12 NodeJs
nodejs结合socket.io实现websocket通信功能的方法
Jan 12 NodeJs
使用nodejs分离html文件里的js和css详解
Apr 12 NodeJs
NodeJs crypto加密制作token的实现代码
Nov 15 NodeJs
nodejs中的异步编程知识点详解
Jan 17 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中通过语义URL防止网站被攻击的方法分享
2011/09/08 PHP
js取得html iframe中的元素和变量值
2014/06/30 Javascript
判断在css加载完毕后执行后续代码示例
2014/09/03 Javascript
javascript实现微信分享
2014/12/23 Javascript
JavaScript获取表单内所有元素值的方法
2015/04/02 Javascript
javascript实现下拉提示选择框
2015/12/29 Javascript
Bootstrap入门书籍之(一)排版
2016/02/17 Javascript
H5基于iScroll实现下拉刷新和上拉加载更多
2017/07/18 Javascript
基于JavaScript实现带数据验证和复选框的表单提交
2017/08/23 Javascript
JS面试题大坑之隐式类型转换实例代码
2018/10/14 Javascript
vue中的v-if和v-show的区别详解
2019/09/01 Javascript
layui禁用侧边导航栏点击事件的解决方法
2019/09/25 Javascript
基于JS实现快速读取TXT文件
2020/08/25 Javascript
解决vue中axios设置超时(超过5分钟)没反应的问题
2020/09/04 Javascript
[38:42]完美世界DOTA2联赛循环赛 Matador vs Forest BO2第二场 11.05
2020/11/05 DOTA
Python数据可视化库seaborn的使用总结
2019/01/15 Python
PIL图像处理模块paste方法简单使用详解
2019/07/17 Python
tensorflow 变长序列存储实例
2020/01/20 Python
python安装后的目录在哪里
2020/06/21 Python
纯CSS绘制漂亮的圆形图案效果
2014/05/07 HTML / CSS
web字体加载方案优化小结
2019/11/29 HTML / CSS
Crucial英睿达法国官网:内存条及SSD固态硬盘升级
2018/07/13 全球购物
英国最大的笔记本电脑直销专家:Laptops Direct
2019/07/20 全球购物
描述JSP和Servlet的区别、共同点、各自应用的范围
2012/10/02 面试题
网上商城创业计划书范文
2014/01/31 职场文书
生物制药专业自我鉴定
2014/02/19 职场文书
中学生运动会口号
2014/06/07 职场文书
卖车协议书范例
2014/09/16 职场文书
2014最新预备党员思想汇报范文:中国梦,我的梦
2014/10/25 职场文书
2014年初中班主任工作总结
2014/11/08 职场文书
2015年七一建党节演讲稿
2015/03/19 职场文书
家长通知书家长意见
2015/06/03 职场文书
本科毕业论文答辩稿
2015/06/23 职场文书
《静夜思》教学反思
2016/02/17 职场文书
电子表的操作介绍说明书
2019/10/28 职场文书
Java org.w3c.dom.Document 类方法引用报错
2021/08/07 Java/Android