TypeScript 中 Webpack 怎么配置模块解析路径的 alias 别名

浅墨吖_9123

浅墨吖_9123

2026-07-30

410人浏览

原创

必须同时配置 webpack 的 resolve.alias 和 typescript 的 tsconfig.json 中 baseurl 与 paths,前者用于构建时路径替换,后者用于编辑器提示和编译解析;css/scss 中使用别名需加 ~ 前缀。

typescript 中 webpack 怎么配置模块解析路径的 alias 别名

要在 TypeScript 项目中让 Webpack 正确识别路径别名(alias),必须同时配置 Webpack 和 TypeScript 两套系统——Webpack 负责构建时路径替换,TypeScript 负责编辑器提示和编译时路径解析,缺一不可。

Webpack 配置 resolve.alias

在 webpack.config.js(或 Vue CLI 的 vue.config.js)中设置绝对路径映射:

  • 使用 path.resolve(__dirname, 'src') 获取真实绝对路径,避免相对路径导致跨平台问题
  • 别名键建议用 @、@utils、@comps 等语义化前缀,不与 npm 包重名
  • 值必须是完整绝对路径,不能写 ./src 或 src
  • Vue CLI 项目需通过 chainWebpack 修改 alias,且改完要重启 dev server

示例(webpack.config.js):

const path = require('path');
module.exports = {
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src'),
      '@comps': path.resolve(__dirname, 'src/components'),
      '@api': path.resolve(__dirname, 'src/api')
    },
    extensions: ['.ts', '.tsx', '.js', '.json']
  }
};

tsconfig.json 配置 baseUrl 和 paths

TypeScript 编译器不会读取 Webpack 的 alias,必须单独配置 tsconfig.json:

Add Typescript Best Practices
Add Typescript Best Practices

在 CLAUDE.md 中配置 TypeScript 最佳实践和代码风格规则

下载
  • baseUrl 设为 "."(项目根目录),作为所有别名路径的基准点
  • paths 中的 key 是别名模式(如 @/*),value 是相对于 baseUrl 的数组路径
  • 注意:如果 baseUrl 设为 "src",那 paths 就要写成 {"*": ["*"]},但更推荐统一设为 "."

示例(tsconfig.json):

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"],
      "@comps/*": ["src/components/*"],
      "@api/*": ["src/api/*"]
    }
  }
}

CSS/SCSS 中引用别名资源要加 ~

在样式文件里使用 alias 引入图片或字体时,Webpack 默认不识别裸别名,必须加 ~ 前缀:

  • ✅ 正确:background: url('~@/assets/logo.png');
  • ❌ 错误:background: url('@/assets/logo.png');(会被当成普通字符串)
  • 这是 Webpack 的 css-loader 规则,与 JS/TS 无关,仅作用于 .css、.scss 等样式文件

其他配套项不能漏

确保开发体验完整,还需检查以下几处:

  • VS Code 或其他编辑器需重启,才能识别新配置的别名跳转和自动补全
  • 如果用了 eslint 或 tslint,可能需要配置 import/resolver 插件,否则会报“无法解析模块”警告
  • 运行时 Node 环境(如 Jest 测试)若用别名,需额外引入 tsconfig-paths/register
  • 别名结尾带 $(如 react$)可精确匹配完整模块名,避免意外命中子路径

相关专题

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

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

2023.06.20

4626

5

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

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

2023.07.04

1149

3

js四舍五入
js四舍五入

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

2023.07.04

4564

6

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

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

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1816

5

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

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

2023.09.04

3305

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4293

6

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

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

2023.09.20

2800

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

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

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习