JOI 17如何添加自定义验证器?从JOI14升级遇扩展配置报错
Joi 17自定义验证器配置问题记录
版本与前置参考信息
- 当前使用Joi 14版本,暂未找到该版本升级到Joi 17的官方指引
- 社区现存不少Joi 16版本自定义验证器的同类问题,但相关内容的最后更新时间已在3个月以上
- 参考技术帖《How to add custom validator function in Joi?》的信息,Joi 16版本配置自定义验证时不强制要求传入
type参数 - 已查阅Joi 17.3.0的官方扩展API文档,文档对
type参数的说明为:schema的类型,可传入字符串,或是匹配多类型的正则表达式
代码尝试与报错反馈
按照文档说明编写测试代码如下:
const snakeAlpha = joi => { return { type: 'object', name: 'snakeAlpha', base: joi.string().regex(/^[a-z]+(_[a-z]+)*$/) }; }; const customJoi = Joi.extend({ type: 'object', rules: { snakeAlpha } });
运行代码后触发如下报错:
ValidationError: { "type": "object", "rules": { "snakeAlpha" [1]: "[joi => {\n return {\n type: 'object',\n name: 'snakeAlpha',\n base: joi.string().regex(/^[a-z]+(_[a-z]+)*$/)\n };\n}]" } } [1] "rules.snakeAlpha" must be of type object
已完成的排查操作
- 按照文档要求传入
type值为object仍触发报错 - 尝试将
type值改为与base规则一致的string类型,依然返回相同报错信息
附加需求场景
后续发现参考的示例仅覆盖了不依赖joi实例的简单正则校验规则,还存在需要依赖其他自定义验证器的校验场景,参考实现代码如下:
const arrayKebabAlpha = joi => { return { type: 'string', name: 'arrayKebabAlpha', base: joi.array().items(joi.kebabAlpha()) }; };
内容的提问来源于stack exchange,提问作者Dave Stein
相关产品推荐
相关产品推荐

