首页
/ Type-Challenges中的PartialByKeys类型解析

Type-Challenges中的PartialByKeys类型解析

2025-05-02 10:12:27作者:俞予舒Fleming

在TypeScript类型编程中,PartialByKeys是一个实用类型,它能够将对象类型中的指定属性变为可选属性。本文将深入解析这个类型的实现原理和应用场景。

PartialByKeys类型的作用

PartialByKeys类型接收两个泛型参数:

  1. T:原始对象类型
  2. K:需要变为可选属性的键集合(必须是T的键的子集)

它的功能是将T类型中K指定的属性变为可选,同时保持其他属性不变。例如:

interface User {
  name: string;
  age: number;
  address: string;
}

type PartialUser = PartialByKeys<User, 'name' | 'age'>;
// 等价于:
// {
//   name?: string;
//   age?: number;
//   address: string;
// }

实现原理分析

给出的实现方案非常简洁:

type PartialByKeys<T, K extends keyof T = keyof T> = Omit<
  Omit<T, K> & Partial<Pick<T, K>>, 
  never
>

让我们分解这个实现:

  1. K extends keyof T = keyof T:设置K的默认值为T的所有键,这样当不传入K时,效果等同于Partial类型

  2. Omit<T, K>:从T中移除K指定的所有属性,得到一个不包含这些属性的新类型

  3. Partial<Pick<T, K>>:从T中选取K指定的属性,并将它们全部变为可选

  4. 将上述两个结果进行交叉类型(&)组合

  5. 最后用Omit<..., never>来展平交叉类型,使其成为一个普通的对象类型

技术细节

为什么需要两次Omit?

外层Omit的作用是类型展平。在TypeScript中,交叉类型会保留原始类型的结构信息。通过Omit<..., never>可以将其转换为一个普通的对象类型,这在某些情况下可以提高类型推断的准确性。

默认参数的作用

K extends keyof T = keyof T这个默认参数使得PartialByKeys在只传入一个参数时,行为与内置的Partial类型完全一致,提供了更好的API一致性。

应用场景

PartialByKeys在以下场景中特别有用:

  1. 表单处理:当需要处理部分更新的表单数据时,可以使用PartialByKeys来定义更新数据的类型

  2. API请求:在构建REST API客户端时,某些端点可能只需要更新资源的特定字段

  3. 配置对象:当某些配置项是可选的,而其他配置项是必填时

性能考虑

这个实现使用了多个内置工具类型(Omit、Partial、Pick),在复杂类型上可能会有一定的性能开销。对于大型对象类型,可以考虑直接映射类型实现:

type PartialByKeys<T, K extends keyof T = keyof T> = {
  [P in keyof T as P extends K ? never : P]: T[P];
} & {
  [P in K]?: T[P];
} extends infer O ? { [P in keyof O]: O[P] } : never;

这种实现方式在某些情况下可能会有更好的性能表现。

总结

PartialByKeys是一个强大的工具类型,它通过组合TypeScript内置的工具类型,实现了对对象属性可选性的精细控制。理解它的实现原理不仅有助于我们更好地使用它,也能提升我们的类型编程能力。在实际开发中,根据具体场景选择最合适的实现方式,可以编写出既灵活又类型安全的代码。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
861
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K