0

0

TypeScript中可选属性的类型收窄与判别联合

聖光之護

聖光之護

发布时间:2025-11-09 14:52:02

|

592人浏览过

|

来源于php中文网

原创

typescript中可选属性的类型收窄与判别联合

本文探讨了TypeScript中处理带有可选属性的对象时,即使进行了属性存在性检查,仍可能遇到“possibly 'undefined'”错误的问题。我们将深入分析为何`Object.hasOwn`或`in`操作符不足以进行类型收窄,并介绍如何通过使用判别联合(Discriminated Unions)这一强大的类型模式,来构建更安全、更可预测的代码,从而有效解决此类类型错误。

理解TypeScript中可选属性的类型收窄挑战

在TypeScript中,当一个接口或类型定义了可选属性(例如radius?: number),这意味着该属性可能存在且值为number,也可能根本不存在,或者存在但其值为undefined。即使我们使用Object.hasOwn()或in操作符来检查属性是否存在,TypeScript的类型检查器也无法自动将该属性的类型从number | undefined收窄为number。

考虑以下初始代码示例:

interface Shape {
  kind: "circle" | "square",
  radius?: number,
  sideLength?: number
}

function getArea(shape: Shape): number | undefined {
  if (shape.kind === "circle" && Object.hasOwn(shape, "radius")) {
    // 'shape.radius' is possibly 'undefined'. ts(18048)
    return Math.PI * shape.radius**2;
  }
  else if (shape.kind === "square" && "sideLength" in shape) {
    // 'shape.sideLength' is possibly 'undefined'. ts(18048)
    return shape.sideLength**2;
  }
  return undefined;
}

在这个例子中,尽管我们明确检查了shape对象是否拥有radius或sideLength属性,TypeScript编译器仍然报告'shape.radius' is possibly 'undefined'的错误。这是因为Object.hasOwn()和in操作符只能确认属性是否存在于对象上,但它们无法保证该属性的值不是undefined。对于TypeScript而言,如果一个属性被定义为可选的 (?),那么它的类型就是T | undefined,即使属性存在,其值也可能是undefined。这种检查不足以让编译器确信radius或sideLength在计算时一定是一个number类型。

解决方案:利用判别联合(Discriminated Unions)

解决这类问题的最佳实践是使用判别联合(Discriminated Unions)。判别联合是一种强大的类型模式,它允许我们定义一个类型,该类型可以是几种不同类型之一,并且每种类型都有一个共同的、字面量类型的属性(称为判别式或辨别属性)。通过检查这个判别式属性的值,TypeScript能够智能地收窄到联合类型中的特定成员。

我们将Shape接口重构为判别联合类型:

type Shape =
  | {
      kind: 'circle';
      radius: number; // 'circle' 类型时,radius 必须存在且为 number
    }
  | {
      kind: 'square';
      sideLength: number; // 'square' 类型时,sideLength 必须存在且为 number
    };

在这个新的Shape类型定义中:

蛙蛙写作
蛙蛙写作

超级AI智能写作助手

下载
  • 我们不再使用可选属性。
  • kind属性作为判别式,其值可以是'circle'或'square'。
  • 当kind为'circle'时,radius属性被明确定义为number类型,并且是必需的。
  • 当kind为'square'时,sideLength属性被明确定义为number类型,并且是必需的。

通过这种方式,Shape类型的每个成员都明确了其所需的特定属性,并且这些属性不再是可选的。

实现判别联合进行类型收窄

现在,我们可以修改getArea函数来利用判别联合的特性。当我们在if语句中检查shape.kind时,TypeScript会自动将shape的类型收窄到联合类型中匹配的成员,从而消除“possibly 'undefined'”的错误。

type Shape =
  | {
      kind: 'circle';
      radius: number;
    }
  | {
      kind: 'square';
      sideLength: number;
    };

