Node ESModule 模式下如何调用 CommonJS 模块

随着 JavaScript 生态系统的不断发展，Node.js 逐渐引入了对 ES Modules（ESM）的支持。ES Modules 是 ECMAScript 标准中定义的模块系统，而 CommonJS 是 Node.js 早期采用的模块系统。由于历史原因，许多 Node.js 生态中的模块仍然使用 CommonJS 格式。因此，在 ESModule 模式下调用 CommonJS 模块成为了开发者需要掌握的重要技能。

本文将详细介绍在 Node.js 的 ESModule 模式下如何调用 CommonJS 模块，并探讨其中的注意事项和最佳实践。

1. Node.js 中的模块系统

在 Node.js 中，主要有两种模块系统：

1. CommonJS：Node.js 早期采用的模块系统，使用 require 导入模块，使用 module.exports 导出模块。
2. ES Modules (ESM)：ECMAScript 标准中定义的模块系统，使用 import 导入模块，使用 export 导出模块。

Node.js 从 v12 开始正式支持 ES Modules，并在 v13 中将其设为稳定特性。默认情况下，Node.js 会将 .js 文件视为 CommonJS 模块，但如果文件的扩展名为 .mjs，或者在 package.json 中设置了 "type": "module"，Node.js 会将其视为 ES Module。

2. 在 ESModule 模式下调用 CommonJS 模块

在 ESModule 模式下，我们可以通过 import 语句直接导入 CommonJS 模块。Node.js 会自动将 CommonJS 模块转换为 ES Module 格式。

2.1 基本用法

假设我们有一个 CommonJS 模块 math.cjs：

// math.cjs
function add(a, b) {
  return a + b;
}

module.exports = { add };

在 ESModule 模式下，我们可以这样导入并使用它：

// main.mjs
import math from './math.cjs';

console.log(math.add(1, 2)); // 输出: 3

2.2 注意事项

1. 默认导出：CommonJS 模块的 module.exports 会被转换为 ES Module 的默认导出（default）。因此，在导入时需要使用 import module from 'module' 的形式。
2. 命名导出：如果 CommonJS 模块导出了一个对象，可以通过解构赋值获取其中的属性。例如：

   // main.mjs
   import { add } from './math.cjs';

   console.log(add(1, 2)); // 输出: 3

1. 动态导入：如果需要动态导入 CommonJS 模块，可以使用 import() 函数：

   // main.mjs
   (async () => {
     const math = await import('./math.cjs');
     console.log(math.add(1, 2)); // 输出: 3
   })();

3. 处理 CommonJS 模块的特殊情况

3.1 导出非对象

如果 CommonJS 模块导出的不是一个对象（例如一个函数或基本类型），在 ESModule 模式下导入时需要注意：

// greet.cjs
module.exports = function greet(name) {
  return `Hello, ${name}!`;
};

在 ESModule 模式下导入：

// main.mjs
import greet from './greet.cjs';

console.log(greet('World')); // 输出: Hello, World!

3.2 导出多个值

如果 CommonJS 模块导出了多个值，可以通过解构赋值获取：

// utils.cjs
module.exports = {
  add: (a, b) => a + b,
  subtract: (a, b) => a - b,
};

在 ESModule 模式下导入：

// main.mjs
import { add, subtract } from './utils.cjs';

console.log(add(5, 3)); // 输出: 8
console.log(subtract(5, 3)); // 输出: 2

3.3 使用 module.createRequire

在某些情况下，可能需要直接在 ESModule 模式下使用 require。可以通过 module.createRequire 实现：

// main.mjs
import { createRequire } from 'module';
const require = createRequire(import.meta.url);

const math = require('./math.cjs');
console.log(math.add(1, 2)); // 输出: 3

4. 最佳实践

1. 统一模块格式：在项目中尽量统一使用一种模块格式（推荐使用 ES Modules），以减少兼容性问题。
2. 使用 .cjs 和 .mjs 扩展名：明确区分 CommonJS 和 ES Module 文件，避免混淆。
3. 逐步迁移：如果项目中有大量 CommonJS 模块，可以逐步将其迁移到 ES Modules，而不是一次性全部迁移。
4. 注意性能：在 ESModule 模式下调用 CommonJS 模块可能会有轻微的性能开销，但在大多数情况下可以忽略不计。

5. 总结

在 Node.js 的 ESModule 模式下调用 CommonJS 模块是完全可行的。Node.js 提供了良好的兼容性支持，开发者可以通过 import 语句直接导入 CommonJS 模块，或者使用 module.createRequire 来调用 require。

随着 ES Modules 的普及，越来越多的库和工具开始支持 ES Modules。作为开发者，了解如何在两种模块系统之间进行互操作是非常重要的。希望本文能帮助你更好地理解和使用 Node.js 中的模块系统。

参考文档： - Node.js 官方文档 - ES Modules - Node.js 官方文档 - CommonJS