在 Node.js 模块项目中正确加载 CommonJS 文件的完整指南

胖雪大大_1181

胖雪大大_1181

2026-10-21

794人浏览

原创

在 Node.js 模块项目中正确加载 CommonJS 文件的完整指南

本文详解如何在 ES 模块(ESM)主导的 Node.js 项目中安全、可靠地加载并执行 CommonJS(.cjs)文件,解决 eval 作用域隔离导致函数未定义的问题,并提供可落地的测试集成方案。

本文详解如何在 es 模块(esm)主导的 node.js 项目中安全、可靠地加载并执行 commonjs(.cjs)文件,解决 `eval` 作用域隔离导致函数未定义的问题,并提供可落地的测试集成方案。

在现代 Node.js(v14+)项目中,若主项目采用 ES 模块(即 type: "module" 在 package.json 中),直接使用 eval() 加载并执行 .js 文件会失败——因为 eval() 在严格模式下运行于独立作用域,其内部声明的函数(如 function sarasa2(){})不会泄露到外部上下文,导致 ReferenceError: sarasa2 is not defined。

根本原因在于:eval() 不是模块加载机制,它无法模拟 require() 的导出绑定与作用域桥接能力。而真正的解决方案不是规避模块系统,而是尊重并桥接两种模块规范。

✅ 正确做法:用 createRequire 加载 CommonJS 文件

Node.js 提供了官方兼容方案:node:module 模块中的 createRequire()。它能为任意文件路径创建一个符合 CommonJS 语义的 require 函数,完美支持 module.exports 和 exports.xxx 导出。

用于自动切换项目中适合的node 版本
用于自动切换项目中适合的node 版本

根据 package.json 中的 engines 字段自动检测 Node.js 版本需求,未安装 nvm 时自动安装并切换至对应版本。支持 Windows、macOS、Linux。适用于 Node.js 项目开发、版本切换和环境配置。

下载

1. 将源文件改为标准 CommonJS 格式(.cjs 扩展名推荐)

// testsjs/micro/sarasa.cjs
function sarasa2() {
  console.log("aca toy!");
  return true;
}

// ✅ 方式一:命名导出
module.exports.sarasa2 = sarasa2;

// ✅ 或方式二:默认导出对象(更清晰)
// module.exports = { sarasa2 };

? 强烈建议使用 .cjs 扩展名(而非 .js),避免与 ESM 文件混淆,并确保 Node.js 总是以 CommonJS 模式解析——即使项目启用了 "type": "module"。

2. 在 ESM 测试文件中安全加载与调用

import { Test } from "../../myjsunit/testSuite.js";
import { createRequire } from 'node:module';
import { fileURLToPath } from 'node:url';
import { dirname, join } from 'node:path';

class so_Test extends Test {
  test_load_and_run() {
    // ✅ 获取当前目录的绝对路径(ESM 中不能直接用 __dirname)
    const __filename = fileURLToPath(import.meta.url);
    const __dirname = dirname(__filename);
    const cjsFilePath = join(__dirname, '../testsjs/micro/sarasa.cjs');

    // ✅ 创建专属 require 实例,指向该 .cjs 文件所在目录
    const require = createRequire(cjsFilePath);

    // ✅ 同步加载:返回 module.exports 对象
    const sarasaModule = require('./sarasa.cjs'); // 注意:路径相对于 createRequire 的 base dir

    // ✅ 调用导出的函数
    const actual = sarasaModule.sarasa2();

    this.assertTrue(actual);
    this.done();
  }
}

export { so_Test };

? 关键细节说明:

  • createRequire(filePath) 的参数必须是文件路径(非 URL),且该路径决定了 require() 解析相对路径的基准目录(类似 require 在该文件内执行);
  • 使用 join(__dirname, ...) 构建路径,确保跨平台兼容性;
  • import.meta.url 是 ESM 中获取当前文件 URL 的唯一标准方式,需配合 fileURLToPath() 转换为文件系统路径;
  • 不要尝试 require('./sarasa.cjs') 直接导入(ESM 不允许),必须通过 createRequire 创建的实例调用。

⚠️ 注意事项与最佳实践

  • 禁止混用 eval() 加载业务逻辑:eval() 存在严重安全隐患(代码注入)、调试困难、无模块作用域、无法处理 require/exports,仅适用于极简原型,绝不用于测试或生产;
  • 明确区分模块类型:在 package.json 中设置 "type": "module" 后,所有 .js 默认为 ESM;.cjs 则强制为 CommonJS —— 这是 Node.js 官方推荐的共存策略;
  • 导出需显式声明:CommonJS 文件中必须通过 module.exports 或 exports.xxx 显式暴露函数,否则加载后为空对象;
  • 测试可复用性:此方案完全兼容 Jest、Vitest 等主流测试框架(只需将 createRequire 逻辑封装为工具函数);
  • Botmaker 等低代码平台场景适配:如答案中所述,最终上传至 Botmaker 的脚本仍可保持纯函数体(无需 exports),但本地开发/测试阶段务必用 .cjs + createRequire 实现 TDD 循环,大幅提升可维护性。

通过这一模式,你既能享受 ES 模块项目的现代工程体验(TypeScript、tree-shaking、IDE 支持),又能无缝集成遗留或平台限定的 CommonJS 逻辑,真正实现“写一次,测充分,发无忧”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js node.js node

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5066

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1249

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4984

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1896

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3565

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4633

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3040

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

968

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习