Zod库中自定义验证器的异步支持问题解析

在Zod 3.24.1版本中，开发者在使用z.custom创建自定义验证器时遇到了一个关于异步验证的重要问题。这个问题揭示了Zod在处理异步自定义验证时的一个功能缺陷，但幸运的是在3.24.2版本中得到了修复。

问题背景

当开发者尝试使用z.custom创建异步验证逻辑时，发现即使验证函数返回false，验证仍然会通过。这显然不符合预期行为，特别是在需要进行数据库查询等异步操作的验证场景中。

技术细节分析

问题的核心在于z.custom验证器最初设计时没有正确处理Promise返回值。在示例代码中，开发者试图通过异步查询数据库来验证用户ID是否存在：

export const userId = z.custom<`${string}`>(async (val) => {
  if (!val || typeof val !== 'string') {
    return false;
  }
  const targetUser = await User.findOne({ uid: val });
  return targetUser ? val : false;
}, "User is not found from userid.");

尽管逻辑上看起来正确，但由于z.custom没有等待Promise解析，导致验证结果不准确。

解决方案

在讨论过程中，有开发者建议使用z.refine作为替代方案，因为z.refine已经支持异步验证。这是一个可行的临时解决方案，但并不能完全替代z.custom的功能需求。

最终，Zod维护者在3.24.2版本中修复了这个问题，使z.custom能够正确处理异步验证函数。这意味着开发者现在可以安全地在z.custom中使用async/await语法。

最佳实践建议

1. 对于需要进行异步验证的场景，确保使用Zod 3.24.2或更高版本
2. 在自定义验证器中，明确处理各种边界情况（如空值、类型不匹配等）
3. 对于复杂的验证逻辑，考虑将其分解为多个简单的验证步骤
4. 为验证器提供清晰明确的错误信息，方便调试和用户反馈

总结

这个问题的发现和解决过程展示了开源社区协作的价值。开发者遇到问题后积极反馈，社区成员提供临时解决方案，最终维护者快速响应并修复问题。对于使用Zod进行表单验证和数据校验的开发者来说，这个修复使得异步自定义验证变得更加可靠和直观。