如何在 Node.js 模块项目中正确加载 CommonJS 文件

千萱小哥_7869

千萱小哥_7869

2026-10-21

491人浏览

原创

如何在 Node.js 模块项目中正确加载 CommonJS 文件

在 ES 模块(ESM)为主的 Node.js 项目中,可通过 createRequire 创建兼容 CommonJS 的 require 函数,安全导入 .cjs 文件并调用其导出的函数,避免 eval 引发的作用域问题和安全性风险。

在 es 模块(esm)为主的 node.js 项目中,可通过 `createrequire` 创建兼容 commonjs 的 require 函数,安全导入 `.cjs` 文件并调用其导出的函数,避免 `eval` 引发的作用域问题和安全性风险。

在现代 Node.js(v12.20+,推荐 v14.13+)中,混合使用 ESM 和 CommonJS 是完全可行的,但必须遵循规范方式——绝不可依赖 eval() 动态执行未封装的脚本代码。你遇到的 ReferenceError: sarasa2 is not defined 正是由于 eval(code) 在严格模式(ESM 默认启用)下创建的是封闭作用域,函数声明不会泄漏到外部上下文。

✅ 正确做法:将待加载逻辑封装为标准 CommonJS 模块(.cjs 后缀),并通过 createRequire 实现跨模块系统加载:

1. 编写标准 CommonJS 文件(testsjs/micro/sarasa.cjs)

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

// ✅ 两种等效导出方式(任选其一)
module.exports = { sarasa2 };
// 或:module.exports.sarasa2 = sarasa2;

⚠️ 注意:文件后缀必须为 .cjs(或配置 "type": "commonjs" 的子目录 package.json),否则 Node.js 会按 ESM 解析,导致 require is not defined 错误。

2. 在 ESM 测试文件中安全加载(so_Test.js)

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

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

下载
import { Test } from "../../myjsunit/testSuite.js";
import { createRequire } from 'node:module'; // Node.js 内置模块

class so_Test extends Test {
  test_load_and_run() {
    const cjsPath = new URL('./sarasa.cjs', import.meta.url);
    const require = createRequire(cjsPath); // ✅ 基于文件路径创建 require

    const moduleExports = require('./sarasa.cjs');

    const actual = moduleExports.sarasa2();
    this.assertTrue(actual);
    this.done();
  }
}

export { so_Test };

? 关键点说明:

  • createRequire(cjsPath) 根据目标 .cjs 文件路径生成专用 require 函数,自动处理模块解析、缓存与 CommonJS 语义;
  • 使用 import.meta.url 构建 URL 是 ESM 中获取当前文件路径的唯一可靠方式(__dirname 在 ESM 中不可用);
  • 不要拼接 process.cwd() 路径——它易受运行位置影响,且破坏可移植性。

❌ 替代方案对比(不推荐):

  • eval():无作用域隔离、无法调试、禁用静态分析、存在远程代码执行(RCE)风险;
  • vm.Script:需手动绑定上下文、仍绕过模块系统、维护成本高;
  • 改用 .mjs + 动态 import():无法直接加载非默认导出的命名函数(如 sarasa2),需重构源码。

? 进阶提示:若需批量加载多个 .cjs 工具函数,可封装为工厂函数:

// utils/cjsLoader.js
import { createRequire } from 'node:module';
export function loadCJS(path) {
  const url = new URL(path, import.meta.url);
  return createRequire(url)(url);
}

// 使用时
const sarasa = loadCJS('./sarasa.cjs');
sarasa.sarasa2();

此方案既满足 TDD 开发流程(本地测试 → 提交 Git → 上传 Botmaker),又保持代码可维护性与安全性,是服务端动态加载用户脚本场景下的最佳实践。

相关文章

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

5046

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

4613

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万人学习