使用Opis JSON Schema精确验证包含固定值属性的JSON数组

DDD
发布: 2025-12-05 13:44:56
原创
551人浏览过

使用Opis JSON Schema精确验证包含固定值属性的JSON数组

本文详细介绍了如何使用opis json schema库,精确验证一个json数组是否包含至少一个具有特定固定整数值属性的对象。核心解决方案在于正确处理php数组与json对象之间的类型转换,确保数据以 `stdclass` 对象形式传递给验证器,并修改json schema中的 `contains` 关键字类型为 `object`,从而实现对数组内嵌套对象属性的有效校验。

在现代Web应用开发中,JSON数据验证是确保数据完整性和安全性的关键环节。Opis JSON Schema是一个强大的PHP库,用于根据JSON Schema规范验证JSON数据。然而,在处理复杂数据结构,特别是验证包含特定属性值的对象数组时,开发者可能会遇到一些挑战。本文将深入探讨如何使用Opis JSON Schema精确验证一个JSON数组中是否存在至少一个具有固定整数值 id 的对象。

问题分析:Opis JSON Schema验证失败的原因

在尝试验证一个PHP关联数组构成的JSON数据时,如果验证器返回“至少1个数组项必须匹配schema”的错误,即使规则看起来正确,这通常是由于以下两个核心问题造成的:

  1. 数据类型不匹配:PHP关联数组与JSON对象的差异 在PHP中,关联数组(例如 ['key' => 'value'])在内部表示上与 stdClass 对象有所不同。当PHP关联数组直接传递给Opis JSON Schema进行验证时,如果Schema期望的是JSON对象(即在Schema中定义了 properties),验证器可能无法正确识别PHP关联数组为对应的JSON对象类型。JSON Schema中的 properties 关键字专门用于验证JSON对象的属性,而不是PHP关联数组的键值对

  2. 错误的Schema类型定义 在JSON Schema中,当 contains 关键字用于验证数组中包含的对象时,其内部的 type 关键字应该明确指定为 object,而不是 array。原始尝试中将 contains 的 type 设置为 array 是不正确的,因为它试图将数组中的每个元素(本例中是关联数组)也视为一个数组,而不是一个对象。

解决方案:数据预处理

为了确保Opis JSON Schema能够正确解析PHP数据结构,特别是将PHP关联数组识别为JSON对象,最稳妥的方法是将PHP关联数组首先编码为JSON字符串,然后再解码回PHP对象(stdClass)。这个过程确保了PHP数据结构与JSON Schema所期望的JSON对象类型完全匹配。

转换PHP关联数组为JSON对象

<?php

// 原始PHP关联数组数据
$jsonArrayData = [
    [
        'id' => 1,
    ],
    [
        'id' => 2,
    ],
    [
        'id' => 3
    ]
];

// 关键步骤:将PHP关联数组转换为JSON字符串,再解码为PHP对象
// 这样确保了内部的关联数组被转换为 stdClass 对象,符合JSON Schema对 'object' 类型的期望
$json = json_encode($jsonArrayData); // 编码为JSON字符串
$json = json_decode($json);         // 解码为PHP对象(stdClass)
登录后复制

经过此处理后,$json 变量将是一个包含 stdClass 对象的数组,这正是Opis JSON Schema在处理 properties 规则时所期望的类型。

解决方案:Schema规则优化

在定义验证规则时,需要修正 contains 关键字内部的 type 定义。由于我们期望数组中的每个元素都是一个具有特定属性的对象,因此 type 应该设置为 object。

Dreamina
Dreamina

字节跳动推出的AI绘画工具,用简单的文案创作精美的图片

Dreamina 449
查看详情 Dreamina

定义正确的contains类型

<?php

// 优化后的JSON Schema验证规则
$rules = [
    'type' => 'array', // 顶层数据是一个数组
    'contains' => [    // 数组中必须包含至少一个满足以下条件的项目
        'type' => 'object', // 该项目必须是一个JSON对象
        'properties' => [   // 该对象必须包含以下属性
            'id' => [
                'type' => 'integer', // id属性的类型是整数
                'const' => 1,        // id属性的值必须固定为1
            ],
        ],
        'required' => ['id'] // id属性是必需的
    ],
    'minContains' => 1, // 数组中至少有1个项目匹配 'contains' 定义的schema
];
登录后复制

