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

 更新时间:2014年10月25日 16:35:38   投稿:junjie  
这篇文章主要介绍了Nodejs极简入门教程(一):模块机制,本文讲解了模块基础知识、模块的加载、包等内容,需要的朋友可以参考下

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 命令会将当前目录下的包移除掉。

相关文章

  • 实战node静态文件服务器的示例代码

    实战node静态文件服务器的示例代码

    本篇文章主要介绍了实战node静态文件服务器的示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • Node.js和MongoDB实现简单日志分析系统

    Node.js和MongoDB实现简单日志分析系统

    这篇文章主要介绍了Node.js和MongoDB实现简单日志分析系统,本文给出了服务器端、客户端、图表生成、Shell自动执行等功能的实现代码,需要的朋友可以参考下
    2015-04-04
  • 解决node.js中bcrypt遇到的安装问题

    解决node.js中bcrypt遇到的安装问题

    这篇文章主要介绍了解决node.js中bcrypt遇到的安装问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • package-lock.json解决依赖的版本管理使用详解

    package-lock.json解决依赖的版本管理使用详解

    这篇文章主要为大家介绍了package-lock.json解决依赖的版本管理使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Node.js中的cluster模块深入解读

    Node.js中的cluster模块深入解读

    NodeJS引入了Cluster模块试图简化这些体力劳动,使用Cluster模块可以运行并管理多个实例进程,下面这篇文章主要给大家介绍了关于Node.js中cluster模块的相关资料,需要的朋友可以参考借鉴,下面来一起看看吧
    2018-06-06
  • Node.js中ES6模块化及Promise对象

    Node.js中ES6模块化及Promise对象

    这篇文章主要介绍了Node.js中ES6模块化及Promise对象,node.js 遵循了 CommonJS 的模块化规范,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-07-07
  • VSCode使用npm的详细步骤

    VSCode使用npm的详细步骤

    为了避免造轮子,我们有时候会用到其他人的劳动成果,比如一些优秀的框架,比如Express,我们直接使用NPM下载下来就可以用了,降低开发成本和时间,这篇文章主要给大家介绍了关于VSCode使用npm的详细步骤,需要的朋友可以参考下
    2022-09-09
  • Node.js实现mysql连接池使用事务自动回收连接的方法示例

    Node.js实现mysql连接池使用事务自动回收连接的方法示例

    这篇文章主要介绍了Node.js实现mysql连接池使用事务自动回收连接的方法,结合实例形式分析了node.js操作mysql连接池实现基于事务的连接回收操作相关技巧,需要的朋友可以参考下
    2018-02-02
  • electron原理,以及electron生成可执行文件的方法实例分析

    electron原理,以及electron生成可执行文件的方法实例分析

    这篇文章主要介绍了electron原理,以及electron生成可执行文件的方法,结合实例形式分析了electron原理以及electron生成可执行文件的具体操作步骤、实现方法与相关注意事项,需要的朋友可以参考下
    2023-04-04
  • pm2 部署 node的三种方法示例

    pm2 部署 node的三种方法示例

    本篇文章主要介绍了pm2 部署 node的三种方法示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10

最新评论