Node.js基础之require、exports、module构建模块的基本属性详细介绍

SteveRocket
45 阅读10分钟

更多技术信息请关注公众号：CTO Plus，获取更多。

图片.png 原文：Node.js基础之require、exports、module构建模块的基本属性详细介绍

图片本篇文章将详细介绍有关Node.js的基本概念和使用方法，包括以下知识点：

  • Node.js的模块的使用（require、exports、module）、初始化、主模块以及二进制模块的详细介绍。
  • Node.js是一个JS脚本解析器，任何操作系统下安装Node.js本质上做的事情都是把Node.js执行程序复制到一个目录，然后保证这个目录在系统PATH环境变量下，以便终端下可以使用node命令。
  • 终端下直接输入node命令可进入命令交互模式，很适合用来测试一些JS代码片段，比如正则表达式。
  • Node.js使用CMD模块系统，主模块作为程序入口点，所有模块在执行过程中只初始化一次。
  • 除非JS模块不能满足需求，否则不要轻易使用二进制模块。

Node.js

Node.js 是一个基于Chrome V8 引擎的 JavaScript 运行环境，它可以使 JavaScript 运行在服务器端。Node.js 提供了事件驱动、非阻塞 I/O 模型，使得它非常适合构建高并发的网络应用程序。

JS是脚本语言，脚本语言都需要一个解析器才能运行。对于写在HTML页面里的JS，浏览器充当了解析器的角色。而对于需要独立运行的JS，Node.js就是一个解析器。

每一种解析器都是一个运行环境，不但允许JS定义各种数据结构，进行各种计算，还允许JS使用运行环境提供的内置对象和方法做一些事情。例如运行在浏览器中的JS的用途是操作DOM，浏览器就提供了document之类的内置对象。而运行在Node.js中的JS的用途是操作磁盘文件或搭建HTTP服务器，Node.js就相应提供了fs、http等内置对象。

Node.js的用处

Node.js 可以用于构建各种类型的应用程序，例如 Web 应用程序、命令行工具、网络服务器等。Node.js 的非阻塞 I/O 模型使得它非常适合构建高并发的网络应用程序，例如聊天室、实时通讯应用程序等。

Node.js 还有一个重要的应用场景是构建工具和自动化任务。例如，我们可以使用 Node.js 构建自动化构建工具，例如 Grunt 和 Gulp，来自动化执行各种任务，例如编译代码、压缩文件、合并文件等。

模块

编写稍大一点的程序时一般都会将代码模块化。在Node.js中，一般将代码合理拆分到不同的JS文件中，每一个文件就是一个模块，而文件路径就是模块名。

在编写每个模块时，都有require、exports、module三个预先定义好的变量可供使用。在 Node.js 中，require、exports 和 module 是三个非常重要的模块化机制。它们共同构成了Node.js 模块化的基础，是 Node.js 与其他 JavaScript 环境最大的不同之处。

require

require 函数用于加载模块。它接受一个模块路径作为参数，返回该模块的导出对象。模块路径可以是相对路径或绝对路径，也可以是一个模块名。

const myModule = require('./my-module');

在上面的例子中，require 函数加载了一个名为 my-module 的模块，并将其导出对象赋值给了 myModule 变量。在模块中，我们可以通过 module.exports 或 exports 对象来定义模块的导出对象。

require函数用于在当前模块中加载和使用别的模块，传入一个模块名，返回一个模块导出对象。模块名可使用相对路径（以./开头），或者是绝对路径（以/或C:之类的盘符开头）。另外，模块名中的.js扩展名可以省略。以下是一个例子。

var steverocket = require('./config');
console.log(steverocket);

var steverocket2 = require('./config.js');
console.log(steverocket2);

var steverocket3= require('D:\\source_code\\practice_fronted\\Node.js\\practice_code\\config');
console.log(steverocket3);

var steverocket4= require('D:\\source_code\\practice_fronted\\Node.js\\practice_code\\config.js');
console.log(steverocket4);

// steverocket1至steverocket4中保存的是同一个模块的导出对象。

另外，可以使用以下方式加载和使用一个JSON文件。

var data = require('./config.json')

console.log(data);

输出结果

图片

exports

