TypeBox 库中的模式验证与自定义约束实现

TypeBox 是一个强大的 TypeScript 模式验证库，它提供了灵活的类型定义和验证功能。本文将深入探讨如何在 TypeBox 中实现类似 Zod 库中的 refine 功能，以及如何优雅地处理验证过程中的错误。

基础验证与解析

TypeBox 提供了基本的模式验证功能。我们可以通过 TypeCompiler.Compile() 方法创建一个类型检查器，然后使用它来验证数据：

import { Type, TypeCompiler } from '@sinclair/typebox'

const schema = Type.Object({
  name: Type.String(),
  age: Type.Number()
})

const checker = TypeCompiler.Compile(schema)
const errors = [...checker.Errors(data)]

实现自定义约束

虽然 TypeBox 本身没有直接提供 refine 功能，但我们可以通过组合 Transform 和 Decode 来实现类似效果：

import { Type, TTransform } from '@sinclair/typebox'
import { Value } from '@sinclair/typebox/value'

function Refine<T extends TSchema>(
  schema: T, 
  refine: (value: StaticEncode<T>) => boolean,
  options: { message?: string } = {}
): TTransform<T, StaticEncode<T>> {
  const Throw = (): never => { throw new Error(options.message ?? '验证失败') }
  const Assert = (value: StaticEncode<T>): StaticEncode<T> => 
    refine(value) ? value : Throw()
  
  return Type.Transform(schema)
    .Decode(value => Assert(value))
    .Encode(value => Assert(value))
}

完整的解析流程

为了实现完整的解析流程，包括默认值设置、类型转换和清理，我们可以创建一个 Parse 函数：

function Parse<T extends TSchema>(schema: T, value: unknown): StaticDecode<T> {
  const defaulted = Value.Default(schema, value)
  const converted = Value.Convert(schema, defaulted)
  const cleaned = Value.Clean(schema, converted)
  return Value.Decode(schema, cleaned)
}

错误处理与收集

在表单验证等场景中，我们通常需要收集所有验证错误而不仅仅是第一个错误。TypeBox 提供了错误收集功能：

class ParseError extends Error {
  constructor(public readonly errors: ValueError[]) {
    super()
  }
}

function SafeParse<T extends TSchema>(schema: T, value: unknown) {
  try {
    return { success: true, data: Parse(schema, value) }
  } catch(error) {
    if (error instanceof ParseError) {
      return { success: false, errors: error.errors }
    }
    throw error
  }
}

未来发展方向

TypeBox 正在考虑原生支持 refine 功能，可能会采用链式调用的设计：

const T = Type.Refine(Type.Number())
  .Check(value => value >= 0, '值必须大于0')
  .Check(value => value < 255, '值必须小于255')
  .Done()

这种设计既保持了代码的可读性，又支持多个约束条件的组合。

实际应用建议

在实际应用中，特别是表单验证场景，建议：

1. 尽可能使用 TypeBox 内置的约束（如 maxLength、minimum 等）
2. 对于复杂约束，合理使用 refine 功能
3. 设计友好的错误信息展示机制
4. 考虑性能因素，避免在 refine 函数中执行昂贵操作

TypeBox 提供了强大的模式验证基础，通过合理的扩展和组合，可以满足各种复杂的验证需求。