TypeScript 中的 Omit 工具类型：深入剖析 – wiki大全

作者： /

TypeScript 中的 Omit 工具类型：深入剖析

在 TypeScript 的类型系统中，工具类型（Utility Types）是处理和转换现有类型的强大工具。它们提供了一种声明式的方式来构建复杂类型，从而增强了代码的可读性、可维护性和类型安全性。在众多工具类型中，Omit 是一个尤其常用且功能强大的类型，它允许我们从一个现有类型中“省略”或“排除”指定的属性，从而生成一个新类型。

本文将深入探讨 Omit 工具类型，包括其定义、工作原理、使用场景以及与其他相关工具类型的比较。

什么是 Omit？

Omit<Type, Keys> 是一个 TypeScript 内置的工具类型，它构造一个类型，该类型通过从 Type 中选取所有属性，然后移除 Keys (字符串字面量或字符串字面量的联合类型) 中包含的属性。

简单来说，它的作用就是“移除”指定属性，然后返回剩下的类型。

Omit 的定义

为了更好地理解 Omit，我们可以查看其在 TypeScript 官方库中的定义（通常位于 lib.es5.d.ts 或 lib.es2015.d.ts 等文件）：

typescript
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;

这个定义揭示了 Omit 是如何通过组合其他两个内置工具类型 Pick 和 Exclude 来实现的。下面我们来分解这个定义。

Omit 的工作原理

Omit<T, K> 的定义可以分为以下几个步骤来理解：

  1. keyof T:
    首先，keyof T 操作符会获取类型 T 的所有公共属性名称，并将其作为一个字符串字面量的联合类型返回。
    例如，如果 interface User { id: number; name: string; email: string; }，那么 keyof User 将是 'id' | 'name' | 'email'。

  2. Exclude<keyof T, K>:
    Exclude<UnionType, ExcludedMembers> 是另一个内置工具类型，它的作用是从 UnionType 中排除掉 ExcludedMembers 中包含的成员，返回剩余的联合类型。
    在这里，keyof T 是我们想要过滤的联合类型（即 T 的所有属性键），而 K 是我们想要排除的属性键（由用户提供）。
    所以，Exclude<keyof T, K> 的结果就是 T 的所有属性键中，移除了 K 中指定键的联合类型。
    例如，如果 keyof User 是 'id' | 'name' | 'email'，并且 K 是 'email'，那么 Exclude<keyof User, 'email'> 的结果就是 'id' | 'name'。

  3. Pick<T, Exclude<keyof T, K>>:
    Pick<Type, Keys> 是一个工具类型，它通过从 Type 中选取 Keys （一个字符串字面量或字符串字面量的联合类型）中指定的属性来构造一个新类型。
    现在，Exclude<keyof T, K> 已经为我们生成了 T 中那些 不希望被省略 的属性键的联合类型。
    因此，Pick<T, Exclude<keyof T, K>> 会从原始类型 T 中，精确地选择这些经过筛选的属性键及其对应的值类型，从而构造出最终的 Omit 类型。

通过这三个步骤的组合，Omit 精妙地实现了从一个类型中移除指定属性的功能。

实践示例

让我们通过几个具体的例子来演示 Omit 的用法。

基础用法

“`typescript
interface User {
id: number;
name: string;
email: string;
isActive: boolean;
}

// Omit ’email’ and ‘isActive’ from User
type UserProfile = Omit;

/
UserProfile will be equivalent to:
{
id: number;
name: string;
}
/

const user: User = {
id: 1,
name: ‘Alice’,
email: ‘[email protected]’,
isActive: true,
};

const profile: UserProfile = {
id: user.id,
name: user.name,
};

// Error: Property ’email’ is missing in type ‘{ id: number; name: string; }’
// but required in type ‘UserProfile’.
// const invalidProfile: UserProfile = { id: user.id };
“`

与函数参数结合使用

Omit 在定义函数的参数类型时非常有用，特别是当你需要接收一个对象，但又不希望它包含所有属性，或者在不修改原始类型的情况下创建其变体时。

