JSON Schema for PHP 技术文档
2024-12-25 09:13:04作者:姚月梅Lane
安装指南
通过 Git 克隆
git clone https://github.com/jsonrainbow/json-schema.git
通过 Composer 安装
首先,确保你已经安装了 PHP Composer。如果尚未安装,可以参考 Composer 官方文档 进行安装。
然后,使用以下命令安装 json-schema
包:
composer require justinrainbow/json-schema
项目使用说明
基本使用
以下是一个基本的 JSON 验证示例:
<?php
$data = json_decode(file_get_contents('data.json'));
// 验证
$validator = new JsonSchema\Validator;
$validator->validate($data, (object)['$ref' => 'file://' . realpath('schema.json')]);
if ($validator->isValid()) {
echo "The supplied JSON validates against the schema.\n";
} else {
echo "JSON does not validate. Violations:\n";
foreach ($validator->getErrors() as $error) {
printf("[%s] %s\n", $error['property'], $error['message']);
}
}
类型强制转换
如果你需要验证通过 HTTP 传递的数据,并且希望将字符串和布尔值转换为预期的类型,可以使用以下代码:
<?php
use JsonSchema\SchemaStorage;
use JsonSchema\Validator;
use JsonSchema\Constraints\Factory;
use JsonSchema\Constraints\Constraint;
$request = (object)[
'processRefund'=>"true",
'refundAmount'=>"17"
];
$validator->validate(
$request, (object) [
"type"=>"object",
"properties"=>(object)[
"processRefund"=>(object)[
"type"=>"boolean"
],
"refundAmount"=>(object)[
"type"=>"number"
]
]
],
Constraint::CHECK_MODE_COERCE_TYPES
); // 验证通过!
is_bool($request->processRefund); // true
is_int($request->refundAmount); // true
默认值
如果你的 schema 包含默认值,可以在验证过程中自动应用这些默认值:
<?php
use JsonSchema\Validator;
use JsonSchema\Constraints\Constraint;
$request = (object)[
'refundAmount'=>17
];
$validator = new Validator();
$validator->validate(
$request,
(object)[
"type"=>"object",
"properties"=>(object)[
"processRefund"=>(object)[
"type"=>"boolean",
"default"=>true
]
]
],
Constraint::CHECK_MODE_APPLY_DEFAULTS
); // 验证通过,并为缺失的属性设置默认值
is_bool($request->processRefund); // true
$request->processRefund; // true
内联引用
<?php
use JsonSchema\SchemaStorage;
use JsonSchema\Validator;
use JsonSchema\Constraints\Factory;
$jsonSchema = <<<'JSON'
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{ "$ref": "#/definitions/integerData" },
{ "$ref": "#/definitions/stringData" }
]
}
},
"required": ["data"],
"definitions": {
"integerData" : {
"type": "integer",
"minimum" : 0
},
"stringData" : {
"type": "string"
}
}
}
JSON;
// Schema 必须先解码才能用于验证
$jsonSchemaObject = json_decode($jsonSchema);
// SchemaStorage 可以解析引用,根据需要从文件加载其他 schema 等
$schemaStorage = new SchemaStorage();
// 这做了两件事:
// 1) 修改 $jsonSchemaObject 以规范化引用(例如 file://mySchema#/definitions/integerData 等)
// 2) 告诉 $schemaStorage 引用 file://mySchema... 应通过查看 $jsonSchemaObject 来解析
$schemaStorage->addSchema('file://mySchema', $jsonSchemaObject);
// 将 $schemaStorage 提供给 Validator,以便在验证期间解析引用
$jsonValidator = new Validator(new Factory($schemaStorage));
// JSON 必须先解码才能验证
$jsonToValidateObject = json_decode('{"data":123}');
// 进行验证(使用 isValid() 和 getErrors() 检查结果)
$jsonValidator->validate($jsonToValidateObject, $jsonSchemaObject);
项目 API 使用文档
验证器配置选项
验证器提供了多个标志来改变其行为。这些标志可以作为 Validator::validate()
的第三个参数传递,或者作为 Factory::__construct()
的第三个参数传递,以便在多个 validate()
调用中保持一致。
标志 | 描述 |
---|---|
Constraint::CHECK_MODE_NORMAL |
以 'normal' 模式验证 - 这是默认模式 |
Constraint::CHECK_MODE_TYPE_CAST |
为关联数组和对象启用模糊类型检查 |
Constraint::CHECK_MODE_COERCE_TYPES |
在可能的情况下将数据类型转换为与 schema 匹配的类型 |
Constraint::CHECK_MODE_EARLY_COERCE |
尽早应用类型强制转换 |
Constraint::CHECK_MODE_APPLY_DEFAULTS |
如果未设置,则从 schema 应用默认值 |
Constraint::CHECK_MODE_ONLY_REQUIRED_DEFAULTS |
应用默认值时,仅设置必需的值 |
Constraint::CHECK_MODE_EXCEPTIONS |
如果验证失败,立即抛出异常 |
Constraint::CHECK_MODE_DISABLE_FORMAT |
不验证 "format" 约束 |
Constraint::CHECK_MODE_VALIDATE_SCHEMA |
验证 schema 以及提供的文档 |
请注意,使用 CHECK_MODE_COERCE_TYPES
或 CHECK_MODE_APPLY_DEFAULTS
将修改原始数据。
CHECK_MODE_EARLY_COERCE
除非与 CHECK_MODE_COERCE_TYPES
一起使用,否则无效。如果启用,验证器将使用(并强制转换)它遇到的第一个兼容类型,即使 schema 定义了另一个直接匹配且不需要强制转换的类型。
项目安装方式
通过 Git 克隆
git clone https://github.com/jsonrainbow/json-schema.git
通过 Composer 安装
composer require justinrainbow/json-schema
运行测试
composer test # 运行所有单元测试
composer testOnly TestClass # 运行特定的单元测试类
composer testOnly TestClass::testMethod # 运行特定的单元测试方法
composer style-check # 检查代码风格错误
composer style-fix # 自动修复代码风格错误
热门项目推荐
相关项目推荐
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。014FlashMLA
FlashMLA是DeepSeek在2025年2月24日启动的“开源周”中发布的首个核心技术项目。 主要针对 Hopper GPU 的高效 MLA 解码内核,优化了可变长度序列服务。支持 BF16 和特定块大小分页 kvcache。源项目地址:https://github.com/deepseek-ai/FlashMLAC++00每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~030BootstrapAdmin
基于 RBAC 的 Net8 后台管理框架,权限管理,前后台分离,支持多站点单点登录,兼容所有主流浏览器,内置微信、支付宝、QQ等多种登录方式,内置多种样式,可切换至 Blazor 多 Tabs 模式,权限控制细化到网页内任意元素(按钮、表格、文本框等等)C#00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie061毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018- DDeepSeek-R1探索新一代推理模型,DeepSeek-R1系列以大规模强化学习为基础,实现自主推理,表现卓越,推理行为强大且独特。开源共享,助力研究社区深入探索LLM推理能力,推动行业发展。【此简介由AI生成】。Python00
热门内容推荐
最新内容推荐
项目优选
收起

Python - 100天从新手到大师
Python
643
120

React Native鸿蒙化仓库
C++
9
19

方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
6
10

open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
65

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
61

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
31

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
287
82

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
901
0

🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
49