function getArea(shape: Shape): number { // 返回类型现在可以是 number,因为所有路径都保证了计算
  if (shape.kind === "circle") {
    // 在这里,TypeScript 知道 shape 的类型是 { kind: 'circle'; radius: number; }
    // 因此 shape.radius 必然是 number,不再是 undefined
    return Math.PI * shape.radius**2;
  } else { // 否则,shape.kind 必然是 "square"
    // 在这里,TypeScript 知道 shape 的类型是 { kind: 'square'; sideLength: number; }
    // 因此 shape.sideLength 必然是 number,不再是 undefined
    return shape.sideLength**2;
  }
}

// 示例使用
const myCircle: Shape = { kind: 'circle', radius: 10 };
const mySquare: Shape = { kind: 'square', sideLength: 5 };

console.log(`圆形面积: ${getArea(myCircle)}`); // 输出: 圆形面积: 314.1592653589793
console.log(`正方形面积: ${getArea(mySquare)}`); // 输出: 正方形面积: 25

在这个修正后的getArea函数中:

  • 当shape.kind === "circle"时,TypeScript能够智能地推断出shape的类型现在是{ kind: 'circle'; radius: number; }。因此,shape.radius被确认为number类型,ts(18048)错误消失。
  • 同理,在else分支中,shape.kind必然是"square",shape被收窄为{ kind: 'square'; sideLength: number; },shape.sideLength也因此被确认为number类型。
  • 由于所有路径现在都保证返回一个number,函数的返回类型也可以更精确地定义为number,而不是number | undefined,除非确实存在无法计算面积的情况。

总结与最佳实践

当您在TypeScript中处理具有不同结构但共享某些通用属性的对象集合时,判别联合是一种极其强大且优雅的解决方案。它不仅解决了可选属性带来的类型收窄问题,还带来了以下好处:

  1. 增强类型安全性: 编译器能够更准确地理解代码逻辑,在编译时捕获更多潜在的类型错误。
  2. 改善可读性与可维护性: 类型定义清晰地表达了不同数据形态之间的关系,使代码意图更明确。
  3. 优化开发体验: IDE能够提供更精确的自动补全和错误提示,提高开发效率。

通过将散布在接口中的可选属性重构为判别联合中每个成员的必需属性,我们能够利用TypeScript的控制流分析能力,实现更健壮、更可靠的类型检查。在设计复杂的类型结构时,优先考虑使用判别联合,能够有效避免因可选属性引起的“possibly 'undefined'”困扰。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

709

2023.08.22

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

987

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

44

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

25

2025.12.29

undefined是什么
undefined是什么

undefined是代表一个值或变量不存在或未定义的状态。它可以作为默认值来判断一个变量是否已经被赋值,也可以用于设置默认参数值。尽管在不同的编程语言中,undefined可能具有不同的含义和用法,但理解undefined的概念可以帮助我们更好地理解和编写程序。本专题为大家提供undefined相关的各种文章、以及下载和课程。

3843

2023.07.31

网页undefined是什么意思
网页undefined是什么意思

网页undefined是指页面出现了未知错误的意思,提示undefined一般是在开发网站的时候定义不正确或是转换不正确,或是找不到定义才会提示undefined未定义这个错误。想了解更多的相关内容,可以阅读本专题下面的文章。

2887

2024.08.14

网页undefined啥意思
网页undefined啥意思

本专题整合了undefined相关内容,阅读下面的文章了解更多详细内容。后续继续更新。

98

2025.12.25

Golang 命令行工具(CLI)开发实战
Golang 命令行工具(CLI)开发实战

本专题系统讲解 Golang 在命令行工具(CLI)开发中的实战应用,内容涵盖参数解析、子命令设计、配置文件读取、日志输出、错误处理、跨平台编译以及常用CLI库(如 Cobra、Viper)的使用方法。通过完整案例,帮助学习者掌握 使用 Go 构建专业级命令行工具与开发辅助程序的能力。

1

2025.12.29

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

162

2025.12.26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
TypeScript 教程
TypeScript 教程

共19课时 | 1.8万人学习

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

共21课时 | 1万人学习

TypeScript-45分钟入门
TypeScript-45分钟入门

共6课时 | 0.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号