4

我的任务是为 JSON 模式定义的对象创建一个类。最初我只是要基于模式构建类,但现在我被告知它应该从模式本身自动生成。

我希望该类为其成员设置/获取方法。

解决这个问题的最佳方法是什么?

4

3 回答 3

3

使用swagest/php-code-builder您可以在映射期间生成带有访问器方法和验证的 PHP 类。

映射和验证由swagest/json-schema提供支持,这是一种快速且兼容的 JSON 模式实现。

生成的类对 IDE 友好,因此您可以自动完成所有属性。

于 2018-05-15T11:11:05.820 回答
0

我为这个用例写了一个包:https ://packagist.org/packages/dto/dto

这个想法是能够将对象定义为 JSON 模式,以便其他服务可以使用这些定义,然后使用这些相同的 JSON 模式在内部定义 PHP 对象。

<?php
class Example extends Dto\Dto
{
   protected $schema = [
        'type' => 'object',
        'properties' => [
            'a' => ['type' => 'string'],
            'b' => ['type' => 'string']
        ],
        'additionalProperties' => false
    ];
}

这个包有几件事很棘手(并且通常对 PHP 中的类型很严格):

  1. PHP 没有 __toInt 等的魔法方法。因此,如果您在需要特定类型数据的地方使用 DTO 对象中的值,例如将其与整数进行比较,则必须将值显式解析为类型。

if ($dto->my_integer > 3) { // generates an error!

相反,您必须将值显式转换为标量值(由 JSON Schema 定义定义):

if ($dto->my_integer->toScalar() > 3) { // works

  1. 通常,您的 JSON 模式具有各种必需字段——因此,如果您实例化由该模式定义的对象,则必须通过构造对其进行水合,否则它处于无效状态。我发现有一些模式的变体很有帮助,例如允许一个空的未水合对象用于限制较少的 PHP 使用,并且在支持各种 HTTP 动词时很有帮助——例如 GET 请求可能只返回对象的一部分, POST 请求将需要一些字段,PATCH 请求可能需要唯一的 id 字段和至少一个其他字段等。

希望这可以帮助。

于 2017-06-21T17:23:04.213 回答
-1

我想你在这里有几个选择。

  1. 代码生成:运行模式并将 PHP 代码构建为字符串。这会很快,但您必须对按原样使用生成的输出感到满意,否则如果架构发生更改,您将遇到麻烦。
  2. 构建一个对象,该对象包含架构并用于拦截对或的__call()调用,并且可以执行必要的验证和返回值。getFoo()setBar()

在这两种情况下,我认为棘手的部分是如果您在此过程中遇到引用类型。但是,如果您的架构相当简单,那么它应该不会太糟糕。

祝你好运!

于 2014-10-30T11:03:49.203 回答