如何使用 Composer 解决 JSON Schema 验证问题-composer-PHP中文网

如何使用 Composer 解决 JSON Schema 验证问题

WBOY

发布： 2025-03-16 11:22:02

原创

522人浏览过

可以通过一下地址学习composer：学习地址

在开发一个基于 Symfony 的应用程序时，我遇到了一个棘手的问题：如何有效地验证 JSON 数据格式。最初，我尝试使用手动编写的验证代码，但这不仅复杂，而且容易出错。经过一番探索，我发现了一个名为 ptyhard/json-schema-bundle 的 Composer 包，它为我的项目带来了极大的便利和效率。

首先，通过 Composer 安装这个包非常简单：

composer req ptyhard/json-schema-bundle "dev-master"

登录后复制

安装完成后，需要在 config/bundles.php 文件中添加以下配置：

<?php

return [
    ...
    Ptyhard\JsonSchemaBundle\JsonSchemaBundle::class => ['all' => true]
];

登录后复制

接下来，在 config/packages/ptyhard_json_schema.yml 文件中引入包的配置：

# config/packages/ptyhard_json_schema.yml

ptyhard_json_schema:
    use_jms_serializer: true # default true
    json_file_directory: ~ # default null
    json_write_directory: # default null

登录后复制

使用 ptyhard/json-schema-bundle 进行 JSON Schema 验证非常直观。首先，你需要创建一个 Schema PHP 类，例如：

<?php
// src/JsonSchema/User.php

namespace App\JsonSchema;

use Ptyhard\JsonSchemaBundle\Annotations\SchemaClass;
use Ptyhard\JsonSchemaBundle\Annotations\Property;

/**
 * @SchemaClass(required={"id","name"})
 */
class User 
{
    /**
     * @Property\NumberProperty("id")
     *
     * @var int
     */
    private $id;

    /**
     * @Property\StringProperty("name")
     *
     * @var string
     */
    private $name;
}

登录后复制

然后，在控制器中使用这个 Schema 类进行验证，例如：

<?php

namespace App\Controller;

use App\JsonSchema\User;
use Polidog\SimpleApiBundle\Annotations\Api;
use Symfony\Component\Routing\Annotation\Route;

/**
 * @Route("/")
 */
class TopController
{
    /**
     * @Route("/request/check",methods={"POST"}) 
     * @Api(statusCode=200)
     *
     * @param User $user
     * @return User
     */
    public function requestCheck(User $user) : User
    {
        return  [];
    }

    /**
     * @Route("/response/check",methods={"GET"}) 
     * @Api(statusCode=200)
     *
     * @return User
     */
    public function responseCheck() : User
    {
        return new User();
    }
}

登录后复制

如果需要生成 JSON Schema 文件，可以使用以下命令：