在 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 导出的内容。
相关推荐
ncj3934379061 小时前
vscode中对node项目进行断点调试
vscode·node.js
abigale033 小时前
webpack+vite前端构建工具 -11实战中的配置技巧
前端·webpack·node.js
墨菲安全13 小时前
NPM组件 betsson 等窃取主机敏感信息
前端·npm·node.js·软件供应链安全·主机信息窃取·npm组件投毒
csdn_aspnet1 天前
Node.js 使用 WebSockets 和 Socket.IO 实现实时聊天应用程序
node.js
whhhhhhhhhw1 天前
Node.js核心API(fs篇)
node.js
聪聪的学习笔记1 天前
【1】确认安装 Node.js 和 npm版本号
前端·npm·node.js
GDAL1 天前
Node.js v22.5+ 官方 SQLite 模块全解析:从入门到实战
数据库·sqlite·node.js
RunsenLIu2 天前
基于Vue.js + Node.js + MySQL实现的图书销售管理系统
vue.js·mysql·node.js
Allen_zx2 天前
Elpis - 基于 Koa + Vue3 的企业级全栈应用框架
node.js
鹏程2 天前
局域网下五子棋,html+node.js实现
node.js·html