Zod 中合并多个 Schema 的类型推断问题解析

在 TypeScript 生态中，Zod 是一个流行的运行时类型验证库，它允许开发者定义数据模式并在运行时验证数据。然而，在使用 Zod 合并多个 schema 时，开发者可能会遇到类型推断不准确的问题。

问题背景

当开发者尝试使用 Zod 的 merge 方法合并多个 schema 时，期望得到的类型应该是所有 schema 属性的并集。例如：

const schema1 = z.object({ providerId: z.string() });
const schema2 = z.object({ serviceId: z.string() });
const schema3 = z.object({ date: z.date() });

const CombinedSchema = schema1.merge(schema2).merge(schema3);
type CombinedType = z.infer<typeof CombinedSchema>;

理想情况下，CombinedType 应该推断为：

{
  providerId: string;
  serviceId: string;
  date: Date;
}

但实际上，TypeScript 可能会推断出不完全正确的类型，如：

{
  [x: string]: any;
  serviceId?: unknown;
  date?: unknown;
}

问题原因

这个问题源于 TypeScript 在处理泛型方法链式调用时的局限性。当在泛型上下文中调用方法时，类型参数 T 会"坍缩"为其类型约束（这里是 ZodObject<any,any,any>），导致类型信息丢失。

解决方案

1. 显式指定返回类型

最直接的解决方案是显式指定合并后的返回类型：

function combineSchemas<T extends ZodObject<any>, U extends ZodObject<any>, V extends ZodObject<any>>(
  s1: T,
  s2: U,
  s3: V
): ZodObject<{
  [K in keyof T['shape']]: T['shape'][K];
} & {
  [K in keyof U['shape']]: U['shape'][K];
} & {
  [K in keyof V['shape']]: V['shape'][K];
}> {
  return s1.merge(s2).merge(s3);
}

2. 使用 Zod 内部工具类型

Zod 提供了一些内部工具类型，可以简化这个过程：

import { objectUtil, util } from 'zod';

function combineSchemas<T extends ZodObject<any>, U extends ZodObject<any>, V extends ZodObject<any>>(
  s1: T,
  s2: U,
  s3: V
): ZodObject<util.flatten<objectUtil.extendShape<objectUtil.extendShape<T['shape'], U['shape']>, V['shape']>>> {
  return s1.merge(s2).merge(s3);
}

3. 支持可变数量参数的解决方案

如果需要合并任意数量的 schema，可以实现一个更通用的解决方案：

type ShapesCombine<T extends AnyZodObject[]> = 
  T extends [infer A extends AnyZodObject, ...infer B extends AnyZodObject[]]
    ? A['shape'] & ShapesCombine<B>
    : {};

function combineSchemas<U extends AnyZodObject[]>(arr: U): ZodObject<util.flatten<ShapesCombine<U>>> {
  return arr.reduce((acc, step) => acc.merge(step), z.object({})) as any;
}

4. 使用交集类型

对于表单等场景，可以使用 z.intersection 方法：

function useMergedForm<Schema1 extends ZodObject<any>, Schema2 extends ZodObject<any>>(
  schema1: Schema1,
  schema2: Schema2,
  defaultsValues: DefaultValues<z.infer<Schema1> & z.infer<Schema2>>
) {
  const mergedSchema = z.intersection(schema1, schema2);
  // ...其他实现
}

最佳实践建议

1. 优先使用显式类型：当类型推断不准确时，显式指定类型通常是最可靠的解决方案。

2. 考虑使用 Zod 工具类型：Zod 提供的内部工具类型如 util.flatten 和 objectUtil.extendShape 可以简化复杂类型的处理。

3. 测试类型推断：在实现复杂类型操作后，应该验证类型推断是否符合预期。

4. 文档记录：对于团队共享的复杂类型工具函数，应该详细记录其行为和使用方法。

通过理解这些解决方案，开发者可以更有效地在 Zod 中处理多个 schema 的合并操作，确保类型推断的准确性。