0

0

使用 Joi xor 实现互斥必填字段验证

碧海醫心

碧海醫心

发布时间:2025-10-28 14:43:00

|

932人浏览过

|

来源于php中文网

原创

使用 Joi xor 实现互斥必填字段验证

本文详细介绍了如何在 joi 验证框架中使用 `xor` 方法来处理互斥必填字段的场景。通过 `xor`,您可以轻松地定义一组键之间的排他性关系,确保在提交的数据中,指定字段集合中只有一个字段存在,从而有效提升数据验证的严谨性和准确性。

深入理解 Joi xor 方法

在数据验证中,我们经常会遇到这样的业务需求:在多个可选字段中,用户必须且只能提供其中一个。例如,一个联系方式字段可能要求用户提供手机号码或电子邮箱,但不能同时提供两者,也不能两者都不提供。Joi 提供了 xor(异或)方法来优雅地解决这类互斥必填的验证场景。

xor 方法定义了一组键之间的排他性关系,其核心原则是:在指定的字段集合中,必须有一个且只有一个字段存在。如果存在多个字段,或者一个字段都不存在,验证都将失败。

场景示例:字段 b 和 c 的互斥必填

假设我们有一个数据对象,其中包含字段 a, b, c。我们的目标是实现以下验证逻辑:在字段 b 和字段 c 中,必须且只能有一个字段存在。这意味着如果 b 存在,c 就不能存在;如果 c 存在,b 就不能存在;同时,b 和 c 不能同时缺失。

考虑以下 JSON 示例及其预期的验证结果:

{ "a": "1", "b": "2", "c": "3" } // 验证失败:b 和 c 都存在
{ "a": "1", "b": "2" }           // 验证通过:只有 b 存在
{ "a": "1", "c": "3" }           // 验证通过:只有 c 存在
{ "a": "1" }                     // 验证失败:b 和 c 都不存在

使用 xor 实现验证

Joi 的 xor 方法可以直接应用于对象模式(joi.object())上,并接收一个或多个字段名作为参数。

Figstack
Figstack

一个基于 Web 的AI代码伴侣工具,可以帮助跨不同编程语言管理和解释代码。

下载

以下是如何使用 xor 来实现上述验证逻辑的示例代码:

const Joi = require('joi'); // 在 Node.js 环境中引入 Joi

// 定义验证模式
const schema = Joi.object({
    a: Joi.string(), // 字段 a 是可选的字符串
    b: Joi.string(), // 字段 b 是可选的字符串
    c: Joi.string()  // 字段 c 是可选的字符串
}).xor('b', 'c'); // 关键:使用 xor('b', 'c') 确保 b 和 c 中只有一个存在

// 测试不同的数据输入
console.log('--- 测试用例 ---');

// 1. 只有 b 存在:验证通过
const data1 = { a: "1", b: "2" };
const result1 = schema.validate(data1);
console.log('数据: ', data1, ' -> 验证结果: ', result1.error ? result1.error.message : '通过');
// 预期输出: 数据:  { a: '1', b: '2' }  -> 验证结果:  通过

// 2. 只有 c 存在:验证通过
const data2 = { a: "1", c: "3" };
const result2 = schema.validate(data2);
console.log('数据: ', data2, ' -> 验证结果: ', result2.error ? result2.error.message : '通过');
// 预期输出: 数据:  { a: '1', c: '3' }  -> 验证结果:  通过

// 3. b 和 c 都不存在:验证失败
const data3 = { a: "1" };
const result3 = schema.validate(data3);
console.log('数据: ', data3, ' -> 验证结果: ', result3.error ? result3.error.message : '通过');
// 预期输出: 数据:  { a: '1' }  -> 验证结果:  "value" must contain at least one of [b, c]

// 4. b 和 c 都存在:验证失败
const data4 = { a: "1", b: "2", c: "3" };
const result4 = schema.validate(data4);
console.log('数据: ', data4, ' -> 验证结果: ', result4.error ? result4.error.message : '通过');
// 预期输出: 数据:  { a: '1', b: '2', c: '3' }  -> 验证结果:  "value" must not contain both [b, c]

浏览器环境中使用 Joi 进行验证时,可以通过 CDN 引入 joi-browser.min.js。例如:

然后,你可以直接使用全局的 Joi 对象进行模式定义和验证。

总结与注意事项

  • xor 的核心作用:xor 方法是处理“互斥必填”逻辑的利器,它强制要求在指定的一组字段中,必须且仅有一个字段存在
  • 与 or 的区别:Joi 也提供了 or 方法,它表示“至少一个”字段存在即可,允许多个字段同时存在。而 xor 则更为严格,不允许同时存在多个。
  • 适用场景:当你的数据模型要求用户从多个选项中选择一个,且只能选择一个时(例如,支付方式可以是银行卡或支付宝,但不能同时选择或同时不选),xor 是一个理想的选择。
  • 可扩展性:xor 方法可以接受任意数量的字段名作为参数,例如 xor('field1', 'field2', 'field3'),这意味着你可以在更多字段之间建立互斥关系。

通过合理利用 Joi 的 xor 方法,开发者可以构建出更健壮、更符合业务逻辑的数据验证规则,有效提升应用程序的数据质量和用户体验。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

417

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

76

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

510

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

278

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5294

2023.08.17

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

8

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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