如何用 Node.js 原生支持的 ESM 编写现代化的后端模块

轻墨君_6881

轻墨君_6881

2026-04-06

385人浏览

原创

node.js 14+ 启用原生esm需满足:package.json设"type":"module"或使用.mjs后缀;esm中导入cjs模块仅支持default,解构需createrequire;读json用import(..., {assert: {type:'json'}})或fs.readfile;__dirname需import.meta.url+fileurltopath;顶层await可用于初始化。

如何用 node.js 原生支持的 esm 编写现代化的后端模块

Node.js 14+ 中启用 ESM 的必要配置

Node.js 原生 ESM 不是开箱即用的——即使你写了 import,不加配置也会报 ERR_REQUIRE_ESM。关键在两点:文件后缀和 package.json 字段。

必须满足以下任一条件,Node 才会以 ESM 模式加载模块:

  • "type": "module" 写在项目根目录 package.json 中(推荐,全局生效)
  • 或使用 .mjs 后缀(如 server.mjs),无视 type 字段
  • .cjs 强制 CJS,.mjs 强制 ESM,.js 则由 type 决定

注意:type: module 下,require() 会直接报错;反之,CJS 里不能用 import。混用需靠动态 import() 或 createRequire。

ESM 下如何正确导入 CommonJS 模块

很多生态库(如 express、pg)仍是 CJS 输出,ESM 项目里直接 import express from 'express' 通常能工作,但有隐性限制:

  • Node 会自动将 CJS 包封装为默认导出(default),所以 import express from 'express' 可行,但 import { Router } from 'express' 会失败(CJS 没命名导出)
  • 若 CJS 模块导出的是函数(如 module.exports = function(){}),ESM 中只能通过 import xxx from 'xxx' 获取,不能解构
  • 想安全访问 CJS 的具名属性?用动态 import() + default 解构,或改用 createRequire(需先 import { createRequire } from 'module')

示例:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
import { createRequire } from 'module';
const require = createRequire(import.meta.url);
const { Pool } = require('pg'); // 这样才能解构 pg 的命名导出

ESM 中读取 JSON 和 __dirname/__filename 的替代方案

ESM 不支持 require('./config.json'),也不提供 __dirname 和 __filename —— 这是常见卡点。

  • 读 JSON:用 await import('./config.json', { assert: { type: 'json' } })(Node ≥17.1),或更兼容的 fs/promises.readFile('./config.json', 'utf8').then(JSON.parse)
  • 获取当前模块路径:用 import.meta.url,配合 file:// 协议解析:import { fileURLToPath } from 'url'; const __dirname = dirname(fileURLToPath(import.meta.url));
  • 注意:import.meta.url 是只读字符串,不能直接当路径用,必须经 fileURLToPath 转换

别漏掉 import { dirname } from 'path',否则 dirname() 会 undefined。

顶层 await 和动态 import 在后端启动流程中的实用场景

ESM 允许模块顶层 await,这对后端很实用:数据库连接、配置加载、服务注册等初始化逻辑可自然串行,不用包进 async function main()。

  • 例如启动 Express 服务前等待 DB 连接就绪:const db = await connectDB(); const app = express();
  • 按需加载插件或中间件:用 const authMiddleware = await import('./middleware/auth.js');,避免冷启动时全量加载
  • 动态 import() 返回 Promise,可用于环境分支加载:if (process.env.NODE_ENV === 'dev') await import('./dev-tools.js');

注意:顶层 await 会阻塞整个模块树的执行,慎用于耗时过长或可能失败的操作;错误会直接导致模块加载失败,需包裹 try/catch 或用 .catch() 处理。

真正麻烦的不是语法,而是混合生态下的路径解析、JSON 加载、CJS 互操作——这些地方出错时错误信息往往模糊,得盯住 import.meta.url 和 package.json#type 两个锚点反复核对。

相关文章

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

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

下载

相关标签:

js node.js node

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2203

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5850

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5146

10

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

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

2023.06.20

4386

5

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

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

2023.07.04

1109

3

js四舍五入
js四舍五入

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

2023.07.04

4304

6

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

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

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1756

5

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

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

2023.09.04

3165

4

热门下载

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

精品课程

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

共101课时 | 20.7万人学习

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

共39课时 | 4.7万人学习