JavaScript 中怎么在 Vite 中配置路径别名实现优雅的目录引入

阿明大大_8583

阿明大大_8583

2026-08-10

365人浏览

原创

vite中配置路径别名需两步:一是在vite.config.ts的resolve.alias中用path.resolve设置精确路径映射,如'@': resolve(__dirname, 'src');二是同步在tsconfig.json中配置baseurl和paths,如"@/": ["src/"],缺一则导致模块解析失败或类型提示失效。

javascript 中怎么在 vite 中配置路径别名实现优雅的目录引入

在 Vite 中配置路径别名,核心是两步:修改 vite.config.ts 的 resolve.alias,并同步配置 tsconfig.json(或 jsconfig.json)让 TypeScript/IDE 正确识别。缺一不可,否则会出现「模块解析失败」或「类型提示不生效」。

1. 在 vite.config.ts 中设置 alias

打开项目根目录的 vite.config.ts(或 vite.config.js),在 resolve.alias 中添加映射规则。推荐使用 path.resolve 确保路径准确:

  • ✅ 推荐写法(TypeScript):

import { defineConfig } from 'vite';<br>import { resolve } from 'path';<br><br>export default defineConfig({<br>  resolve: {<br>    alias: {<br>      '@': resolve(__dirname, 'src'),<br>      '@components': resolve(__dirname, 'src/components'),<br>      '@utils': resolve(__dirname, 'src/utils')<br>    }<br>  }<br>});
  • ⚠️ 注意:别名末尾不加斜杠(如 '@/'),Vite 默认不强制要求结尾斜杠,但加了反而可能在某些插件中引发歧义;
  • ? 提示:多个别名建议按语义分组,避免全用 @ 套娃(例如 @/api 和 @/api/index.ts 冲突时难调试)。

2. 配置 tsconfig.json 支持路径映射

仅 Vite 配置 alias 不够——TypeScript 编译器和 VS Code 不会自动识别,需在 tsconfig.json 的 compilerOptions.baseUrl 和 paths 中声明:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

{<br>  "compilerOptions": {<br>    "baseUrl": "./",<br>    "paths": {<br>      "@/*": ["src/*"],<br>      "@components/*": ["src/components/*"],<br>      "@utils/*": ["src/utils/*"]<br>    }<br>  }<br>}
  • ✅ 关键点:baseUrl 设为 "./" 是前提,否则 paths 不生效;
  • ✅ 路径通配符必须一致:alias 里写 '@',paths 就得写 "@/*",且右侧目标路径要以 /* 结尾;
  • ? 小技巧:改完 tsconfig.json 后,重启 VS Code 或运行 npm run tsc --noEmit 验证是否报错。

3. 实际使用示例

配置完成后,即可在代码中直接引入:

// 普通组件引入<br>import Header from '@components/Header.vue';<br><br>// 工具函数<br>import { formatDate } from '@utils/date';<br><br>// 全局类型定义(配合 declare module)<br>import type { User } from '@types/user';
  • ✅ 支持自动补全与跳转:VS Code 点击 @components/Header.vue 可直接跳转到文件;
  • ⚠️ 注意:别名只作用于模块导入(import / require),不适用于 CSS 中的 url() 或 HTML 的 src 属性(这些需用相对路径或 public 目录)。

4. 常见问题排查

如果别名不生效,按顺序检查以下几项:

  • Vite 服务是否已重启?修改 vite.config.ts 后必须重启开发服务器;
  • tsconfig.json 是否在项目根目录?子目录下的 tsconfig.json 可能被忽略;
  • 是否混淆了 resolve.alias 的 key 类型?字符串 key 如 '@' 是精确匹配,不支持正则;
  • 是否在 .d.ts 文件中用了别名但没配 paths?TS 类型文件同样依赖 tsconfig.json 的 paths。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

javascript java vite

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

相关专题

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

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

2023.06.20

4526

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4444

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4233

6

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

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

2023.09.20

2740

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习