如何使用 Joi 实现地理坐标与结构化地址的互斥必填校验

秋明姑娘_4045

秋明姑娘_4045

2026-09-07

330人浏览

原创

如何使用 Joi 实现地理坐标与结构化地址的互斥必填校验

本文介绍如何利用 Joi 的条件验证(.when())机制,实现“Latitude/Longitude 二者任一提供即跳过地址字段校验,否则 AddressLine、City、PostalCode 必须全部非空”的业务规则。

本文介绍如何利用 joi 的条件验证(`.when()`)机制,实现“latitude/longitude 二者任一提供即跳过地址字段校验,否则 addressline、city、postalcode 必须全部非空”的业务规则。

在构建 API 请求校验逻辑时,常遇到“二选一”或“互斥必填”的复合验证需求。例如本例中的地址对象:系统既支持通过经纬度(Latitude/Longitude)精确定位,也支持通过结构化文本地址(AddressLineCityPostalCode)模糊匹配。业务规则明确要求:只要 LatitudeLongitude 中至少一个为有效数值(非 null、非 undefined、非空字符串),则地址三字段可选;否则三者必须全部存在且非空。

Joi 并不直接支持“多字段联合条件判断”,但可通过嵌套 .when() 实现等效逻辑。核心思路是:以 Longitude 为第一判据,若其为 null,则强制校验地址字段;若其非 null,再进一步检查 Latitude —— 若 Latitude 也为 null,仍需地址字段;仅当二者均非 null 时,地址字段才可省略。

以下是完整、健壮的 Joi 校验 Schema 示例:

const Joi = require('joi');

const addressSchema = Joi.object({
  Longitude: Joi.number().allow(null, '').optional(),
  Latitude: Joi.number().allow(null, '').optional(),
  AddressLine: Joi.string()
    .when('Longitude', {
      is: Joi.exist().not(null).not(''),
      then: Joi.string().optional().allow(null, ''),
      otherwise: Joi.string()
        .when('Latitude', {
          is: Joi.exist().not(null).not(''),
          then: Joi.string().optional().allow(null, ''),
          otherwise: Joi.string().required().min(1).label('AddressLine')
        })
    })
    .label('AddressLine'),
  City: Joi.string()
    .when('Longitude', {
      is: Joi.exist().not(null).not(''),
      then: Joi.string().optional().allow(null, ''),
      otherwise: Joi.string()
        .when('Latitude', {
          is: Joi.exist().not(null).not(''),
          then: Joi.string().optional().allow(null, ''),
          otherwise: Joi.string().required().min(1).label('City')
        })
    })
    .label('City'),
  PostalCode: Joi.string()
    .when('Longitude', {
      is: Joi.exist().not(null).not(''),
      then: Joi.string().optional().allow(null, ''),
      otherwise: Joi.string()
        .when('Latitude', {
          is: Joi.exist().not(null).not(''),
          then: Joi.string().optional().allow(null, ''),
          otherwise: Joi.string().required().min(1).label('PostalCode')
        })
    })
    .label('PostalCode'),
}).unknown(true);

const dataSchema = Joi.object({
  Id: Joi.string().uuid().required().label('Task ID'),
  Address: addressSchema,
}).unknown(true);

function validateData(data) {
  return dataSchema.validate(data, { abortEarly: false });
}

module.exports = { validateData };

关键说明与最佳实践:

  • 使用 Joi.exist().not(null).not('') 替代简单的 is: null,确保能正确识别 0false 等 falsy 但合法的数值(Latitude/Longitude 可为 0);
  • 显式调用 .allow(null, '') 避免空字符串被默认拒绝;
  • 地址字段在“必填分支”中添加 .min(1),防止仅传入空白字符串;
  • 启用 { abortEarly: false } 可一次性返回所有校验错误,提升调试效率;
  • Address Schema 单独提取为常量,增强可读性与复用性。

⚠️ 注意事项:

  • Joi v17+ 中 Joi.forbidden() 不适用于条件分支的 then/otherwise,应改用 Joi.optional().allow(null, '')Joi.any().valid(null).optional()
  • 若业务允许 Latitude/Longitude 为字符串形式(如 "40.7128"),需配合 .pattern() 或自定义转换;
  • 前端提交时建议统一将空经纬度设为 null,避免因字符串 "null" 或空格导致校验失效。

通过上述方案,你既能精准满足“经纬度优先、地址兜底”的业务语义,又能保持校验逻辑清晰、可维护、可测试。

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

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

4026

5

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

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

2023.07.04

1029

3

js四舍五入
js四舍五入

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

2023.07.04

3924

6

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

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

2023.09.01

820

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1696

5

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

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

2023.09.04

2965

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

3853

6

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

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

2023.09.20

2440

5

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

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

2023.09.20

808

7

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133万人学习