TypeScript 总览 - TypeScript
TypeScript 总览
像TypeScript这样的类型系统可以在编译时,通过静态分析检测出很多常见错误。这减少了生产环境中的运行时错误,也让我们在重构大型项目的时候更有信心。通过 IDE 中基于类型的自动补全,TypeScript还改善了开发体验和效率。
Vue 本身就是用TypeScript编写的,并对TypeScript提供了头等的支持。所有的 Vue 官方库都提供了类型声明文件,开箱即用。
项目配置
create-vue,即官方的项目脚手架工具,提供了搭建基于Vite且TypeScript就绪的 Vue 项目的选项。
总览
在基于Vite
的配置中,开发服务器和打包器将只会对TypeScript文件执行语法转译,而不会执行任何类型检查,这保证了Vite
开发服务器在使用TypeScript时也能始终保持飞快的速度。
- 在开发阶段,我们推荐你依赖一个好的IDE 配置来获取即时的类型错误反馈。
- 对于单文件组件,你可以使用工具
vue-tsc
在命令行检查类型和生成类型声明文件。vue-tsc是对TypeScript自身命令行界面tsc的一个封装。它的工作方式基本和tsc一致。除了TypeScript文件,它还支持 Vue 的单文件组件。 - vue-tsc目前还不支持
watch
模式,但这已经在计划之中。与此同时,如果你想要类型检查成为dev
命令的一部分,可以看看vite-plugin-checker
。 - Vue CLI也提供了对TypeScript的支持,但是已经不推荐了。详见下方的说明。
IDE 支持
强烈推荐 Visual Studio Code (VSCode),因为它对TypeScript有着很好的内置支持。
- Vue Language Features(Volar)是 vue 官方的 VSCode 扩展,提供了 Vue 单文件组件中的TypeScript支持,还伴随着一些其他非常棒的特性。
- TypeScript Vue Plugin(Volar)用于支持在 TS 中 import *.vue文件。⚠️建议使用Vue Language Features(Volar)托管模式(Take Over Mode)而不是这个插件。
WebStorm对TypeScript和 Vue 也都提供了开箱即用的支持。其他的 JetBrains IDE 也同样可以通过一个免费插件支持。
配置tsconfig.json
通过create-vue
搭建的项目包含了预置的tsconfig.json。其底层配置抽象于@vue/tsconfig
包中。在项目内我们使用 Project References 来确保运行在不同环境下的代码的类型正确(比如应用代码 vs.测试代码)。
在手动配置tsconfig.json时,请留意以下选项:
compilerOptions.isolatedModules
被设置为了true,因为 Vite 使用esbuild
来转译TypeScript,并受限于单文件转译的限制。- 如果你正在使用选项式 API,需要将
compilerOptions.strict
设置为true(或者至少开启compilerOptions.noImplicitThis
,它是strict
模式的一部分),才可以获得对组件选项中this
的类型检查。否则this
会被认为是any
。 - 如果你在构建工具中配置了路径解析别名,例如
@/*
这个别名被默认配置在了create-vue
项目中,你需要通过compilerOptions.paths
选项为TypeScript再配置一遍。
托管模式(Take Over Mode)
这一章节仅针对 VSCode + Volar(Vue Language Features)插件。为了让 Vue 单文件组件和TypeScript一起工作,Volar 创建了一个针对 Vue 的 TS 语言服务实例,将其用于 Vue 单文件组件。同时,普通的 TS 文件依然由 VSCode 内置的 TS 语言服务来处理。这也是为什么我们需要安装TypeScript Vue Plugin来支持在 TS 文件中引入 Vue 单文件组件。这套默认设置能够工作,但在每个项目里我们都运行了两个语言服务实例:一个来自 Volar,一个来自 VSCode 的内置服务。这在大型项目里可能会带来一些性能问题。
为了优化性能,Vue Language Features(Volar)插件,提供了一个叫做【托管模式】(Take Over Mode)的功能。在托管模式下(Take Over Mode),Volar 使用单个 TS 语言服务实例,同时为.vue和.ts文件提供支持。
要开启托管模式,你需要执行以下步骤来在你的项目的工作空间中,禁用 VSCode 的内置 TS 语言服务:
- 在当前项目的工作空间下,用
Ctrl + Shift + P
(macOS:Cmd + Shift + P
)唤起命令面板。 - 输入
built
,然后选择“Extensions:Show Built-in Extensions”。 - 在插件搜索框内输入TypeScript(不要删除
@builtin
前缀)。 - 点击“TypeScript and JavaScript Language Features”右下角的小齿轮,然后选择“Disable(Workspace)”。
- 重新加载工作空间。托管模式将会在你打开一个 Vue 或者 TS 文件时自动启用。
对 Vue CLI 和ts-loader
的说明
在像 Vue CLI 这样的基于 webpack 搭建的项目中,一般是在模块转换的管道中执行类型检查,例如使用ts-loader
。然而这并不是一个简洁的解决方案,因为类型系统需要了解整个模块关系才能执行类型检查。单个模块的转换步骤并不适合该任务。这导致了下面的问题:
ts-loader
只能对转换后的代码执行类型检查,这和我们在 IDE 或vue-tsc
中看到的可以映射回源代码的错误并不一致。- 类型检查可能会很慢。当它和代码转换在相同的线程/进程中执行时,它会显著影响整个应用程序的构建速度。
- 我们已经在 IDE 中通过单独的进程运行着类型检查了,因此这一步降低了开发体验但没有带来足够的收益。
如果你正通过 Vue CLI 使用 Vue 3 和TypeScript,我们强烈建议你迁移到 Vite。我们也在为 CLI 开发仅执行 TS 语法转译的选项,以允许你切换至vue-tsc
来执行类型检查。
常见使用说明
defineComponent()
当使用 当使用 要在单文件组件中使用TypeScript,需要在 在使用了 可以使用内联类型强制转换解决此问题: TIP:如果正在使用 Vue CLI 或基于 webpack 的配置,支持模板内表达式的TypeScript需要在单文件组件中的用法
{{ count.toFixed(2) }}
lang="ts"
也可以用于 {{ count.toFixed(2) }}
模板中的TypeScript
{{ x.toFixed(2) }}
{{ (x as number).toFixed(2) }}
vue-loader@^16.8.0
。
鹏仔微信 15129739599 鹏仔QQ344225443 鹏仔前端 pjxi.com 共享博客 sharedbk.com
图片声明:本站部分配图来自网络。本站只作为美观性配图使用,无任何非法侵犯第三方意图,一切解释权归图片著作权方,本站不承担任何责任。如有恶意碰瓷者,必当奉陪到底严惩不贷!