ArkType 类型校验中的错误上下文增强实践

在 TypeScript 类型校验库 ArkType 的实际应用中，开发者经常会遇到需要为校验错误添加额外上下文信息的需求。本文将通过一个典型场景，介绍如何在 ArkType 中优雅地实现错误上下文增强。

问题背景

当我们在处理来自数据库或 API 的用户数据时，基础的校验错误信息往往不足以快速定位问题。例如，当校验以下用户数据时：

const User = type({ name: "string", age: "number" })
const userFoo = { name: "foo" } // 缺少 age 字段

默认情况下，ArkType 会返回类似"age must be a number (was missing)"的错误信息。但在实际业务场景中，我们可能还需要知道这是哪个用户的记录，或者发生在哪个请求上下文中。

解决方案探索

1. 基础包装函数方案

最直接的解决方案是创建一个包装函数，在捕获校验错误后添加自定义上下文：

const assertWithContext = <T extends type.Any>(
  t: T,
  data: unknown,
  errorContext: string
): T["infer"] => {
  const out = t(data)
  if (out instanceof type.errors) {
    throw new Error(`${errorContext} ${out.summary}`)
  }
  return out
}

// 使用示例
assertWithContext(User, userFoo, "用户ID 1234: ")

这种方案的优点是简单直接，但缺点是会丢失 ArkType 原生错误对象的结构和额外信息。

2. 配置自定义错误消息

ArkType 提供了更优雅的内置解决方案 - 通过配置自定义错误消息模板：

const User = type({ name: "string", age: "number" }).configure({
  message: ctx => `请求ID 1337: ${ctx.propString} ${ctx.problem}`
})

// 抛出错误示例: "请求ID 1337: age must be a number (was missing)"
User.assert(userFoo)

这种方式利用了 ArkType 的内置配置能力，其中：

• ctx.propString 返回属性路径描述
• ctx.problem 返回具体问题描述

进阶实践

对于更复杂的场景，我们可以结合两种方案的优势：

function createContextualValidator<T extends type.Any>(
  t: T,
  contextResolver: () => string
) {
  return {
    assert: (data: unknown) => {
      const out = t(data)
      if (out instanceof type.errors) {
        throw new Error(`${contextResolver()} ${out.summary}`)
      }
      return out as T["infer"]
    },
    // 可以继续添加其他需要的方法
  }
}

// 使用示例
const currentRequestValidator = createContextualValidator(
  User,
  () => `[请求ID: ${getCurrentRequestId()}]`
)

最佳实践建议

1. 生产环境：推荐使用配置自定义错误消息的方案，保持错误结构的统一性
2. 开发环境：可以使用包装函数方案，便于快速调试和定位问题
3. 动态上下文：对于需要运行时确定上下文信息的场景，可以结合闭包实现动态上下文注入

ArkType 的灵活配置机制为类型校验错误的上下文增强提供了多种可能性，开发者可以根据具体场景选择最适合的方案。