讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

JavaScript中模块路径别名Alias在工程中的配置建议

胖强大大_3361

胖强大大_3361

发布时间:2026-03-18 11:35:15

|

836人浏览过

|

来源于php中文网

原创

模块路径别名应统一配置于构建工具原生入口并同步tsconfig.json的paths与baseUrl,推荐@/指向src/等语义化收敛命名,避免泛滥;Node运行时需额外借助tsconfig-paths或module-alias支持。

javascript中模块路径别名alias在工程中的配置建议

模块路径别名(Alias)能显著提升大型项目中 import 语句的可读性和可维护性,避免冗长、易出错的相对路径(如 ../../../utils/request)。但配置不当反而会带来构建异常、IDE 跳转失败、TS 类型提示丢失等问题。关键在于“统一、收敛、显式”——让别名在开发、构建、类型检查三个环节行为一致。

优先使用构建工具原生支持的 alias 配置

现代构建工具(Vite、Webpack、Rollup)都提供标准 alias 配置入口,应优先使用,而非依赖插件或 hack 方式:

  • Vite:在 vite.config.ts 的 resolve.alias 中定义,天然支持 TS 路径映射(配合 tsconfig.json 即可启用智能跳转和类型推导)
  • Webpack:在 resolve.alias 中配置,需同步更新 tsconfig.json 的 compilerOptions.paths,否则 TS 编译器无法识别
  • 不建议用 @rollup/plugin-alias 单独配置 Rollup 别名而不同步处理 TS 和 IDE 配置,容易导致类型检查与运行时路径不一致

别名命名需语义化且收敛,避免泛滥

别名不是越多越好,应聚焦高频、跨层级复用的目录,常见推荐模式:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • @/ → 指向 src/ 根目录(最通用,几乎所有项目都适用)
  • @/assets/ → src/assets/(静态资源)
  • @/components/ → src/components/(可复用 UI 组件)
  • @/hooks/ → src/hooks/(自定义 Hook)
  • 避免为每个子目录都设别名(如 @/components/button/、@/components/input/),这会增加记忆成本且违背别名“降噪”初衷

务必同步配置 tsconfig.json 的 paths 和 baseUrl

TypeScript 不读取构建工具的 alias,必须显式声明才能获得类型检查、自动导入和跳转支持:

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

  • 设置 "baseUrl": "."(或 "./src",需与实际源码根路径一致)
  • 在 "paths" 中严格对齐构建工具中的 alias 映射,例如:
    "@/*": ["src/*"]、"@/assets/*": ["src/assets/*"]
  • 确保 tsconfig.json 被 IDE(VS Code)和构建流程共同加载;若使用多配置(如 tsconfig.node.json),需分别配置对应 paths

警惕 Node.js 运行时场景(如 SSR、CLI 工具)的别名失效

Webpack/Vite 的 alias 仅在打包阶段生效,Node 直接运行的脚本(如 node scripts/build.js)默认不识别 @/ 等别名:

  • SSR 场景下,服务端代码需借助 ts-node + tsconfig-paths 注册别名支持
  • 纯 JS 运行时脚本可使用 module-alias(需 require hook 注入),但更推荐在 Node 环境中尽量用相对路径或明确的 process.cwd() 构建路径
  • CI/CD 中执行的脚本若涉及 TS 编译,应确保 ts-node -r tsconfig-paths/register 启动方式被正确使用

热门AI工具

更多
花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

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

豆包大模型

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

WorkBuddy

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

相关专题

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

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

5946

2023.06.20

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

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

1429

2023.07.04

js四舍五入
js四舍五入

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

5844

2023.07.04

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

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

1060

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

2036

2023.09.04

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

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

4025

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

5333

2023.09.12

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

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

3500

2023.09.20

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

100

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习

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

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