讲师中心 微信公众号
AI工具推荐 视频效率加速

Joi 字符串字段的空值与非空值校验:实现默认值与枚举约束的精准控制

千静吖_8401

千静吖_8401

发布时间:2026-05-06 21:05:04

|

628人浏览过

|

来源于php中文网

原创

本文详解如何使用 Joi 对字符串字段(如 store_type)进行健壮校验:支持未传值时自动设为默认值(如 'AAA'),同时严格限制空字符串和非法字符串为无效输入,并提供自定义错误提示。

本文详解如何使用 joi 对字符串字段(如 `store_type`)进行健壮校验:支持未传值时自动设为默认值(如 `'aaa'`),同时严格限制空字符串和非法字符串为无效输入,并提供自定义错误提示。

在 Joi 中,.default() 仅在字段 完全缺失(undefined) 时生效;而空字符串 '' 是一个有效字符串值,会被 .valid() 校验逻辑接管——但默认情况下,空字符串不匹配 ['AAA', 'BBB'],会直接报错。这恰好符合你的需求:空字符串应被拒绝,而非转为默认值。

然而,原始代码存在两个关键问题:

  1. .error(() => { ... }) 返回的是普通对象,但 Joi 要求 error() 回调必须返回 Error 实例或 Joi 错误数组(err[]),否则抛出 TypeError: error() must return an Error object;
  2. 缺少对空字符串的显式处理逻辑(虽 .valid() 默认已拒绝空字符串,但为语义清晰与未来可维护性,建议显式声明)。

✅ 正确写法(推荐方案一:返回错误数组,保留完整错误结构):

const Joi = require('joi');

const storeTypes = {
  aaa: 'AAA',
  bbb: 'BBB'
};

const schema = Joi.object({
  store_type: Joi.string()
    .valid(...Object.values(storeTypes))
    .empty('') // 显式将空字符串视为空值(可选,增强可读性;.valid() 已隐式拒绝空字符串)
    .error((errors) => {
      // 修改第一个错误的 message 字段,保持其他元数据(如 key、path、type)
      errors[0].message = `Store Type must be one of: ${Object.values(storeTypes).join(', ')}`;
      return errors;
    })
    .default(storeTypes.aaa)
});

✅ 替代方案(返回 Error 实例,简化错误处理):

store_type: Joi.string()
  .valid(...Object.values(storeTypes))
  .error(() => new Error(`Store Type must be one of: ${Object.values(storeTypes).join(', ')}`))
  .default(storeTypes.aaa)

? 验证行为说明: | 输入 store_type | 校验结果 | 输出值 | |------------------|----------|--------| | undefined / 字段不存在 | ✅ 通过 | 'AAA'(由 .default() 注入) | | ''(空字符串) | ❌ 失败 | 抛出指定错误(因不满足 .valid()) | | 'AAA' 或 'BBB' | ✅ 通过 | 原值保留 | | 'CCC' 或其他任意非空非法值 | ❌ 失败 | 抛出指定错误 |

? 注意事项:

  • 不要使用 .allow('') 或 .optional().empty(''),否则会允许空字符串通过校验,违背需求;
  • 若需兼容 null 输入,可额外添加 .valid(null) 并在 .error() 中统一处理,但根据需求,null 应同 '' 一样被拒绝;
  • 使用 .empty('') 是显式声明“空字符串视为无效值”,提升代码可读性,尽管 .valid() 默认已拒绝它;
  • 自定义错误中优先采用 错误数组修改方式(方案一),因其保留 Joi 原生错误对象的所有属性(如 path, type, context),便于日志追踪与前端分类提示。

最终,该配置精准实现了你的全部预期:无输入 → 设默认;有输入 → 必须是合法枚举值;其余一律报错并附清晰提示。

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

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

5026

2023.06.20

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

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

1229

2023.07.04

js四舍五入
js四舍五入

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

4944

2023.07.04

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

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

960

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1896

2023.09.04

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

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

3525

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4593

2023.09.12

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

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

3020

2023.09.20

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn