讲师中心 微信公众号
AI工具推荐 视频效率加速

JavaScript中Nodejs对子路径导入subpath-imports配置

星婷姑娘_3802

星婷姑娘_3802

发布时间:2026-03-17 21:07:01

|

923人浏览过

|

来源于php中文网

原创

<p>Node.js 从 v14.13.0 起原生支持 subpath imports,通过 package.json 的 "imports" 字段实现内部模块别名导入;它以 # 开头声明导入映射,仅限本包内使用,需配合 "type": "module",提升封装性与运行时一致性。</p>

javascript中nodejs对子路径导入subpath-imports配置

Node.js 从 v14.13.0 开始原生支持子路径导入(subpath imports),无需额外工具或打包器,通过 package.json 中的 "imports" 字段即可实现安全、明确、可静态分析的内部模块别名导入。

什么是 subpath imports?

它是一种在 package.json 中声明模块导入映射的机制,用于将形如 import "pkg/subpath" 的导入语句,解析为项目内具体的相对路径(如 ./src/utils/helpers.js),同时禁止未显式声明的子路径访问(即“深度导入”被默认封禁),提升封装性和可维护性。

与旧式的 exports 字段不同,imports 专用于当前包内部的导入重写(只影响 import 和 require() 在本包内的使用),不对外暴露。

如何配置 imports 字段?

在项目根目录的 package.json 中添加 "imports" 字段,值为一个对象,键是导入说明符(支持模式匹配),值是对应解析路径(支持相对路径或内置模块):

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

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

下载

立即学习“Java免费学习笔记(深入)”;

  • 键必须以 # 开头(推荐前缀,增强语义和避免与真实包名冲突)
  • 支持通配符 *,例如 "#utils/*": "./src/utils/*"
  • 路径值需以 ./、../ 或 node: 开头,否则会被视为外部包
  • 必须与 "type": "module" 配合使用(ESM 模式)

示例配置:

{
  "type": "module",
  "imports": {
    "#root/*": "./src/*",
    "#utils": "./src/utils/index.js",
    "#api/client": "./src/api/client.mjs",
    "#config": "./src/config/default.js"
  }
}

之后即可在项目中这样导入:

import { debounce } from '#utils';
import api from '#api/client';
import config from '#config';

注意事项与常见问题

  • 仅限本包内使用:其他项目 import 'your-pkg/#utils' 不生效,imports 不参与跨包解析
  • 不兼容 CommonJS require(除非用 ESM 加载器或 createRequire),建议统一使用 ESM
  • 路径必须存在且可解析:若 ./src/utils/index.js 不存在,运行时会抛出 ERR_MODULE_NOT_FOUND
  • 不能覆盖内置模块名:如 "#fs": "node:fs/promises" 是允许的,但 "fs": "node:fs/promises"(无 #)会报错
  • 与 exports 字段协同使用更规范:用 exports 控制对外暴露,用 imports 管理内部组织

对比其他方案(如 tsconfig paths / vite alias)

imports 是 Node.js 原生标准,不依赖 TypeScript 编译、构建工具或运行时插件,所有符合规范的 Node 环境(v14.13+)均可直接识别。而 tsconfig.json 的 paths 仅作用于 TS 类型检查和编译,Vite/Webpack 的 alias 属于构建时重写,均无法保证运行时行为一致。使用 imports 能真正实现“所写即所运”。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

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

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

5146

2023.06.20

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

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

1269

2023.07.04

js四舍五入
js四舍五入

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

5064

2023.07.04

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

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

980

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1916

2023.09.04

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

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

3605

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4693

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

3080

2023.09.20

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
快速入门Node.JS全套完整版
快速入门Node.JS全套完整版

共83课时 | 13.4万人学习

nodejs开发基础教程
nodejs开发基础教程

共15课时 | 4.9万人学习

JavaScript设计模式视频教程
JavaScript设计模式视频教程

共28课时 | 6.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn