0

0

如何在 Joi 中复用已有 Schema 的属性而不继承验证规则?

花韻仙語

花韻仙語

发布时间:2026-01-05 18:49:02

|

616人浏览过

|

来源于php中文网

原创

如何在 Joi 中复用已有 Schema 的属性而不继承验证规则?

本文介绍如何使用 joi 的 `keys()` 方法安全复用基础对象 schema 的字段定义,避免意外继承 `.xor()`、`.messages()` 等链式配置,实现灵活、可组合的 schema 扩展。

在 Joi 中,Schema 实例是不可变(immutable)的,每次调用 .xor()、.messages()、.requiredKeys() 等方法都会返回一个全新 Schema 实例,而非修改原实例。因此,直接对已配置 .xor() 和 .messages() 的 baseSchema 调用 .keys() 或 .append() 时,新 Schema 仍会携带原始链式配置——这正是用户遇到“xor 和 messages 被重复应用”的根本原因。

✅ 正确做法是:先定义纯净的字段结构(即仅含 Joi.object({ ... })),再分别添加验证逻辑(如 .xor()、.messages())

以下是推荐的结构化写法:

千音漫语
千音漫语

全能AI配音神器

下载
// ✅ Step 1: 定义纯字段 Schema(无验证逻辑)
const baseFields = Joi.object({
  a: Joi.string().trim().empty(null, ''),
  b: Joi.string().guid().empty(null),
});

// ✅ Step 2: 复用字段并扩展新属性(.keys() 仅覆盖/合并 keys,不继承链式规则)
const extendedFields = baseFields.keys({
  c: Joi.string().trim(),
});

// ✅ Step 3: 分别添加业务级约束(解耦字段定义与验证逻辑)
const firstSchema = baseFields.xor('a', 'b').messages({
  'object.missing': 'One of "a", "b" is required.',
  'object.xor': 'Only one of "a", "b" is allowed.',
});

const secondSchema = extendedFields.xor('a', 'b', 'c').messages({
  'object.missing': 'One of "a", "b", "c" is required.',
  'object.xor': 'Only one of "a", "b", "c" is allowed.',
});

⚠️ 注意事项:

  • ❌ 避免 const baseSchema = Joi.object({...}).xor(...).messages(...); 后再调用 .keys() —— 此时 baseSchema 已携带链式状态,.keys() 返回的新 Schema 仍会继承 .xor() 和 .messages()。
  • ✅ Joi.object().keys({...}) 是“纯净起点”,它仅设置字段结构,不引入任何验证约束,是复用的最佳基底。
  • ? 若需多次复用(如 baseFields → adminSchema / publicSchema),可统一从 baseFields 派生,确保字段一致性与可维护性。

这种模式不仅解决了当前的复用问题,更符合 Joi 的设计哲学:将 Schema 结构(shape)与验证行为(behavior)分离,提升代码可读性、可测试性与协作效率。

相关专题

更多
c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

520

2023.09.20

append用法
append用法

append是一个常用的命令行工具,用于将一个文件的内容追加到另一个文件的末尾。想了解更多append用法相关内容,可以阅读本专题下面的文章。

342

2023.10.25

python中append的用法
python中append的用法

在Python中,append()是列表对象的一个方法,用于向列表末尾添加一个元素。想了解更多append的更多内容,可以阅读本专题下面的文章。

1067

2023.11.14

python中append的含义
python中append的含义

本专题整合了python中append的相关内容,阅读专题下面的文章了解更多详细内容。

171

2025.09.12

java学习网站推荐汇总
java学习网站推荐汇总

本专题整合了java学习网站相关内容,阅读专题下面的文章了解更多详细内容。

6

2026.01.08

java学习网站汇总
java学习网站汇总

本专题整合了java学习网站相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.01.08

正则表达式 删除
正则表达式 删除

本专题整合了正则表达式删除教程大全,阅读专题下面的文章了解更多详细教程。

20

2026.01.08

java 元空间 永久代
java 元空间 永久代

本专题整合了java中元空间和永久代的区别,阅读专题下面的文章了解更多详细内容。

3

2026.01.08

java 永久代和元空间
java 永久代和元空间

本专题整合了java中元空间和永久代的区别,阅读专题下面的文章了解更多详细内容。

0

2026.01.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java 教程
Java 教程

共578课时 | 43.5万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号