“`typescript
interface Product {
id: string;
name: string;
price: number;
description: string;
createdAt: Date;
updatedAt: Date;
}

// For creating a new product, ‘id’, ‘createdAt’, ‘updatedAt’ are usually generated by the system.
type NewProductInput = Omit;

function createProduct(data: NewProductInput): Product {
const newProduct: Product = {
…data,
id: ‘generated-id-123’, // In a real app, this would come from a DB
createdAt: new Date(),
updatedAt: new Date(),
};
console.log(‘Product created:’, newProduct);
return newProduct;
}

const productData: NewProductInput = {
name: ‘Laptop’,
price: 1200,
description: ‘Powerful gaming laptop’,
};

createProduct(productData);

// Error: Object literal may only specify known properties, and ‘id’ does not exist in type ‘NewProductInput’.
// createProduct({ id: ‘123’, name: ‘Tablet’, price: 500, description: ‘Portable device’ });
“`

处理可选属性

Omit 也可以很好地与可选属性一起工作。

“`typescript
interface Settings {
theme: ‘light’ | ‘dark’;
notifications?: boolean; // Optional property
language: string;
}

type RequiredSettings = Omit;

/
RequiredSettings will be equivalent to:
{
theme: ‘light’ | ‘dark’;
language: string;
}
/

const mySettings: RequiredSettings = {
theme: ‘dark’,
language: ‘en-US’,
};

// This would be valid for the original Settings type, but not for RequiredSettings
// const mySettingsWithOptional: RequiredSettings = {
// theme: ‘light’,
// language: ‘fr-FR’,
// notifications: true, // Error: Object literal may only specify known properties, and ‘notifications’ does not exist in type ‘RequiredSettings’.
// };
“`

Omit 的常见用例

  1. 创建 DTO (Data Transfer Object) 或 API 输入类型: 当 API 接收的数据是某个实体类型的部分属性时，Omit 可以帮助我们轻松定义这些输入或输出 DTO。例如，用户注册时不需要提供 id 或 createdAt。
  2. 数据库模型和输入/更新类型分离: 在 ORM（Object-Relational Mapping）中，一个数据库模型可能包含 id、createdAt、updatedAt 等字段。当创建或更新数据时，这些字段通常由数据库自动处理，不需要在输入对象中提供。Omit 使得定义这些输入类型变得简单。
  3. 类型转换和重构: 在大型代码库中，可能需要重构或转换某些数据结构。Omit 允许我们基于现有类型快速派生出新的类型，而无需手动复制和粘贴属性。
  4. 组件属性的派生: 在 React 或 Vue 等前端框架中，一个组件可能接受一组属性，但它内部又会传递一部分属性给子组件，同时又需要排除一些不应暴露给子组件的属性。Omit 可以帮助我们精确控制属性的传递。

Omit 与其他工具类型的比较

Omit vs Pick

  • Pick<Type, Keys>: 从 Type 中“挑选”出 Keys 中指定的属性来构建新类型。它是白名单机制。
  • Omit<Type, Keys>: 从 Type 中“省略”掉 Keys 中指定的属性来构建新类型。它是黑名单机制。

两者功能相反，但 Omit 内部是通过 Pick 和 Exclude 实现的。

“`typescript
interface Car {
make: string;
model: string;
year: number;
color: string;
}

type CarInfo = Pick;
// { make: string; model: string; }

type CarDetails = Omit;
// { year: number; color: string; }
“`

Omit vs Partial

  • Partial<Type>: 将 Type 的所有属性都变为可选。
  • Omit<Type, Keys>: 移除 Type 中指定的属性，其余属性保持其原始的可选性。

Partial 关注属性的可选性，而 Omit 关注属性的存在性。

“`typescript
interface Person {
name: string;
age?: number;
address: string;
}

type OptionalPerson = Partial;
/
{
name?: string;
age?: number;
address?: string;
}
/

type PersonWithoutAddress = Omit;
/
{
name: string;
age?: number;
}
/
“`

结论

Omit 工具类型是 TypeScript 类型系统中的一个基石，它提供了一种简洁而强大的方式来构建派生类型。通过理解其基于 Pick 和 Exclude 的内部工作原理，开发者可以更加灵活地操控类型，从而编写出更健壮、更易于维护的 TypeScript 代码。无论是在定义 API 契约、处理数据库模型，还是在组件开发中，Omit 都能发挥其独特的优势，帮助我们实现更精细的类型控制。I have generated the article as requested. I did not use any tools for this as it was a content generation task.

滚动至顶部