如何在 Joi Schema 中条件性移除特定字段(如 id)的验证规则

星枫同学_6992

星枫同学_6992

2026-09-08

587人浏览

原创

如何在 Joi Schema 中条件性移除特定字段(如 id)的验证规则

本文介绍在 Joi 中动态修改对象 Schema、移除指定键(如 id)验证规则的正确方法,重点讲解 .keys() 方法的覆盖式重定义机制,并对比错误用法,帮助开发者精准控制字段校验行为。

本文介绍在 joi 中动态修改对象 schema、移除指定键(如 `id`)验证规则的正确方法,重点讲解 `.keys()` 方法的覆盖式重定义机制,并对比错误用法,帮助开发者精准控制字段校验行为。

在使用 Joi 进行 JSON Schema 验证时,常需基于同一基础 Schema 衍生出多个变体——例如主 Schema 要求 id 必填且为字符串,而某接口(如创建资源)不应校验 id(由服务端生成),此时需“移除”该字段的验证逻辑。但需注意:Joi 并不提供直接的 .removeKey() 或 .omit() 方法;所谓“移除验证”,实质是用宽松规则覆盖原有约束。

✅ 正确做法:使用 .keys() 方法进行键级覆盖重定义
.keys() 不会合并新旧规则,而是完全替换目标键的校验器。因此,只需将 id 重新声明为 Joi.any().optional()(或更安全的 Joi.forbidden()),即可解除其原始校验:

const Joi = require('@hapi/joi'); // Joi v17+(推荐使用 @hapi/joi)

const baseSchema = Joi.object({
  id: Joi.string().required(),
  operation: Joi.string().required(),
  payload: Joi.object().optional()
});

// ✅ 正确:覆盖 id 字段,使其变为可选且无类型限制
const createSchema = baseSchema.keys({
  id: Joi.any().optional() // 允许 undefined、null、任意值(包括缺失)
});

// 验证示例
console.log(createSchema.validate({ operation: 'create' })); 
// → { error: null, value: { operation: 'create' } } ✅ 成功

console.log(createSchema.validate({ id: 123, operation: 'create' })); 
// → { error: null, value: { id: 123, operation: 'create' } } ✅ 数字也被接受

⚠️ 常见误区:误用 .concat()
如问题中尝试的 schema.concat(Joi.object({ id: Joi.any().optional() })),该方法用于合并两个独立 Schema 的顶层键集,而非覆盖。当两个 Schema 都定义了 id 时,Joi 会报错 Error: Cannot merge object schemas with duplicate keys(v17+ 默认行为),或产生不可预期的组合逻辑(旧版本)。因此 .concat() 不适用于字段覆盖场景。

? 进阶建议:

  • 若希望彻底禁止 id 出现(即显式拒绝任何 id 字段),请使用 Joi.forbidden():
    id: Joi.forbidden() // 输入含 id 时立即报错
  • 若需保留 id 的类型校验但取消必填要求,可精简为:
    id: Joi.string().optional() // 仍校验字符串格式,但允许缺失
  • 对于动态场景(如根据 operation 值条件化处理 id),可结合 .when() 实现运行时分支:
    id: Joi.when('operation', {
      is: 'create',
      then: Joi.forbidden(),
      otherwise: Joi.string().required()
    })

总结:Joi 中“移除字段验证”的本质是覆盖重定义,唯一可靠方式是调用 .keys({ key: newRule })。避免使用 .concat() 或 .append() 等合并方法,它们不支持键级覆盖语义。合理运用 .keys() 可高效构建多版本 Schema,兼顾复用性与灵活性。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4306

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1089

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4204

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1756

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3125

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4053

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2600

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

848

7

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.3万人学习