在CommonJS项目中使用graphql-request的ESM模块解决方案

当开发者尝试在CommonJS环境中使用最新版本的graphql-request时，会遇到一个典型的问题：由于graphql-request已经转为纯ESM模块，传统的require()方式无法直接导入。本文将深入分析这个问题并提供几种可行的解决方案。

问题根源分析

在Node.js生态系统中，模块系统经历了从CommonJS到ESM的演进。graphql-request作为一个流行的GraphQL客户端库，最新版本已完全转向ESM模块格式。当开发者尝试在CommonJS项目中使用时，会遇到以下核心问题：

1. TypeScript编译器默认会将动态导入(import())转换为require()调用
2. Node.js不允许通过require()加载纯ESM模块
3. 直接使用import语法在CommonJS文件中会引发语法错误

解决方案比较

方案一：动态导入包装函数

最可靠的解决方案是使用Function构造函数包装动态导入，防止TypeScript编译器将其转换为require()调用：

async function getGraphQLLibs() {
  const { GraphQLClient, gql } = await new Function("return import('graphql-request')")();
  return { GraphQLClient, gql };
}

这种方法的优势在于：

• 完全兼容现有CommonJS项目
• 不需要修改项目结构或配置
• 保留了完整的类型支持

方案二：调整TypeScript配置

修改tsconfig.json可以部分缓解问题：

{
  "compilerOptions": {
    "moduleResolution": "node",
    "target": "ES2022"
  }
}

但这通常不足以完全解决问题，因为TypeScript仍可能在某些情况下将import转换为require。

方案三：项目迁移至ESM

长期来看，最彻底的解决方案是将整个项目迁移到ESM模块系统：

1. 在package.json中添加"type": "module"
2. 将所有文件扩展名改为.mjs或使用.mts
3. 更新所有导入导出语法

技术细节解析

理解为什么Function包装器有效很重要：TypeScript的编译器不会分析通过new Function()动态创建的代码，因此不会对这些代码进行模块系统转换。这保留了原始的import()语义，让Node.js能够正确处理ESM模块加载。

最佳实践建议

1. 对于短期解决方案，推荐使用动态导入包装函数
2. 对于新项目，建议直接采用ESM模块系统
3. 对于大型现有项目，可以逐步迁移到ESM
4. 保持TypeScript和Node.js版本更新，以获得更好的模块互操作性支持

随着Node.js生态系统的演进，模块互操作性问题将逐渐减少，但目前理解这些解决方案对于使用现代JavaScript库仍然至关重要。