0
点赞
收藏
分享

微信扫一扫

创建基于 TS 的 React 项目与类型声明文件

boomwu 2022-05-03 阅读 113

目录

1. 创建基于 TS 的 React 项目

2. tsconfig 的介绍 

3. 类型声明文件介绍

4. TS 的两种文件类型

5. 类型声明文件-内置

6. 类型声明文件-第三方库 

7. 类型声明文件-自定义 

8. 类型声明文件的使用说明

9. 类型声明文件的总结

1. 创建基于 TS 的 React 项目

目标:能够使用 CRA 创建基于 TS 的项目

内容

创建基于 TS 的 React 项目命令:npx create-react-app react-ts --template typescript

说明:在命令行中,添加 --template typescript 表示创建支持 TS 的项目

相比 JS 的 React 项目,目录的变化:

  1. 在项目根目录中多了一个文件:tsconfig.json(TS 的配置文件)
  2. 在 src 目录中,文件的后缀有变化,由原来的 .js 变为 .ts 或 .tsx
    • .ts ts 文件的后缀名
    • .tsx 是在 TS 中使用 React 组件时的后缀。只要代码中出现 JSX 结构,就得使用该后缀
  3. 在 src 目录中,多了 react-app-env.d.ts 文件
    • .d.ts 类型声明文件,用来指定类型
    • 注意:不要动 src/react-app-env.d.ts 文件!!!

2. tsconfig 的介绍 

目标:能够知道 tsconfig 的作用

内容

  • tsconfig.json 是 TS 项目的配置文件,可以用来指定如何编译 TS 代码等
  • 手动创建 tsconfig.json 配置文件的命令:tsc --init
  • 说明:所有的配置项都可以通过鼠标移入的方式,来查看配置项的解释说明
  • tsconfig 文档链接
{
  // 编译选项
  "compilerOptions": {
    // 生成代码的语言版本:将我们写的 TS 代码编译成哪个版本的 JS 代码
    "target": "es5",
    // 指定要包含在编译中的 library
    // https://github.com/microsoft/TypeScript/blob/90e83adb44/lib/lib.dom.iterable.d.ts
    "lib": ["dom", "dom.iterable", "esnext"],
    // 允许 ts 编译器编译 js 文件
    "allowJs": true,
    // 跳过类型声明文件的类型检查
    "skipLibCheck": true,
    // es 模块 互操作,屏蔽 ESModule 和 CommonJS 之间的差异
    "esModuleInterop": true,
    // 允许通过 import x from 'y' 即使模块没有显式指定 default 导出
    "allowSyntheticDefaultImports": true,
    // 开启严格模式
    "strict": true,
    // 对文件名称强制区分大小写
    "forceConsistentCasingInFileNames": true,
    // 为 switch 语句启用错误报告
    "noFallthroughCasesInSwitch": true,
    // 生成代码的模块化标准
    "module": "esnext",
    // 模块解析(查找)策略
    "moduleResolution": "node",
    // 允许导入扩展名为.json的模块
    "resolveJsonModule": true,
    // 是否将没有 import/export 的文件视为旧(全局而非模块化)脚本文件
    "isolatedModules": true,
    // 编译时不生成任何JS文件(只进行类型检查)
    "noEmit": true,
    // 指定将 JSX 编译成什么形式
    "jsx": "react-jsx"
  },
  // 指定允许 ts 处理的目录
  "include": ["src"]
}

3. 类型声明文件介绍

今天几乎所有的 JavaScript 应用都会引入许多第三方库来完成任务需求。

这些第三方库不管是否是用 TS 编写的,最终都要编译成 JS 代码,才能发布给开发者使用。

我们知道是 TS 提供了类型,才有了代码提示和类型保护等机制。

但在项目开发中使用第三方库时,你会发现它们几乎都有相应的 TS 类型,这些类型是怎么来的呢? 类型声明文件

  • 类型声明文件:用来为已存在的 JS 提供类型信息

这样在 TS 项目中使用这些库时,就像用 TS 一样,都会有代码提示、类型保护等机制了。

4. TS 的两种文件类型

目标:能够说出 TS 中的两种文件类型

内容

  • TS 中有两种文件类型:1 .ts 文件 2 .d.ts 文件
  • .ts 文件:
    1. 既包含类型信息又包含可执行代码
    2. 可以被编译为 .js 文件,然后,执行代码
    3. 用途:编写程序代码的地方
  • .d.ts 文件:
    1. 只包含类型信息的类型声明文件
    2. 不会生成 .js 文件,仅用于提供类型信息,在.d.ts 文件中不允许出现可执行的代码,只用于提供类型
    3. 用途:为 JS 提供类型信息

总结

  • .ts 是 implementation(代码实现文件)

  • .d.ts 是 declaration(类型声明文件)

  • 如果要为 JS 提供类型信息,要使用 .d.ts 文件

5. 类型声明文件-内置

目标:能够知道数组的类型提示是由内置类型声明文件提供的类型

内容

TS 为 JS 运行时可用的所有标准化内置 API 都提供了声明文件

比如,在使用数组时,数组所有方法都会有相应的代码提示以及类型信息:

const strs = ['a', 'b', 'c'];
// 鼠标放在 forEach 上查看类型
strs.forEach;

可以通过 Ctrl + 鼠标左键(Mac:Command + 鼠标左键)来查看内置类型声明文件内容

