最近在整理Node.js相关的知识点,发现通过Node.js支持的两个模块导入语句require和import在同时使用时会发生错误,而且错误非常诡异。
例如,在先使用require导入模块,在使用import导入模块时,出现require无法识别,
在先使用import导入模块,在使用require导入模块时,同样出现了require无法识别,建议使用import代替。
ReferenceError: require is not defined in ES module scope, you can use import instead
const readFile = require('fs').readFile;
^
ReferenceError: require is not defined in ES module scope, you can use import instead
at file:///d:/Software/Electron/JavaScript/LearnProject/NodeJsProject/BasicModules/FileOperation.js:10:18
at ModuleJob.run (node:internal/modules/esm/module_job:271:25)
at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:547:26)
at async asyncRunEntryPointWithESMLoader (node:internal/modules/run_main:116:5)
Node.js v22.13.1
'use strict'
//const {randomInt} = require('node:crypto');
import {randomInt} from 'node:crypto';
const n = randomInt(0,100);
console.log('BasicModules.js: randomInt:', n);
//import {readFile} from 'node:fs';
const readFile = require('fs').readFile;
console.log("BasicModules.js: readFile start");
readFile('BasicModules.js', 'utf-8', (err, data)=>{
if (err) {
console.log('BasicModules.js: readFile error:', err);
} else {
console.log('BasicModules.js: readFile data:', data);
}
});
console.log("BasicModules.js: readFile End");
Node.js 中无法同时使用 require 和 import 的根本原因在于两种模块系统的设计差异。以下是具体原因和解决方案的总结:
模块系统差异
- CommonJS(require)
Node.js 原生支持的模块系统,同步加载模块,适用于服务端开发。
通过 module.exports 导出,require() 导入,本质是运行时加载。 - ES 模块(import/export)
官方标准化模块系统,异步加载,支持静态分析,适用于浏览器和现代 Node.js 环境。
通过 export 导出,import 导入,编译时确定依赖关系。
报错原因分析
当文件被识别为 ES 模块 时(文件中使用了import就会自动识别为ES模块):
Node.js 默认禁用 require,因为 ES 模块设计上要求代码静态化,而 require 是动态的[[1][3]6。
错误 ReferenceError: require is not defined in ES module scope 表明当前文件被识别为 ES 模块,但尝试使用了 CommonJS 语法。
1. 解决方案
1.1 统一模块类型
方法一:显式声明模块类型
在 package.json 中添加 “type”: “module”,所有 .js 文件默认视为 ES 模块;使用 .cjs 扩展名表示 CommonJS 模块。
方法二:动态兼容
在 ES 模块中通过 createRequire 引入 require:
import { createRequire } from 'module';
const require = createRequire(import.meta.url);
// 之后可使用 require()
此方式允许在 ES 模块中局部使用 CommonJS 语法[[1][7]10。
1.2 模块互操作
导入 CommonJS 模块到 ES 模块
使用 import 导入时,CommonJS 模块会被包装为默认导出:
import fs from 'fs'; // 等同于 require('fs').default
导入 ES 模块到 CommonJS
需使用动态 import():
const loadModule = async () => {
const esModule = await import('./es-module.mjs');
};
1.3 环境配置
Node.js 版本要求
确保版本 ≥ 14,并启用实验性 ES 模块支持(旧版本需添加 --experimental-modules 标志)。
文件扩展名
ES 模块建议使用 .mjs,CommonJS 使用 .cjs,避免解析歧义。
2. 最佳实践
项目级统一规范
新项目优先使用 ES 模块,老项目逐步迁移,避免混用。
工具链适配
使用 Babel 或 TypeScript 编译代码,兼容不同模块系统。
3. 总结
Node.js 中 require 和 import 的冲突源于模块系统的底层差异。通过统一模块类型、动态兼容或工具链适配,可解决这一问题。建议根据项目需求选择合适的模块方案,并遵循 Node.js 官方文档的模块互操作指南。