Node.js模块化：如何正确使用ESM的import语句

本文详细阐述了在Node.js应用中，当试图混合使用CommonJS的`require`与ESM的`import`语句时常遇到的`SyntaxError`。它提供了一个明确的解决方案：通过在`package.json`文件中设置`"type": "module"`，将项目配置为ESM模式，从而正确地使用`import`语法，并探讨了由此带来的潜在影响和兼容性调整，确保模块化开发的顺畅进行。

理解Node.js的模块系统

Node.js生态系统目前支持两种主要的模块系统：CommonJS（CJS）和ECMAScript Modules（ESM）。CommonJS是Node.js早期采用的模块规范，使用require()函数导入模块，并使用module.exports或exports导出模块。ESM则是JavaScript官方的模块标准，使用import语句导入模块，export语句导出模块。

在Node.js项目中，当尝试在一个默认以CommonJS模式运行的环境中使用ESM的import语句时，会遇到SyntaxError: Cannot use import statement outside a module的错误。反之，如果一个模块是纯ESM格式，尝试用CommonJS的require()去导入它，则可能导致TypeError: createHttpProxyAgent is not a function等错误，因为ESM模块的导出方式与CommonJS不同。

解决import语句的SyntaxError

要解决在Node.js应用中正确使用import语句的问题，核心在于明确告知Node.js该项目或文件应以ESM模式运行。最直接且推荐的方法是在项目的package.json文件中添加"type": "module"字段。

配置package.json

在您的项目根目录下的package.json文件中，添加或修改"type"字段如下：

{
  // ... 其他配置
  "type": "module",
  // ... 其他配置
}

当"type": "module"被设置后，Node.js会将该项目中的所有.js文件默认视为ESM模块。这意味着您可以在这些文件中自由地使用import和export语句。

使用import语句

完成上述配置后，您就可以按照ESM规范来导入模块了。例如，对于http-proxy-agent模块，可以这样导入：

import { HttpProxyAgent } from 'http-proxy-agent';

// 之后就可以正常使用 HttpProxyAgent
const agent = new HttpProxyAgent('http://localhost:8080');

兼容性考量与注意事项

将项目设置为"type": "module"后，需要注意以下几点：

SpeakingPass-打造你的专属雅思口语语料

使用chatGPT帮你快速备考雅思口语，提升分数

25

查看详情

1. 所有.js文件默认为ESM： 一旦设置了"type": "module"，项目中的所有.js文件都将被Node.js解释为ESM模块。这意味着如果您的项目中有其他文件仍然使用require()导入模块，它们也需要相应地转换为import语句。

2. 处理CommonJS模块： 在ESM模块中，仍然可以通过import语句导入CommonJS模块，但方式略有不同。例如：

   // 导入 CommonJS 模块的默认导出
   import commonjsModule from 'commonjs-package';
   
   // 导入 CommonJS 模块的命名导出（如果它有）
   // 或者需要使用 * as 语法
   import * as commonjsModuleExports from 'commonjs-package';

   登录后复制

   请注意，CommonJS模块没有命名导出，所以通常是导入其module.exports对象。

3. 文件扩展名：

   • 在"type": "module"的项目中，如果您仍然需要某个文件以CommonJS模式运行，可以将其文件扩展名更改为.cjs（例如my-commonjs-file.cjs）。
   • 如果您的项目没有设置"type": "module"（即默认是CommonJS模式），但您想在特定文件中使用ESM，可以将其文件扩展名更改为.mjs（例如my-esm-file.mjs）。 通过文件扩展名，您可以更细粒度地控制模块类型。

4. 全局变量和__dirname/__filename： 在ESM模块中，__dirname和__filename这些CommonJS特有的全局变量是不可用的。如果您需要它们的功能，可以这样获取：

   import { fileURLToPath } from 'url';
   import { dirname } from 'path';
   
   const __filename = fileURLToPath(import.meta.url);
   const __dirname = dirname(__filename);

   登录后复制

5. 相对路径导入： 在ESM中，相对路径导入必须包含完整的文件扩展名（例如./utils.js而不是./utils），尽管在某些配置下（如使用--experimental-specifier-resolution=node或某些打包工具）可以省略。

总结

在Node.js项目中正确使用import语句的关键在于理解和配置模块类型。通过在package.json中设置"type": "module"，您可以将项目切换到ECMAScript Modules模式，从而顺利使用import语法。同时，也需要注意由此带来的对现有CommonJS代码的兼容性调整，以及ESM特有的行为（如文件扩展名、全局变量等）。遵循这些指导原则，将有助于您在Node.js中构建更现代化、更符合标准的模块化应用。

以上就是Node.js模块化：如何正确使用ESM的import语句的详细内容，更多请关注php中文网其它相关文章！