完整示例代码

结合数据预处理和优化后的Schema规则,以下是使用Opis JSON Schema进行精确验证的完整示例。

<?php

require 'vendor/autoload.php'; // 假设你已通过Composer安装Opis/json-schema

use Opis\JsonSchema\Validator;
use Opis\JsonSchema\Errors\ErrorFormatter;

class Common
{
    public static function validateJSON($json, $rules)
    {
        $validator = new Validator();

        // 验证
        $result = $validator->validate($json, $rules);

        if ($result->isValid()) {
            return true;
        }

        $errorMessages = [];

        if ($result->hasError()) {
            $formatter = new ErrorFormatter();
            $errorMessages[] = $formatter->format($result->error());
        }

        return $errorMessages;
    }
}

// 原始PHP关联数组数据
$jsonArrayData = [
    [
        'id' => 1,
    ],
    [
        'id' => 2,
    ],
    [
        'id' => 3
    ]
];

// 关键步骤:将PHP关联数组转换为JSON字符串,再解码为PHP对象(stdClass)
$json = json_encode($jsonArrayData);
$json = json_decode($json);

// 优化后的JSON Schema验证规则
$rules = [
    'type' => 'array',
    'contains' => [
        'type' => 'object', // 修正为 object
        'properties' => [
            'id' => [
                'type' => 'integer',
                'const' => 1,
            ],
        ],
        'required' => ['id']
    ],
    'minContains' => 1,
];

// 执行验证
$validated = Common::validateJSON($json, json_encode($rules)); // 注意:$rules也需要编码为JSON字符串

// 输出验证结果
if ($validated === true) {
    echo "验证成功:JSON数组中包含至少一个id为1的对象。\n";
} else {
    echo "验证失败:\n";
    print_r($validated);
}

// 示例2: 验证失败的情况 (不包含id为1的对象)
echo "\n--- 验证失败示例 ---\n";
$invalidJsonArrayData = [
    [
        'id' => 2,
    ],
    [
        'id' => 3,
    ]
];
$invalidJson = json_encode($invalidJsonArrayData);
$invalidJson = json_decode($invalidJson);

$invalidValidated = Common::validateJSON($invalidJson, json_encode($rules));

if ($invalidValidated === true) {
    echo "验证成功:JSON数组中包含至少一个id为1的对象。\n";
} else {
    echo "验证失败:\n";
    print_r($invalidValidated);
}
登录后复制

运行上述代码,对于第一个 $json 示例,将输出“验证成功”,因为它包含一个 id 为 1 的对象。对于第二个 $invalidJson 示例,将输出验证失败信息,因为它不包含 id 为 1 的对象。

核心概念解析:contains与minContains

  • contains: 这个关键字用于指定数组中必须包含至少一个匹配给定子Schema的元素。它不要求所有元素都匹配,只要求存在一个。
  • minContains: 与 contains 结合使用,minContains 定义了数组中必须有多少个元素匹配 contains 关键字定义的子Schema。在本例中,minContains: 1 表示至少有一个元素匹配。

注意事项与最佳实践

  1. 数据类型一致性: 始终确保传递给JSON Schema验证器的数据类型与Schema定义期望的类型相匹配。PHP关联数组在转换为JSON后是对象,因此Schema中应使用 object 类型。
  2. Schema的精确性: 精确定义每个字段的 type、properties、required 和 const 等关键字,以确保验证的准确性。
  3. 错误处理: 利用Opis JSON Schema提供的 ErrorFormatter 来格式化和理解验证失败时的错误信息,这对于调试至关重要。
  4. Schema缓存: 在生产环境中,可以考虑缓存编译后的Schema,以提高验证性能。

总结

通过本文的详细解析和示例,我们了解到在使用Opis JSON Schema验证包含特定属性值的JSON数组时,正确的数据预处理(将PHP关联数组转换为 stdClass 对象)和精确的Schema定义(将 contains 的 type 设置为 object)是成功的关键。掌握这些技巧,可以帮助开发者构建更健壮、更可靠的JSON数据验证逻辑。

以上就是使用Opis JSON Schema精确验证包含固定值属性的JSON数组的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号