在 ESM 中引入 CommonJS 模块

简介

随着越来越多的 Node.js 项目采用 ESM 作为模块系统,一些较旧的 CommonJS 模块依然被广泛使用。由于这两者的模块系统存在一些差异,我们可能会面临引入 CommonJS 模块到 ESM 项目中的挑战。

这种兼容性问题主要表现为:

  • ESM 模块系统使用 importexport,而 CommonJS 使用 requiremodule.exports
  • Node.js 对文件扩展名(如 .js, .mjs, .cjs)的处理方式不同,可能会导致加载错误。

在 ESM 中引入 CommonJS 模块的几种方式

方法 1:使用 .cjs 后缀和 require()(同步加载)

这是最推荐的方式,它让你明确指定文件是 CommonJS 模块,并允许你使用同步的 require() 来导入模块。

步骤

  1. 确保 CommonJS 模块使用 .cjs 后缀。
  2. 使用 createRequire 方法来引入 CommonJS 模块。
javascript 复制代码
// cjs-file.cjs
module.exports = {
  sayHi(name) {
    console.log(`Hi, ${name} from CommonJS`);
  }
};
javascript 复制代码
// esm-file.js
import { createRequire } from 'module';
const require = createRequire(import.meta.url);

const cjs = require('./cjs-file.cjs');
cjs.sayHi('Alice');

优点

  • 同步加载,代码简单直观。
  • 兼容性好,适用于大多数 Node.js 项目。

方法 2:使用动态 import()(异步加载)

当你不能或不想使用 .cjs 后缀时,可以使用动态 import() 来加载 CommonJS 模块。由于 import() 是异步的,你需要使用 await.then() 来处理加载。

dart 复制代码
// esm-file.js
const cjsModule = await import('./cjs-file.js');  // 动态导入
cjsModule.default.sayHi('Alice');

优点

  • 灵活性高,可以按需加载模块。
  • 不要求模块使用 .cjs 后缀。

缺点

  • 异步加载,代码稍显复杂。
  • 需要使用 default 属性来访问 CommonJS 导出的内容。
相关推荐
www_stdio2 小时前
OpenAI AIGC 模型开发实践:从接口调用到工业化应用
node.js·openai
拖拉斯旋风3 小时前
0基础学习js之OpenAI AIGC:用OpenAI生成一首歌
node.js·openai
Zyx20073 小时前
用 OpenAI SDK 快速搭建你的第一个 AIGC 应用:从零开始生成文本
人工智能·node.js
api_180079054605 小时前
Node.js 接入淘宝 API 实战:构建商品信息实时同步服务
node.js
小白用python11 小时前
win10安装nodejs及better-sqlite3失败的解决方案
node.js·better-sqlite3
ikoala17 小时前
Node.js 25 正式发布:性能飙升、安全升级、全面向 Web 靠拢!
前端·面试·node.js
前端架构师-老李20 小时前
npm、yarn、pnpm的对比和优略
前端·npm·node.js·pnpm·yarn
www_stdio21 小时前
用 n8n 打造科技新闻速览工作流:从搭建到落地的完整指南
node.js
gustt21 小时前
每天一杯科技资讯咖啡,用 n8n 喂给 AI
人工智能·node.js
烤红薯2091 天前
如何使用代理IP发送请求(711Proxy实战指南)
node.js