精进TypeScript--优选接口的联合,而不是联合的接口

本文讨论了在TypeScript中,如何通过使用精确的接口联合和标签联合类型来改进接口设计,以避免混淆和提高代码的可维护性。作者建议为不同类型的图层创建单独接口,并利用类型标签来明确属性间的关系,以利用TypeScript的类型检查功能。
摘要由CSDN通过智能技术生成

如果你创建的一个属性是联合类型的接口,你应该问一下这个类型作为更精确的接口的联合是否更有意义

要记住的事情:

  • 具有多个属性对于联合类型的接口通常是一个错误的选择,因为它们掩盖了这些属性之间的关系
  • 接口的联合更精确,且可以被 TypeScript 所理解

假设你正在构建一个矢量绘图程序,并希望为具有特定几何类型的图层定义一个接口。

interface Layer {
  layout: FillLayout | LineLayout | PointLayout;
  paint: FillPaint | LinePaint | PointPaint;
}

字段layout控制形状的绘制方式和位置(是圆角还是直角),而 paint 字段控制样式(线条颜色、粗细、虚实等)

如果有一个图层,它的 layout 是 LineLayout,但它的 paint 属性是FillPaint,这样有意义吗?可能没有意义,允许这种可能性会使得使用库时更容易出错,并且使这个接口难以使用。

一个更好的建模方式是为每一种类型的图层提供单独的接口:

interface FillLayer {
  layout: FillLayout;
  paint: FillPaint;
}
interface LineLayer {
  layout: LineLayout;
  paint: LinePaint;
}
interface PointLayer {
  layout: PointLayout;
  paint: PointPaint;
}
type Layer = FillLayer | LineLayer | PointLayer;

以这种方式定义 Layer,你就可以排除混合 layout 和 point 属性的可能性。

这种模式最常见的例子是 “标签联合类型”,在这种情况下,其中一个属性是字符串字面量类型的联合:

interface FillLayer {
  type: 'fill';
  layout: FillLayout;
  paint: FillPaint;
}
interface LineLayer {
  type: 'line';
  layout: LineLayout;
  paint: LinePaint;
}
interface PointLayer {
  type: 'point';
  layout: PointLayout;
  paint: PointPaint;
}
type Layer = FillLayer | LineLayer | PointLayer;

type 属性就是“标签”,可以用来确定你在运行时处理的 Layer 是哪种类型。TypeScript 也能够根据标签来收缩 Layer 的类型:

function drawLayer(layer: Layer) {
  if (layer.type === 'fill') {
    const {paint} = layer; // FillPaint
    const {layout} = layer; // FillLayout
  } else if (layer.type === 'line') {
    const {paint} = layer; // LinePaint
    const {layout} = layer; // LineLayout
  } else {
    const {paint} = layer; // PointPaint
    const {layout} = layer; // PointLayout
  }
}

通过正确地对这个类型中属性之间的关系进行建模,你可以帮助 TypeScript 检查你的代码的正确性。但是使用同样的代码初始化 Layer 会被类型断言弄得杂乱无章。

因为标签联合类型与 TypeScript 的类型检查器配合得很好,所以它们在 TypeScript 代码中是无处不在的。你要了解这个模式,并在合适的时候应用它。

如果你把可选字段视为它们的类型和 undefined 的联合类型,那么它们也适合这种模式。考虑一下这个类型:

interface Person {
  name: string;
  palceOfBirth?: string; // 这些要么存在、要么不存在
  dateOfBirth?: Date;
}

一个带有类型信息的注释是表明可能存在问题的强烈信号。在 palceOfBirth和 dateOfBirth 字段之间可能存在一个你还有告诉 TypeScript 的关系。

一个更好的建模方式是将这两个属性移动到一个对象中。这类似于将null移动到边界上:

interface Person {
  name: string;
  birth?: {
    place: string;
    date: Date;
  }
}

如果类型的结构不在你的控制范围内(例如,一个 API 接口),那么你仍然可以使用现在很熟悉的接口的联合来建模这些字段之间的关系:

interface Name {
  name: string;
}

interface PersonWithBirth extends Name {
  placeOfBirth: string;
  dateOfBirth: Date;
}

type Person = Name | PersonWithBirth;
// 这样的好处:
function eulogize(p: Person) {
  if ('placeOfBirth' in p) {
    const {dateOfBirth} = p; // OK,类型是 Date
  }
}

在这两种情况下,类型定义使属性之间的关系更加清晰。

vue-typescript-import-dts 是一个用于为 Vue.js 项目中的 TypeScript 文件生成类型声明文件的工具。在 Vue.js 项目中使用 TypeScript 进行开发时,我们经常需要为一些第三方库或自定义组件编写类型声明文件,以提供更好的代码提示和类型检查。 使用 vue-typescript-import-dts 工具可以自动分析 TypeScript 文件中的导入语句,并根据导入的模块生成对应的类型声明文件。这样,在使用该模块时,IDE 或编辑器就能提供准确的代码补全和类型检查。 例如,假设我们的项目中使用了一个名为 axios 的第三方库进行网络请求,但是该库并没有提供类型声明文件。我们可以通过 vue-typescript-import-dts 工具,在我们的 TypeScript 文件中导入 axios,并正确配置工具,它将自动为我们生成一个 axios.d.ts 类型声明文件。 具体使用 vue-typescript-import-dts 的步骤如下: 1. 在项目中安装 vue-typescript-import-dts,可以使用 npm 或 yarn 命令来安装。 2. 在 TypeScript 文件中,使用 import 语句导入需要生成类型声明文件的模块。 3. 在项目根目录下创建一个 .vue-typescript-import-dts.json 配置文件,用来配置生成类型声明文件的规则。可以指定生成的声明文件的输出路径、文件名等。 4. 运行 vue-typescript-import-dts 命令,它会自动扫描 TypeScript 文件中的导入语句,并根据配置生成相应的类型声明文件。 这样,在我们编写代码时,IDE 或编辑器就可以准确地为我们提供代码补全和类型检查的功能。这对于提高开发效率和代码质量非常有帮助。 总之,vue-typescript-import-dts 是一个便捷的工具,可以自动为 Vue.js 项目中使用的第三方库或自定义组件生成类型声明文件,提供更好的代码提示和类型检查功能。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

~卷心菜~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值