Yup作为表单验证领域的主流工具,其when方法常用于实现条件化验证规则,比如当某个字段满足特定值时,触发其他字段的验证约束。在旧版本语法中,开发者通常会通过is属性来定义匹配条件,但最新版本的Yup已经移除了is属性的支持,直接使用旧语法会出现验证失效甚至报错的问题。

旧版本when方法的使用方式
在is属性还被支持的版本中,when方法的配置结构如下,通过is属性指定匹配的目标值,then和otherwise分别定义匹配成功和失败后的验证规则:
import * as Yup from 'yup';
const oldSchema = Yup.object({
userType: Yup.string().required('请选择用户类型'),
companyName: Yup.string().when('userType', {
is: 'enterprise', // 旧语法使用is属性匹配值
then: (schema) => schema.required('企业用户必须填写公司名称'),
otherwise: (schema) => schema.notRequired()
})
});
新版本语法的核心变化
Yup官方移除is属性的原因是旧语法对复杂匹配场景的支持不足,新版本将匹配逻辑整合到了when方法的第二个参数中,通过回调函数直接返回匹配结果,同时支持更灵活的条件判断。新语法的when方法接收两个参数,第一个是依赖的字段名,第二个是配置对象,其中不再包含is属性,而是通过test函数定义匹配规则。
旧代码改造方案
针对之前使用is属性的场景,只需要将is的匹配逻辑迁移到test函数中即可,改造后的代码如下:
import * as Yup from 'yup';
const newSchema = Yup.object({
userType: Yup.string().required('请选择用户类型'),
companyName: Yup.string().when('userType', {
// 新语法使用test函数替代is属性
test: (value) => value === 'enterprise',
then: (schema) => schema.required('企业用户必须填写公司名称'),
otherwise: (schema) => schema.notRequired()
})
});
复杂匹配场景的适配
如果之前的is属性使用了复杂匹配,比如正则匹配或者多值匹配,同样可以放到test函数中实现:
import * as Yup from 'yup';
const complexSchema = Yup.object({
status: Yup.string().required('请选择状态'),
reason: Yup.string().when('status', {
// 多值匹配场景
test: (value) => ['reject', 'return'].includes(value),
then: (schema) => schema.required('驳回或退回时必须填写原因'),
otherwise: (schema) => schema.notRequired()
})
});
新语法使用注意事项
- test函数的参数是依赖字段的当前值,需要根据实际类型编写匹配逻辑,避免类型错误导致匹配失效。
- 如果依赖多个字段,新版本支持传入字段名数组,test函数会接收多个参数对应每个字段的值。
- 改造完成后建议对条件验证场景做回归测试,确认所有分支的验证规则都符合预期。
版本兼容建议
如果暂时无法升级Yup版本,可以继续使用旧语法,但需要注意旧版本不再接收安全更新。建议逐步完成语法迁移,避免后续升级时产生大量改造成本。如果升级后出现验证异常,优先检查when方法是否还存在is属性的使用,按照上述方案调整即可。