如何在JSON Schema的required中添加多个$data引用?
解决AJV中同时依赖两个属性值的必填校验问题
AJV的required关键字本身不支持直接传入多个$data引用组成的数组,因为$data在这里只能指向单个数组值,而非多个独立引用。要实现数组filters-detail中每个对象必须包含filters-applied和applied-second两个属性的所有值,可采用以下两种方案:
方案一:用allOf组合多个required规则
将每个$data引用单独封装为一个required规则,再通过allOf合并规则,确保两个属性的所有值都被设为必填项。
示例代码:
const ajv = new Ajv({ $data: true }); const schema = { type: 'object', properties: { 'filters-detail': { type: 'array', items: { type: 'object', allOf: [ { required: { $data: '0/filters-applied' } }, { required: { $data: '0/applied-second' } } ] } } } }; const validate = ajv.compile(schema);
这里的0/filters-applied是JSON Pointer,指向当前数组项对象中的filters-applied属性,0/applied-second同理。allOf会强制两个required规则同时生效,即对象必须包含两个属性中的所有字段。
方案二:自定义关键字处理复杂合并场景
如果需要合并两个属性的数组值后再校验必填项,可自定义AJV关键字实现更灵活的逻辑:
ajv.addKeyword({ keyword: 'requiredFromTwoProps', type: 'object', compile: ([propName1, propName2]) => { return function(data, _, parentData) { const requiredFields1 = parentData[propName1] || []; const requiredFields2 = parentData[propName2] || []; const allRequired = [...requiredFields1, ...requiredFields2]; return allRequired.every(field => field in data); }; } }); const schema = { type: 'object', properties: { 'filters-detail': { type: 'array', items: { type: 'object', requiredFromTwoProps: ['filters-applied', 'applied-second'] } } } };
这个自定义关键字会读取当前对象的两个指定属性,合并它们的数组值后,校验对象是否包含所有合并后的必填字段。
关键注意点
- 必须在AJV实例初始化时开启
$data选项(new Ajv({ $data: true })),否则$data引用无法生效。 - JSON Pointer路径要准确:
0/代表当前数组项本身,确保能正确指向对象内的目标属性。
内容的提问来源于stack exchange,提问作者Jennifer Kiesel
相关产品推荐
相关产品推荐

