MongoDB Shell如何从外部JS文件导入可复用的公共函数

将重复公共代码抽取为独立文件复用的需求完全可实现，之前尝试require、import、load()失效的核心原因是对MongoDB Shell的运行机制存在认知偏差，并非环境本身不支持跨文件代码复用。 #

MongoDB Shell分为两个技术差异较大的版本，适配方法有所区别：

基于SpiderMonkey内核的传统版mongo Shell（MongoDB 4.4及更早版本默认环境，即你提到的SpiderMonkey运行时） #

这个版本不兼容Node.js的CommonJS/ESM模块语法，所以require、import本身就不会被识别，之前load()失效通常是路径或者作用域的问题：

• load()的运行逻辑是同步执行指定路径下的JS文件，文件内定义的全局函数、常量会自动挂载到当前Shell的全局作用域，没有模块导出的概念，不需要写额外的导出语句
• 常见的load()失效原因：
  • 使用了相对路径：该版本的相对路径是相对于启动Shell时的终端工作目录，不是当前执行脚本的所在目录，非常容易出现路径不匹配
  • 路径字符串格式错误：比如Windows环境下没有对反斜杠做转义，直接写load("C:\scripts\common.js")会被识别为转义字符，导致路径解析错误
  • 公共文件的代码做了作用域隔离：比如把函数定义放在块级代码块、立即执行函数（IIFE）内部，导致变量不会暴露到全局，后续业务脚本无法调用
• 正确操作步骤：
  1. 编写独立公共文件common.js，直接定义需要复用的函数、常量，不要包裹导出逻辑、不要做无意义的作用域隔离，示例：

     // common.js 公共代码示例
     function buildActiveUserQuery() {
       return { userStatus: "enabled", isDeleted: false };
     }
     const QUERY_BATCH_SIZE = 1000;
     function runBatchUpdate(collection, updateConfig) {
       // 复用的批量更新逻辑
     }
     

  2. 在两个业务脚本的最开头，使用绝对路径调用load()引入公共文件，比如：

     // Linux/macOS 路径写法
     load("/home/xxx/mongo_scripts/common.js")
     // Windows 路径写法（注意双反斜杠转义）
     load("C:\\mongo_scripts\\common.js")
     

  3. 引入完成后，后续业务代码可以直接调用buildActiveUserQuery()这类公共函数，不需要额外的导入操作
  4. 路径校验技巧：可以在Shell交互模式下单独执行一次load()命令，如果无报错提示，说明路径配置正确；如果报文件不存在的错误，优先修正路径写法，不建议用相对路径规避歧义

基于Node.js重构的新版mongosh（MongoDB 5.0及之后默认环境） #

新版mongosh虽然底层基于Node.js构建，但默认处于安全考虑禁用了外部模块加载，这也是之前require语法失效的核心原因：

• 原生兼容老版Shell的load()语法，按照上面的方法配置绝对路径即可正常复用公共代码，不需要额外配置
• 如果要使用require语法引入公共文件，需要满足两个前提：
  1. 公共文件按照CommonJS规范编写导出逻辑，比如在common.js末尾追加：

     module.exports = { buildActiveUserQuery, QUERY_BATCH_SIZE, runBatchUpdate }
     

  2. 启动mongosh时增加参数--enable-module-loading，开启本地模块加载权限，之后就可以在业务脚本中通过const common = require("./common.js")的方式引入公共代码

• 不要在公共文件中使用ESM规范的import/export语法，两个版本的Shell默认都不识别这类语法
• 使用load()引入公共文件时，不要把代码包裹在{}块、IIFE等隔离作用域中，否则定义的变量无法被业务脚本访问
• 注意全局变量命名冲突：load()是直接把公共文件内容注入全局作用域，和业务脚本重名的变量会被直接覆盖

内容的提问来源于stack exchange，提问作者U Rogel