在现有的 Vue 项目中逐步引入 TypeScript 的类型检查

---

本文源于一道面试题：注：两种问法一个意思哈！！

问题一：“ 老项目Js写的，如何轻量方式享受 ts 类型？”
问题二：“如何 在现有的 Vue|JS 项目中是逐步引入 TypeScript 的类型检查”

---

在开发大型项目时，类型安全是一个非常重要的特性，它可以帮助开发者在编译时捕获潜在的错误，提高代码的质量和可维护性。如果你的现有 Vue 项目是基于纯 JavaScript 的，但你希望逐步引入 TypeScript 的类型检查，那么可以通过使用类型声明文件（.d.ts 文件）和 JSDoc 注解来实现，无需立即全面重构项目。这种方法允许你在保持项目稳定性的同时，逐步享受类型安全带来的好处。以下是详细的实现方法：

这里不了解 .d.ts 是什么的，可以快速了解一下 点击跳转！！

介绍

在 Vue 项目中引入 TypeScript 的类型检查，可以显著提升代码的可读性和可维护性。通过类型声明和注解，你可以在开发过程中获得即时的类型反馈，减少运行时错误。本文将介绍如何通过类型声明文件和 JSDoc 注解，在现有的 Vue 项目中逐步引入 TypeScript 的类型检查。

1. 使用类型声明文件（.d.ts）

类型声明文件是一种为现有的 JavaScript 文件提供类型信息的方法，而不需要改变文件的实际内容。通过创建 .d.ts 文件，你可以为模块、函数、变量等提供类型注解。

步骤：

1. 创建类型声明文件：

   在项目根目录或 src 目录下创建一个 types.d.ts 文件。这个文件将用于声明项目中 JavaScript 文件的类型信息。

2. 为 JavaScript 模块提供类型信息：

   在 types.d.ts 文件中，为需要类型检查的 JavaScript 文件提供类型声明。例如，如果你有一个 Vue 组件和一个数学工具模块，可以这样声明：

   // types.d.ts
   declare module '*.vue' {
     import { DefineComponent } from 'vue';
     const component: DefineComponent<{}, {}, any>;
     export default component;
   }
   
   declare module './utils/math' {
     export function add(a: number, b: number): number;
   }
   

   这段代码为所有的 .vue 文件和 ./utils/math 模块提供了类型声明。

3. 确保 TypeScript 编译器包含类型声明文件：

   在你的 tsconfig.json 文件中，确保 include 字段包含了你的类型声明文件。例如：

   {
     "include": [
       "src/**/*.ts",
       "src/**/*.d.ts",
       "src/**/*.vue"
     ]
   }
   

   这样，TypeScript 编译器在编译时会包含这些类型声明文件，从而进行类型检查。

2. 使用 JSDoc 注解

JSDoc 注解是一种在 JavaScript 文件中直接添加类型注解的方法。这些注解可以被 TypeScript 编译器理解，从而在 JavaScript 文件中提供类型检查。

步骤：

1. 在 JavaScript 文件中添加 JSDoc 注解：

   你可以在函数的注释中使用 JSDoc 注解来指定参数和返回值的类型。例如：

   /**
    * Adds two numbers.
    * @param {number} a - The first number.
    * @param {number} b - The second number.
    * @returns {number} The sum of the two numbers.
    */
   function add(a, b) {
     return a + b;
   }
   
   module.exports = { add };
   

   这段代码通过 JSDoc 注解为 add 函数提供了类型信息。

2. 确保 TypeScript 编译器理解 JSDoc 注解：

   默认情况下，TypeScript 编译器能够理解 JSDoc 注解。你只需要确保你的 .js 文件被包含在 tsconfig.json 的 include 字段中。这样，TypeScript 编译器在编译时会读取这些注解并进行类型检查。

高阶扩展

1. 为第三方库添加类型声明：

   如果你的项目中使用了第三方 JavaScript 库，而这些库没有提供 TypeScript 类型声明，你可以自己创建 .d.ts 文件来为这些库提供类型声明。这可以让你在使用这些库时享受到类型检查的好处。

2. 使用混合类型：

   TypeScript 允许你使用混合类型（Union Types）和交叉类型（Intersection Types）来组合多个类型。这可以让你更灵活地定义函数的参数和返回值类型。

3. 利用 TypeScript 的高级特性：

   TypeScript 提供了许多高级特性，如泛型、条件类型、映射类型等。这些特性可以让你更精确地定义类型，提高代码的可读性和可维护性。

4. 逐步迁移策略：

   你可以逐步为项目中的 JavaScript 文件添加类型注解，而不是一次性将整个项目重构为 TypeScript。这有助于在保持项目稳定性的同时，逐步引入类型安全性。你可以从核心模块或新功能开始，逐步向其他部分扩展。

对比

以下是一个对比表格，用于比较“一次性将 JavaScript 更换为 TypeScript”和“逐步迁移至 TypeScript”这两种方法：

	一次性将 JavaScript 更换为 TypeScript	逐步迁移至 TypeScript
转换速度	快速，一次性完成整个项目的转换	较慢，逐步进行，可能需要较长时间
项目稳定性风险	高，因为整个项目结构、语法和类型系统同时发生变化，可能引入大量错误	低，每次只修改一小部分代码，易于测试和验证
开发团队适应	团队需要快速适应 TypeScript 的语法和特性	团队可以逐步学习和适应 TypeScript，减轻学习压力
类型系统完整性	一开始就可以拥有完整的类型系统	类型系统逐步建立，可能初期不够完整
重构工作量	大量重构工作，可能需要重写大量代码	重构工作量分散，每次只针对一小部分代码
编译时间	初始编译时间可能较长，因为整个项目都需要类型检查	编译时间逐步增加，随着类型注解的添加而变长
回滚难度	如果转换出现问题，回滚到原始状态可能比较困难	易于回滚，因为每次只做了小范围修改
适合项目类型	适合新项目或小型项目，可以快速建立类型系统	适合大型项目或正在开发中的项目，可以保持项目稳定性

总结

通过类型声明文件和 JSDoc 注解，你可以在现有的 Vue 项目中逐步引入 TypeScript 的类型检查。这种方法允许你在不改变现有代码结构的情况下，享受类型安全带来的好处。同时，你还可以利用 TypeScript 的高级特性来进一步提高代码的质量和可维护性。逐步迁移策略则让你能够在保持项目稳定性的同时，逐步引入类型安全性。希望本文能够对你有所帮助，让你在 Vue 项目中更好地利用 TypeScript 的类型系统。

看到这里的小伙伴，欢迎点赞、评论，收藏！
下方添加好友，面试群等着您！