如何在Joi中实现多字段值的关联验证

需求描述 #

我需要在Joi中实现多字段值的关联验证，具体场景如下：

用户输入需满足特定规则才能通过验证，简化后的初始Joi Schema如下：

// 大幅简化后的代码
Joi.object({
  v4Type: Joi.string().valid('DHCP', 'Static'),
  v6Type: Joi.string().valid('DHCP', 'Static'),
  v4Addr: Joi.string().ip({version: 'ipv4'}),
  v6Addr: Joi.string().ip({version: 'ipv6'}),
})

核心验证规则 #

• 用户至少配置一个地址族（IPv4或IPv6均可）
• 唯一拒绝的情况：{ v4Type: 'Static', v6Type: 'Static' }（两个地址均缺失）
• 类型与地址的关联：若为静态类型，则必须提供对应地址；动态类型无需地址
• 验证逻辑伪代码：

function isValid(...) {
  if ([v4Type, v6Type].includes('DHCP')) return true;
  if (v4Addr || v6Addr) return true;
  return false;
}

遇到的问题 #

我查阅了十余篇相关讨论，尚未找到能同时考量多个字段值判断验证结果的方法，也无法基于某字段值对其他字段施加“或”约束。尝试过when()的switch:选项及链式调用when()，均未解决问题。

我梳理了两种可行的伪代码Schema，但无法转换为实际可用代码：

伪代码1 #

Joi.object({
  a1: Joi.string().valid('ok', 'need more').
      when({ is: 'need more', then: Joi.object({a2: 'DHCP'}).or('b1', Joi.required()) }),
  a2: Joi.string().valid('ok', 'need more').
      when({ is: 'need more', then: Joi.object({a1: 'DHCP'}).or('b2', Joi.required()) }),
  b1: Joi.string(),
  b2: Joi.string(),
})

伪代码2 #

Joi.object({
  a1: Joi.string().valid('ok', 'need more'),
  a2: Joi.string().valid('ok', 'need more'),
  b1: Joi.string(),
  b2: Joi.string(),
}).when({ is: a1 == 'need more' && a2 == 'need more', then: Joi.keys('b1').or('b2') })

实现方案 #

结合Joi的when、or以及对象条件判断，可以完美实现需求：

const schema = Joi.object({
  v4Type: Joi.string().valid('DHCP', 'Static'),
  v6Type: Joi.string().valid('DHCP', 'Static'),
  // 静态类型时对应地址必填
  v4Addr: Joi.string().ip({ version: 'ipv4' })
    .when('v4Type', { is: 'Static', then: Joi.required(), otherwise: Joi.optional() }),
  v6Addr: Joi.string().ip({ version: 'ipv6' })
    .when('v6Type', { is: 'Static', then: Joi.required(), otherwise: Joi.optional() })
})
// 添加全局约束：当v4Type和v6Type同时为Static时，必须至少有一个地址存在
.when(
  Joi.object({
    v4Type: Joi.valid('Static'),
    v6Type: Joi.valid('Static')
  }).unknown(),
  {
    then: Joi.object().or('v4Addr', 'v6Addr').required(),
    otherwise: Joi.optional()
  }
);

逻辑说明 #

1. 静态地址必填：通过when针对单个字段做关联，确保静态类型时对应地址不能缺失。
2. 全局多字段约束：通过匹配v4Type和v6Type同时为Static的对象条件，强制要求此时必须存在至少一个地址，完美覆盖唯一需要拒绝的场景；其余情况（有DHCP类型、已有任意地址）均自动通过验证。

内容的提问来源于stack exchange，提问作者Avram