Node.js CommonJS模块化规范的使用

上文提到了 Node 采用的模块化规范是 ​​CommonJS​​，它主要规定了如何定义模块，如果导出模块和如何导入模块：

为了方便使用模块化，于是提供了几个全局的方法或对象，分别是：

下面来看下这几个对象和方法的使用。

首先准备一个目录：

​​a.js​​ 模块导出内容：

// 导出内容有几种不同的方式：// 方式1：模块只导出变量 namemodule.exports = name

// 方式2：模块导出的是一个对象，包含一个 name 属性module.exports.name = name// 等同于exports.name = name

模块要导出的内容是存放在 ​​module.exports​​ 中的，默认是一个空对象。

​​exports​​ 是​​module.exports​​ 的别名，在导出内容时，切不可这样做：

exports = name

这里就是值类型与引用类型的区别的问题。将 ​​exports​​ 指向一个全新的值，就和原来的 ​​module.exports​​ 断了联系，此时模块将导出默认的空对象。

在 ​​idnex.js​​中，导入 ​​a​​ 模块：

// 方式2的结果：console.log(a) // {name: 'kw'}

上面的示例中，我们所创建的模块都是一个个的 ​​.js​​ 文件，这属于文件类型的模块。

文件不止一种类型，文件模块也就不止一种。在 node 中的文件模块有三种：

对不同文件后缀的模块有不同的加载策略。对于 ​​json​​ 文件会调用 ​​fs​​ 模块读取后再用 ​​JSON.parse​​ 方法转成 ​​json​​对象；对于 ​​.node​​ 文件，不经任何处理，直接调用。

我们知道 Webpack 是一个模块打包工具，它默认支持 CommonJS 规范。使用 Webpack 时，也会认为一个文件就是一个模块。但比 CommonJS 规范更加丰富的是，不仅 ​​.js​​ 、​​.json​​ 是模块，任意一个文件都是模块，比如 ​​.png​​，​​.vue​​，​​.ts​​，但是这种模块 Webpack 是“不认识”的，还需要安装对应的 loader 去解析。

按照来源划分，在 Node 中一共有三类模块，分别是：

​​require​​ 方法在导入模块时，会有一个查找的机制。

参数是一个模块名。如果发现是内置模块，则导入并结束查找。

参数是一个文件路径，以 ​​./​​ 、​​../​​ 或者 ​​/​​开头。

// 必须以 ./、 ../、 / 开头// 找到同级目录下的 a.js 并导入const a = require('./a.js')

如果模块没有带后缀：

会依次去找有没有 ​​a.js​​、 ​​a.json​​、​​a.node​​，找到则导入模块；没有的话，会将 ​​a​​ 当作一个目录名，去找 ​​a​​ 目录下的 ​​index.js​​、 ​​index.json​​、 ​​index.node​​，找到则导入模块。如果还没有找到，则报错找不到模块。

参数是一个模块名，并且不是核心模块名。

通过包管理工具安装一个模块：

// 发现 dayjs 不是内置模块，首先会从当前模块所在目录的 node_modules 目录下查找，找到后就结束查找。找不到则向上一级目录查找，一直到系统的根目录。// 查找顺序分别是：/** 'c:\Users\taylo\Desktop\commonjs\src\node_modules', 'c:\Users\taylo\Desktop\2022 掘金日新计划 8月\commonjs\node_modules', 'c:\Users\taylo\Desktop\2022 掘金日新计划 8月\node_modules', 'c:\Users\taylo\Desktop\node_modules', 'c:\Users\taylo\node_modules', 'c:\Users\node_modules', 'c:\node_modules' 在我们的目录结构中，会从第二个路径中找到，于是导入模块，结束查找。*/

const dayjs = require('dayjs')

console.log(dayjs(123456789123).format('YYYY-MM-DD hh:mm:ss')) // '1973-11-30 05:33:09'

本文主要介绍了 CommonJS 规范在 Node 中的简单应用，主要就是导入和导出模块。

关于 CommonJS 规范更细节的讲解，以及实现原理，会在后面的更文中谈到，敬请期待。