如何在JSON Schema中实现基于type字段的多态条件校验
原有Schema的缺陷原因
你之前的写法存在两个核心问题:
- 把
oneOf校验分支的层级放在了payload字段内部,导致分支只负责校验payload内部的字段,完全没有和外层的type字段做关联 - 外层的
type字段只单独做枚举值校验,全程不参与payload的规则匹配,相当于两个字段的校验完全独立
这种写法下,只要payload满足oneOf里“带message”或者“带url”任意一个条件,就会通过校验,完全不管当前对象的type到底是什么值。比如你遇到的错判场景:对象type是message,只要payload里有合法的message字段,哪怕同时多带了不该存在的url字段,因为payload满足了oneOf的第一个分支,校验就会直接放行,识别不出违规内容。
修正后的实现思路
要从根上解决规则串台的问题,需要把oneOf分支的层级提升到待校验对象的根级别,每一个分支独立绑定一种type的取值、以及对应type下payload的所有强制要求,让不同场景的校验规则完全互斥:
{ "type": "object", "oneOf": [ // 对应type为message的完整校验规则 { "properties": { "type": { "const": "message" }, "payload": { "type": "object", "required": ["message"], "properties": { "message": { "type": "string" } }, // 关闭额外字段允许,拦截所有非约定字段(比如不该出现的url) "additionalProperties": false } }, "required": ["type", "payload"] }, // 对应type为image、video的完整校验规则 { "properties": { "type": { "enum": ["image", "video"] }, "payload": { "type": "object", "required": ["url"], "properties": { "url": { "type": "string" } }, // 关闭额外字段允许,拦截所有非约定字段(比如不该出现的message) "additionalProperties": false } }, "required": ["type", "payload"] } ] }
实际校验效果
- 当对象
type为message时,只有payload包含字符串类型的message字段、且不存在其他额外字段才会通过校验,跨类型带url的场景会被直接拦截 - 当对象
type为image或video时,只有payload包含字符串类型的url字段、且不存在其他额外字段才会通过校验,跨类型带message的场景会被直接拦截 - 所有规则分支是基于完整对象的匹配,不会出现规则混同的错判。
内容的提问来源于stack exchange,提问作者Piotr Olaszewski
相关产品推荐
相关产品推荐

