TypeBox 中处理动态键名对象的最佳实践

TypeBox 是一个强大的 TypeScript 运行时类型检查库，它允许开发者定义和验证数据结构。在实际开发中，我们经常会遇到需要处理带有动态键名的对象的情况，比如查询字符串中的条件参数（如 where.name=John 或 orderby.age=desc）。本文将深入探讨在 TypeBox 中处理这类需求的最佳实践。

动态键名对象的挑战

在 REST API 设计中，查询字符串经常包含动态参数，例如：

/search?where.name=John&where.age=25&orderby.createdAt=desc

传统上，我们可以使用 Type.Record 结合 Type.TemplateLiteral 来定义这类模式：

const whereClause = Type.TemplateLiteral([
  Type.Literal('where.'),
  Type.String()
])

const orderByClause = Type.TemplateLiteral([
  Type.Literal('orderby.'),
  Type.String()
])

const schema = Type.Intersect([
  Type.Object({
    search: Type.Optional(Type.String())
  }),
  Type.Record(whereClause, Type.String()),
  Type.Record(orderByClause, Type.String())
])

然而，这种方法会生成使用 allOf 的 JSON Schema，在某些框架（如 Fastify）中可能影响性能。

使用 patternProperties 的解决方案

更高效的解决方案是直接使用 patternProperties，这可以通过以下方式实现：

export const CommonQueryString = Type.Object({
  search: Type.Optional(Type.String()),
  fields: Type.Optional(Type.String()),
  page: Type.Optional(Type.Number({ minimum: 1 })),
  pageSize: Type.Optional(Type.Number({ minimum: 1 })),
}, {
  additionalProperties: false,
  patternProperties: {
    '^where.(.*)': Type.String(),
    '^orderby.(.*)': Type.String(),
  }
})

这种方法生成的 JSON Schema 更加紧凑，性能也更好。同时，我们可以通过 TypeScript 的类型系统增强类型安全：

export type CommonQueryString = Static<typeof CommonQueryString> & 
  Record<`where.${string}`, string> &
  Record<`orderby.${string}`, string>

高级工具类型

对于更复杂的场景，我们可以创建一个 ObjectExtended 工具类型，它能够将多个 TObject 和 TRecord 类型合并为一个：

export type ObjectExtended<T extends TSchema[], Acc extends unknown = unknown> = (
  T extends [infer L extends TSchema, ...infer R extends TSchema[]]
    ? ObjectExtended<R, Acc & Static<L>>
    : TUnsafe<Evaluate<Acc>>
)

function ObjectExtended<T extends TObject, R extends TRecord[]>(
  object: T, 
  records: [...R]
): ObjectExtended<[T, ...R]> {
  const patternProperties = records.reduce((acc, c) => 
    ({...acc, ...c.patternProperties }), {})
  return { ...object, patternProperties } as never
}

使用示例：

const schema = ObjectExtended(Type.Object({
  search: Type.Optional(Type.String())
}, [
  Type.Record(Type.TemplateLiteral('where.${string}'), Type.String()),
  Type.Record(Type.TemplateLiteral('orderby.${string}'), Type.String())
])

性能考量与最佳实践

1. 优先使用 Type.Intersect：虽然 Type.Composite 在某些情况下性能更好，但官方建议优先使用 Type.Intersect，因为未来可能会有 Type.Evaluate 来优化这类场景。

2. 避免过度使用动态属性：虽然动态属性很灵活，但过度使用会使 API 文档难以生成和理解。

3. 考虑使用专用字段：对于常见的过滤和排序需求，考虑使用专用字段（如 filter 和 sort）而不是动态键名，这样 API 会更易于维护。

未来发展方向

TypeBox 作者提到未来可能会引入 Type.Evaluate 类型，它能够将复杂的类型组合（如 Type.Intersect）"展平"为简单的 TObject 类型，从而在不牺牲类型安全性的前提下提高性能。

const A = Type.Object({ a: Type.Number() })
const B = Type.Object({ b: Type.Number() })
const I = Type.Intersect([A, B])

// 未来可能的 API
const C = Type.Evaluate(I) // 生成 TObject<{ a: TNumber, b: TNumber }>

通过本文介绍的技术，开发者可以在 TypeBox 中高效地处理动态键名对象，同时保持代码的类型安全和运行时验证能力。