exports 对象是module.exports 的一个引用。它是一个空对象，可以通过添加属性或方法来定义模块的导出对象。

exports.myFunction = function() {

    console.log('Hello, world!');

};

在上面的例子中，我们通过 exports 对象定义了一个名为 myFunction 的函数，并将其作为模块的导出对象。注意，我们不能直接将一个对象赋值给 exports，因为这样会断开 exports 与 module.exports 的引用关系，从而导致模块无法正确导出。

exports对象是当前模块的导出对象，用于导出模块公有方法和属性。别的模块通过require函数使用当前模块时得到的就是当前模块的exports对象。以下例子中导出了一个公有方法。

exports_use.js

exports.sayHello = function () {
    console.log('this is my blog', require('./config').weixin);
};

require_use.js

module1 = require('./exports_use')
module1.sayHello();

执行后输出结果

图片

module

module 对象表示当前模块。它包含了模块的一些元数据，例如模块的文件名、模块的父模块、模块的导出对象等。在模块中，我们可以通过 module.exports 或 exports 对象来定义模块的导出对象。

module.exports = {
  myFunction: function() {
    console.log('Hello, world!');
  }
};

在上面的例子中，我们通过 module.exports 对象直接定义了模块的导出对象。这样做的好处是可以避免 exports 与 module.exports 的引用关系被断开的问题。

通过module对象可以访问到当前模块的一些相关信息，但最多的用途是替换当前模块的导出对象。例如模块导出对象默认是一个普通对象，如果想改成一个函数的话，可以使用以下方式。

//module_use.js
module.exports = function () {
    console.log('this is my csdn blog', require('./config').csdn);
}

以上代码中，模块默认导出对象被替换为一个函数。

//require_use.js
module2 = require('./module_use')
module2();

执行后输出结果

图片

模块初始化

在 Node.js 中，每个文件都被视为一个模块。当我们使用 require 函数加载一个模块时，Node.js 会执行以下操作来初始化该模块：

  1. 创建一个新的 module 对象，并将该对象赋值给 module 变量。

  2. 将该模块的文件名赋值给module.filename 属性。

  3. 创建一个新的 exports 对象，并将该对象赋值给 module.exports 变量。

  4. 执行该模块的代码，并将exports 对象作为该模块的导出对象。

一个模块中的JS代码仅在模块第一次被使用时执行一次，并在执行过程中初始化模块的导出对象。之后，缓存起来的导出对象被重复利用。

主模块

在 Node.js 中，第一个被执行的模块被称为主模块，即通过命令行参数传递给Node.js以启动程序的模块被称为主模块。主模块的文件名可以通过 require.main.filename 属性获取。主模块负责调度组成整个程序的其它模块完成工作。例如通过以下命令启动程序时，main.js就是主模块。

node main.js

console.log(require.main.filename);

在上面的例子中，我们打印了主模块的文件名。

图片

完整示例

例如有以下目录。

图片

其中counter.js内容如下：

// 定义了一个私有变量num
var num = 0;

function count() {
    return ++num;
}

//在exports对象导出了一个公有方法count
exports.count = count;

该模块内部定义了一个私有变量i，并在exports对象导出了一个公有方法count。

主模块main.js内容如下：

var counter1 = require('./util/counter');
var counter2 = require('./util/counter');
console.log(counter1.count());
console.log(counter2.count());
console.log(counter2.count());

运行该程序的结果如下：

图片

可以看到，counter.js并没有因为被require了两次而初始化两次。

二进制模块

通常我们都是使用JS编写代码，都属于使用的是JS模块，除了 JavaScript 模块外，Node.js 还支持二进制模块。二进制模块是用 C 或 C++ 编写的 Node.js模块，它们可以通过 require 函数加载，并与JavaScript 模块一样使用。

编译好的二进制模块的文件扩展名通常是 .node，和JS模块的使用方式相同。在加载二进制模块时，Node.js会使用 dlopen 函数加载该模块，并将其导出对象作为该模块的导出对象。虽然二进制模块能使用操作系统提供的所有功能，拥有无限的潜能，但对于前端同学而言编写过于困难，并且难以跨平台使用。

更多精彩，关注我公号 ，一起学习、成长 图片.png

Node.js系列文章推荐阅读：

avatar
文章
阅读
粉丝