为大型对象类型编写TypeScript类型谓词的最优方法是什么？

TypeScript文档仅提供了针对含单个方法的对象的类型谓词示例，但当目标类型包含大量字段时，逐个编写字段检查的类型谓词函数会非常繁琐且难以维护。比如下面的场景：

const oneOfLargeObjects: unknown = getRandomLargeObject();

if (isMyLargeObject(oneOfLargeObjects)) {
  // 处理 MyLargeObject 类型的逻辑
} else {
  // 处理其他大型对象的逻辑
}

对应的类型谓词函数如果要逐个检查字段，会像这样：

function isMyLargeObject(obj: unknown): obj is MyLargeObject {
  return (
    typeof obj?.strField === 'string' &&
    typeof obj?.numField === 'number' &&
    typeof obj?.boolField === 'boolean'
    // 还有大量其他字段检查
  );
}

以下是几种更易维护的替代方案：

1. 使用运行时类型验证库 #

像zod、io-ts这类库可以让你定义一次运行时schema，同时自动推导对应的TypeScript类型，无需手动编写每个字段的检查逻辑。以zod为例：

import { z } from "zod";

// 定义运行时schema，自动生成TypeScript类型
const MyLargeObjectSchema = z.object({
  strField: z.string(),
  numField: z.number(),
  boolField: z.boolean(),
  // 其他字段按需求定义
});

// 从schema中推导TypeScript类型
type MyLargeObject = z.infer<typeof MyLargeObjectSchema>;

// 类型谓词函数直接复用schema的验证逻辑
function isMyLargeObject(obj: unknown): obj is MyLargeObject {
  return MyLargeObjectSchema.safeParse(obj).success;
}

后续只需维护schema即可，schema和类型始终保持一致，避免了手动同步的麻烦。

2. 封装可复用的字段检查函数 #

如果不想引入第三方库，可以把重复的字段类型检查逻辑封装成小函数，减少代码冗余：

// 检查对象是否包含指定名称的字符串字段
function hasStringField(obj: unknown, fieldName: string): boolean {
  return typeof obj === 'object' && obj !== null && 
    typeof (obj as Record<string, unknown>)[fieldName] === 'string';
}

// 检查对象是否包含指定名称的数字字段
function hasNumberField(obj: unknown, fieldName: string): boolean {
  return typeof obj === 'object' && obj !== null && 
    typeof (obj as Record<string, unknown>)[fieldName] === 'number';
}

function isMyLargeObject(obj: unknown): obj is MyLargeObject {
  return (
    hasStringField(obj, 'strField') &&
    hasNumberField(obj, 'numField') &&
    hasNumberField(obj, 'boolField')
    // 其他字段调用对应检查函数
  );
}

这种方式虽然仍需列出所有字段，但检查逻辑集中维护，后续修改类型规则时只需调整封装的函数即可。

3. 拆分类型并组合类型守卫 #

如果大型对象可以拆分为多个子类型，可以为每个子类型单独编写类型守卫，再在主类型守卫中组合使用：

// 定义子类型
interface UserInfo {
  username: string;
  age: number;
}

// 子类型的类型守卫
function isUserInfo(obj: unknown): obj is UserInfo {
  return typeof obj === 'object' && obj !== null &&
    typeof (obj as UserInfo).username === 'string' &&
    typeof (obj as UserInfo).age === 'number';
}

// 主类型
interface MyLargeObject {
  id: string;
  status: number;
  user: UserInfo;
  // 其他字段...
}

// 主类型守卫组合子类型守卫
function isMyLargeObject(obj: unknown): obj is MyLargeObject {
  return typeof obj === 'object' && obj !== null &&
    typeof (obj as MyLargeObject).id === 'string' &&
    typeof (obj as MyLargeObject).status === 'number' &&
    isUserInfo((obj as MyLargeObject).user);
}

拆分后每个类型守卫的逻辑更简洁，也便于单独测试和维护。

内容的提问来源于stack exchange，提问作者Cagri Uysal