如何在JSON Schema(Draft-07)中按类型限制数组元素最大数量
基于现有Schema实现分类条目数量限制
前置说明
- Draft-07 原生规范本身没有内置跨数组元素聚合计数的能力(这类
maxContains类的原生支持是在后续Draft 2019-09版本才加入的) - 实际项目中可以通过主流校验库(如Ajv)的兼容扩展,在不改动原有Schema逻辑、不升级Schema版本的前提下实现分类计数限制,这也是目前生产环境最常用的方案
具体修改方案
在你现有Schema的根层级(和原type: array定义同级的位置),新增allOf校验块,针对三类组件分别配置数量上限规则即可,原有items里的所有校验逻辑不需要做任何改动。
修改后的完整Schema结构参考如下:
{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", // 以下为原有的items校验逻辑,保持不变 "items": { "type": "object", "required": [ "type", "data" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "banner_images", "description_box", "button" ] }, "data": { "type": "object" } }, "allOf": [ { "if": { "properties": { "type": { "const": "banner_images" } } }, "then": { "properties": { "data": { "$ref": "components/banner_images.json" } } } }, { "if": { "properties": { "type": { "const": "description_box" } } }, "then": { "properties": { "data": { "$ref": "components/description_box.json" } } } }, { "if": { "properties": { "type": { "const": "button" } } }, "then": { "properties": { "data": { "$ref": "components/button.json" } } } } ] }, // 以下为新增的分类数量限制规则 "allOf": [ { // 规则匹配所有type为banner_images的元素 "contains": { "type": "object", "properties": { "type": { "const": "banner_images" } }, "required": ["type"] }, "minContains": 0, // 不强制要求必须存在banner组件,0个也合法 "maxContains": 1 // 最多允许1个banner组件 }, { // 规则匹配所有type为description_box的元素 "contains": { "type": "object", "properties": { "type": { "const": "description_box" } }, "required": ["type"] }, "minContains": 0, "maxContains": 5 // 最多允许5个描述框组件 }, { // 规则匹配所有type为button的元素 "contains": { "type": "object", "properties": { "type": { "const": "button" } }, "required": ["type"] }, "minContains": 0, "maxContains": 10 // 最多允许10个按钮组件 } ] }
使用注意事项
- 以上规则中用到的
minContains/maxContains是Ajv校验库提供的Draft-07兼容扩展,初始化校验实例时只需要开启对应的contains关键字扩展即可正常工作,不需要修改$schema的版本声明 - 所有校验逻辑分层独立:原有的
items规则负责校验单个组件的结构合法性,新增的规则在数组全局层级做跨元素的数量统计,两者不会产生逻辑冲突 - 因为是在全局数组层面做计数,规则不受组件排列位置的影响,不管组件怎么打乱顺序,只要某类组件的总数超过上限就会触发校验失败
如果你使用的校验器不支持上述扩展参数,纯Draft-07原生语法是无法实现跨元素的精准计数限制的,这种场景下建议在业务代码层单独加一层计数判断,配合Schema本身的结构校验一起使用。
内容的提问来源于stack exchange,提问作者Anuj TBE
相关产品推荐
相关产品推荐

