当前位置:首页 > 文章列表 > 文章 > 前端 > Zod替代Yup设置全局错误提示

Zod替代Yup设置全局错误提示

2025-08-15 11:21:27 0浏览 收藏

哈喽!大家好,很高兴又见面了,我是golang学习网的一名作者,今天由我给大家带来一篇《Zod 全局错误提示设置替代 Yup 的 setLocale》,本文主要会讲到等等知识点,希望大家一起学习进步,也欢迎大家关注、点赞、收藏、转发! 下面就一起来看看吧!

Zod 中设置全局错误消息:替代 Yup 的 setLocale 方法

本文将介绍如何在 Zod 中实现类似 Yup 的 setLocale 功能,用于设置全局自定义错误消息,特别是针对国际化 (i18n) 的场景。Zod 提供了 z.setErrorMap 方法来实现自定义错误映射,并推荐使用 zod-i18n 库来集成 i18next 实现国际化错误消息。本文将详细介绍如何使用这两种方法,并提供示例代码。

Zod 是一个流行的 TypeScript 优先的 schema 声明和验证库。与 Yup 类似,它允许你定义数据的结构和类型,并验证数据是否符合这些定义。但是,Zod 没有像 Yup 那样的 setLocale 方法来全局设置错误消息。不过,Zod 提供了 z.setErrorMap 方法,可以实现类似的功能。

使用 z.setErrorMap 自定义错误消息

z.setErrorMap 允许你定义一个函数,该函数接收一个 issue 对象和一个 ctx 对象作为参数,并返回一个包含自定义错误消息的对象。issue 对象包含了关于验证错误的详细信息,例如错误代码和预期类型。ctx 对象包含了上下文信息,例如默认错误消息。

以下是一个示例,展示了如何使用 z.setErrorMap 来自定义错误消息:

import { z } from "zod";

const customErrorMap: z.ZodErrorMap = (issue, ctx) => {
  if (issue.code === z.ZodIssueCode.invalid_type) {
    if (issue.expected === "string") {
      return { message: "必须是字符串!" };
    }
  }
  if (issue.code === z.ZodIssueCode.custom) {
    return { message: `最小值应大于 ${(issue.params || {}).minimum}` };
  }
  return { message: ctx.defaultError };
};

z.setErrorMap(customErrorMap);

const schema = z.string().min(5);

const result = schema.safeParse("abc");

if (!result.success) {
  console.log(result.error.issues);
}

在这个例子中,我们定义了一个名为 customErrorMap 的函数,它根据 issue.code 和 issue.expected 属性来返回不同的错误消息。如果 issue.code 是 z.ZodIssueCode.invalid_type 并且 issue.expected 是 "string",则返回 "必须是字符串!" 错误消息。如果 issue.code 是 z.ZodIssueCode.custom,则返回一个基于 issue.params 的自定义错误消息。否则,返回默认错误消息。

使用 zod-i18n 进行国际化

对于国际化 (i18n) 的场景,Zod 官方推荐使用 zod-i18n 库。zod-i18n 是一个 Zod 的扩展,它允许你使用 i18next 来翻译错误消息。

首先,你需要安装 zod-i18n 和 i18next:

npm install zod-i18n i18next

然后,你需要配置 i18next 并加载你的语言翻译文件。以下是一个示例:

import i18next from "i18next";
import { z } from "zod";
import { zodI18nMap } from "zod-i18n-map";
import translation from "zod-i18n-map/locales/zh-CN/zod.json"; // 引入中文翻译

i18next.init({
  lng: "zh-CN", // 设置语言
  resources: {
    "zh-CN": { zod: translation }, // 加载翻译文件
  },
});

z.setErrorMap(zodI18nMap);

const schema = z.string().email();

try {
  schema.parse("foo");
} catch (error) {
  if (error instanceof z.ZodError) {
    console.log(error.errors); // 输出中文错误信息
  }
}

在这个例子中,我们首先初始化 i18next,设置语言为 "zh-CN",并加载中文翻译文件。然后,我们使用 z.setErrorMap(zodI18nMap) 来设置错误映射。最后,我们定义一个 schema 并尝试解析一个无效的 email 地址。如果解析失败,我们将输出中文错误信息。

注意事项:

  • 确保你的翻译文件包含所有 Zod 错误代码的翻译。
  • zod-i18n 依赖于 i18next,因此你需要正确配置 i18next。
  • zod-i18n 提供了多种语言的翻译文件,你可以根据需要选择使用。

总结

虽然 Zod 没有像 Yup 那样的 setLocale 方法,但你可以使用 z.setErrorMap 方法来自定义错误消息。对于国际化场景,zod-i18n 库是一个不错的选择,它可以让你轻松地使用 i18next 来翻译错误消息。通过结合 z.setErrorMap 和 zod-i18n,你可以实现灵活且可定制的错误处理,从而提高应用程序的用户体验。

好了,本文到此结束,带大家了解了《Zod替代Yup设置全局错误提示》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!

async函数内存泄漏怎么解决async函数内存泄漏怎么解决
上一篇
async函数内存泄漏怎么解决
Golang数据库错误处理与SQL包解析
下一篇
Golang数据库错误处理与SQL包解析
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    511次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    498次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • 千音漫语:智能声音创作助手,AI配音、音视频翻译一站搞定!
    千音漫语
    千音漫语,北京熠声科技倾力打造的智能声音创作助手,提供AI配音、音视频翻译、语音识别、声音克隆等强大功能,助力有声书制作、视频创作、教育培训等领域,官网:https://qianyin123.com
    169次使用
  • MiniWork:智能高效AI工具平台,一站式工作学习效率解决方案
    MiniWork
    MiniWork是一款智能高效的AI工具平台,专为提升工作与学习效率而设计。整合文本处理、图像生成、营销策划及运营管理等多元AI工具,提供精准智能解决方案,让复杂工作简单高效。
    169次使用
  • NoCode (nocode.cn):零代码构建应用、网站、管理系统,降低开发门槛
    NoCode
    NoCode (nocode.cn)是领先的无代码开发平台,通过拖放、AI对话等简单操作,助您快速创建各类应用、网站与管理系统。无需编程知识,轻松实现个人生活、商业经营、企业管理多场景需求,大幅降低开发门槛,高效低成本。
    172次使用
  • 达医智影:阿里巴巴达摩院医疗AI影像早筛平台,CT一扫多筛癌症急慢病
    达医智影
    达医智影,阿里巴巴达摩院医疗AI创新力作。全球率先利用平扫CT实现“一扫多筛”,仅一次CT扫描即可高效识别多种癌症、急症及慢病,为疾病早期发现提供智能、精准的AI影像早筛解决方案。
    176次使用
  • 智慧芽Eureka:更懂技术创新的AI Agent平台,助力研发效率飞跃
    智慧芽Eureka
    智慧芽Eureka,专为技术创新打造的AI Agent平台。深度理解专利、研发、生物医药、材料、科创等复杂场景,通过专家级AI Agent精准执行任务,智能化工作流解放70%生产力,让您专注核心创新。
    188次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码