Node 模块原理与用法详解

什么是 Node 模块？

Node 模块是 Node.js 中的核心概念之一，它是一个封装了特定功能的代码块，具有独立的作用域和生命周期，可以被其他模块引用。在 Node.js 中，每个文件都被视为一个模块，在文件内定义的变量、函数和类默认都是私有的，需要通过模块导出和引用的方式才能被外部模块所访问。

Node 模块可以分为三种类型：

1. 原生模块（Native Modules）：由 Node.js 内置模块提供，使用时不需要安装任何额外的依赖模块，例如 fs、http 等。

2. 内部模块（Core Modules）：由 Node.js 提供的其他模块，使用时需要通过 require 函数引入，例如 path、os 等。

3. 第三方模块（Third-party Modules）：由 Node.js 社区或其他开发者提供的模块，使用时需要通过 npm 包管理器安装后再引用，例如 express、mongoose 等。

Node 模块的导出和导入

Node 模块的导出和导入是模块化编程的核心，通过导出和导入可以实现模块之间的通信和共享。

导出模块

Node 模块的导出可以通过 module.exports 和 exports 两种方式实现。它们的区别在于，module.exports 是模块导出对象的真正主人，而 exports 只是 module.exports 的一个引用。当使用 exports 导出模块时，实际上等同于给 module.exports 添加属性和方法。

示例代码：

function sum(a, b) {
  return a + b;
}

exports.sum = sum;

上述代码定义了一个 sum 函数，通过 exports 导出模块。

导入模块

Node 模块的导入需要使用 require 函数，require 函数可以接受一个字符串参数，该参数是要导入模块的路径，同时也支持相对路径和绝对路径的方式。require 函数会返回被导入的模块对象。

示例代码：

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

console.log(myModule.sum(1, 2));

上述代码从当前目录下的 my-module.js 文件中导入模块，并调用其 sum 函数。

Node 模块的分类和实现方式

单例模式

在 Node.js 中，模块在第一次被 require 的时候会被加载，然后保存在一个缓存区中，之后再在其他地方 require 同一个模块会直接从缓存中获取。这种模块实现方式就是单例模式。只加载一次模块可以减少读取磁盘的 IO 操作，提高应用程序的性能。

文件模块

Node.js 中的文件模块是以文件名字命名的模块，例如 my-module.js、my-module.json、my-module.node 等。Node.js 在导入模块时会依次按以下顺序查找：

1. 以模块文件名为 key，在缓存区中查找是否已经存在该模块；

2. 在文件系统中查找是否存在该模块文件（如果没有扩展名，则按 .js、.json、.node 的方式依次查找）；

3. 在 node_modules 目录下查找模块文件（会从当前模块的父目录开始一直向上查找，直到根目录为止），同时会根据 package.json 文件中的配置信息找到对应的入口文件（如果没有 package.json 或者 package.json 中未设置 main，会使用 index.js 作为默认入口文件名）。

示例代码：

文件 my-module.js：

console.log('My module has been required.');

module.exports = {
  message: 'Hello, world!'
};

文件 index.js：

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

console.log(myModule.message);

上述代码中，index.js 文件通过 require 函数导入 my-module.js 模块，并打印其导出的 message 属性，my-module.js 文件中的 console.log 表示该模块被 require 的时候会输出到控制台。

文件夹模块

当 Node.js 查找到一个目录作为模块的时候，会尝试寻找该目录下的 package.json 文件，从中读取 main 字段指定的模块入口文件。如果没有 package.json 或者 package.json 中未设置 main，则会默认使用 index.js 作为入口文件，如果没有 index.js，则报错。

示例代码：

目录 my-module 目录下的 package.json 文件：

{
  "name": "my-module",
  "version": "1.0.0",
  "main": "my-module.js"
}

目录 my-module 目录下的 my-module.js 文件：

console.log('My folder module has been required.');

module.exports = {
  message: 'Hello, folder!'
};

文件 index.js：

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

console.log(myModule.message);

上述代码中，index.js 文件通过 require 函数导入 my-module 目录模块，并打印其导出的 message 属性，my-module.js 文件中的 console.log 表示该模块被 require 的时候会输出到控制台。

require 函数的一些用法

除了普通的 require 导入方法外，require 还有一些其他的用法，如通过变量动态导入模块、异步导入模块等。

动态导入模块

在 Node.js v8.5.0 及以上版本中，可以使用 import() 函数来动态导入模块。这种技术可以允许在运行时根据需要动态地加载模块，从而实现按需加载、减少应用程序的启动时间等目的。

示例代码：

async function loadModule(modulePath) {
  const myModule = await import(modulePath);
  console.log(myModule.default);
}

loadModule('./my-module.js');

上述代码中，loadModule 函数演示了如何使用 import 函数动态导入模块。await 关键字用于等待模块加载完成后再继续执行，myModule.default 表示模块导出对象的默认属性和方法。

异步导入模块

在 Node.js v10.0.0 及以上版本中，可以使用 require 的另一个用法——异步导入模块。这种方法可以使 Node.js 应用程序更加高效和灵活，因为它不会阻塞事件循环。

示例代码：

async function loadModule(modulePath) {
  const myModule = await require(modulePath);
  console.log(myModule);
}

loadModule('./my-module.js');

上述代码展示了如何使用 require 函数异步导入模块。await 关键字用于等待模块加载完成后再继续执行，myModule 表示导入的模块对象。