next-safe-action 项目中的嵌套对象验证支持解析

背景介绍

next-safe-action 是一个用于 Next.js 应用的安全操作处理库，它提供了强大的表单验证功能。在最新版本中，开发者遇到了关于嵌套对象验证支持的需求，特别是在处理复杂表单结构时。

问题分析

在开发过程中，用户经常需要处理包含嵌套对象的表单结构。例如，一个用户注册表单可能同时包含用户基本信息和地址信息。传统实现方式存在以下挑战：

1. 无法直接使用嵌套的 Zod 验证模式
2. 现有的错误处理机制不支持嵌套对象结构
3. 需要将复杂表单拆分为多个独立操作，失去了事务性处理的优势

技术实现演进

初始方案的限制

next-safe-action 在 v6 版本中采用了 TypeSchema 作为底层验证引擎，这带来了更广泛的验证库支持，但也失去了直接使用 Zod 的 format() 或 flatten() 方法的能力。初始的错误处理实现存在以下问题：

• 对于嵌套对象会产生重复的错误信息
• 错误对象结构不够清晰
• 无法正确处理可选嵌套字段

解决方案探索

开发团队考虑了两种主要方案：

1. 原始问题数组方案：直接返回验证库产生的原始问题数组

   • 优点：提供最精确的错误信息
   • 缺点：使用较为复杂，需要手动处理路径解析

2. 模拟 Zod 的 format() 方案：构建类似 Zod 的错误格式化结构

   • 优点：与现有 API 风格一致，便于集成
   • 缺点：实现复杂度较高

最终团队选择了第二种方案，因为它提供了更好的开发者体验和向后兼容性。

技术实现细节

错误对象结构设计

新的验证错误对象采用了与 Zod 的 format() 方法相似的结构：

{
  fieldName: {
    _errors: string[]
  },
  nestedObject: {
    nestedField: {
      _errors: string[]
    }
  }
}

这种结构支持任意深度的嵌套，同时保持了类型安全性。

可选字段处理

对于可选嵌套对象，团队特别处理了类型推断问题。通过改进类型定义：

export type SchemaErrors<S> = {
  [K in keyof S]?: S[K] extends object | null | undefined
    ? Extend<ErrorList & SchemaErrors<S[K]>>
    : ErrorList;
} & {};

确保了可选字段也能正确推断错误类型。

实际应用示例

假设有以下用户注册表单结构：

const schema = z.object({
  user: z.object({
    name: z.string().min(1),
    email: z.string().email()
  }),
  address: z.object({
    street: z.string().min(1),
    city: z.string().min(1)
  }).optional()
});

验证失败时，错误对象将呈现为：

{
  user: {
    name: {
      _errors: ["String must contain at least 1 character(s)"]
    }
  },
  address: {
    street: {
      _errors: ["String must contain at least 1 character(s)"]
    }
  }
}

最佳实践建议

1. 复杂表单设计：对于包含多个实体的表单，推荐使用嵌套对象结构
2. 可选字段处理：明确标记可选字段，确保类型系统能正确推断
3. 错误展示：前端可以递归遍历错误对象，构建对应的UI反馈
4. 事务处理：利用单一操作处理多个相关实体，确保数据一致性

总结

next-safe-action 在 v7 版本中通过模拟 Zod 的 format() 方法，实现了对嵌套对象验证的全面支持。这一改进使得开发者能够更自然地处理复杂表单结构，同时保持了良好的类型安全性和开发者体验。特别值得注意的是对可选嵌套字段的处理，解决了实际开发中的常见痛点。