实际上,这就是 TS 提供的内置类型声明文件提供的类型信息

  • 比如,查看 forEach 方法的类型声明,在 VSCode 中会自动跳转到 lib.es5.d.ts 类型声明文件中
  • 当然,像 window、document 等 BOM、DOM API 也都有相应的类型声明(lib.dom.d.ts

6. 类型声明文件-第三方库 

目标:能够安装第三方库的类型声明文件

内容

目前,几乎所有常用的第三方库都有相应的类型声明文件

第三方库的类型声明文件有两种存在形式:1 库自带类型声明文件 2 由 DefinitelyTyped 提供

  1. 库自带类型声明文件:比如,axios

    • 查看 node_modules/axios 目录
    • 解释:这种情况下,正常导入该库,TS 就会自动加载库自己的类型声明文件,以提供该库的类型声明
    • VSCode 中如何找到它的类型声明文件?就是在 import 导入包的时候,会读取 axios 的 package.json 中的 types 字段,来加载指定的类型声明文件
  2. 由 DefinitelyTyped 提供

    • DefinitelyTyped 是一个 github 仓库,用来提供高质量 TypeScript 类型声明,DefinitelyTyped 链接
    • 可以通过 npm/yarn 来下载该仓库提供的 TS 类型声明包,这些包的名称格式为:@types/*,比如,@types/react、@types/lodash 等
    • 在实际项目开发时,如果你使用的第三方库没有自带的声明文件,VSCode 会给出明确的提示
import _ from 'lodash';

// 在 VSCode 中,鼠标移上去,查看 'lodash' 前面的提示
  • 解释:当安装 @types/* 类型声明包后,TS 也会自动加载该类声明包,以提供该库的类型声明
  • 补充:TS 官方文档提供了一个页面,可以来查询 @types/_ 库,@types/_ 库

7. 类型声明文件-自定义 

目标:能够手动创建一个类型声明文件来提供类型

内容

在项目开发中,有两种常见情况,需要自己手动创建类型声明文件:1 项目内共享类型 2 为已有 JS 文件提供类型声明

  1. 项目内共享类型

    • 如果多个 .ts 文件中都用到同一个类型,此时可以创建 .d.ts 文件提供该类型,实现类型共享

    • 操作步骤:

      1. 创建 index.d.ts 类型声明文件

      2. 创建需要共享的类型,并使用 export 导出(TS 中的类型也可以使用 import/export 实现模块化功能)

      3. 在需要使用共享类型的 .ts 文件中,通过 import 导入即可(.d.ts 后缀导入时,直接省略)

  2. 为已有 JS 文件提供类型声明

    1. 在将 JS 项目迁移到 TS 项目时,为了让已有的 .js 文件有类型声明
    2. 成为库作者,创建库给其他人使用

8. 类型声明文件的使用说明

  • 说明 1:TS 项目中也可以使用 .js 文件
  • 说明 2:在导入 .js 文件时,TS 会自动加载与 .js 同名的 .d.ts 文件,以提供类型声明
    • 比如,在 导入 index.js 时,会自动加载 index.d.ts 类型声明文件
  • declare 关键字:用于类型声明,为其他地方(比如,.js 文件)已存在的变量声明类型,而不是创建一个新的变量
    1. 对于 type、interface 等这些明确就是 TS 类型的(只能在 TS 中使用的),可以省略 declare 关键字
    2. 对于 let、function 等具有双重含义(在 JS、TS 中都能用),应该使用 declare 关键字,明确指定此处用于类型声明

假设有以下 .js 文件需要在 TS 代码中使用:

// utils.js 文件:

let count = 10;
let songName = '痴心绝对';
let position = {
  x: 0,
  y: 0,
};

function add(x, y) {
  return x + y;
}

function changeDirection(direction) {
  console.log(direction);
}

const fomartPoint = (point) => {
  console.log('当前坐标:', point);
};

export { count, songName, position, add, changeDirection, fomartPoint };

创建上面 .js 文件的类型声明文件:

// utils.d.ts 文件:

declare let count: number;
declare let songName: string;

// position 变量
interface Position {
  x: number;
  y: number;
}
declare let position: Position;

// add 函数
declare function add(x: number, y: number): number;

// changeDirection 函数
type Direction = 'left' | 'right' | 'top' | 'bottom';
declare function changeDirection(direction: Direction): void;

// fomartPoint 函数
type FomartPoint = (point: Position) => void;
declare const fomartPoint: FomartPoint;

export {
  count,
  songName,
  position,
  add,
  changeDirection,
  FomartPoint,
  fomartPoint,
};

在文件中导入上述 .js 文件,查看是否有类型提示: 

import {
  count,
  songName,
  position,
  add,
  changeDirection,
  FomartPoint,
  fomartPoint,
} from './utils';

9. 类型声明文件的总结

类型声明文件出现目的:为 JS 文件提供类型声明

类型声明文件的后缀:.d.ts

类型声明文件中只应该出现类型,不要有任何的实现(区别于 .ts 文件)

使用类型声明文件:只需要关注一种情况,没有自带类型声明文件的第三方库,VSCode 在发现没有类型声明文件时,会给出提示,我们只需要按照提示来安装类型声明文件即可: yarn add @types/* 来安装即可。

举报

相关推荐

0 条评论