遍历深层嵌套的JSON对象

时间:2018-11-21 23:12:40

标签: json mapreduce associative-array php-7

与用于构建表单的API进行交互时,我进行API调用以获取与表单相关联的所有响应值。该API返回具有我所有表单值的深度嵌套的JSON对象。

许多响应对象之一如下:

{
      "title":{
        "plain":"Send Money"
      },
      "fieldset":[
        {
          "label":{
            "plain":"Personal Info Section"
          },
          "fieldset":[
            {
              "field":[
                {
                  "label":{
                    "plain":"First Name"
                  },
                  "value":{
                    "plain":"Bob"
                  },
                  "id":"a_1"
                },
                {
                  "label":{
                    "plain":"Last Name"
                  },
                  "value":{
                    "plain":"Hogan"
                  },
                  "id":"a_2"
                }
              ],
              "id":"a_8"
            }
          ],
          "id":"a_5"
        },
        {
          "label":{
            "plain":"Billing Details Section"
          },
          "fieldset":{
            "field":{
              "choices":{
                "choice":{
                  "label":{
                    "plain":"Gift"
                  },
                  "id":"a_17",
                  "switch":""
                }
              },
              "label":{
                "plain":"Choose a category:"
              },
              "value":{
                "plain":"Gift"
              },
              "id":"a_14"
            },
            "fieldset":{
              "label":{
                "plain":""
              },
              "field":[
                {
                  "choices":{
                    "choice":{
                      "label":{
                        "plain":"Other"
                      },
                      "id":"a_25",
                      "switch":""
                    }
                  },
                  "label":{
                    "plain":"Amount"
                  },
                  "value":{
                    "plain":"Other" //(This could also be a dollar amount like 10.00)
                  },
                  "id":"a_21"
                },
                {
                  "label":{
                    "plain":"Other Amount"
                  },
                  "value":{
                    "plain":"200"
                  },
                  "id":"a_20"
                }
              ],
              "id":"a_26"
            },
            "id":"a_13"
          },
          "id":"a_12"
        }
      ]
    }

此处的目标是生成所有响应的报告,并以可读的方式打印数据(例如“ Bob Hogan-$ 200,Chad Smith-$ 100”)。

我想我将不得不使用某种map-reduce算法,因为简单地嵌套一堆循环既无法扩展,又在计算量大的情况下考虑到时间复杂度的增加,计算量也很大。也许我必须编写一个递归函数来映射我的数据集,检查id值,如果找到匹配的id,将其缩减为一个数组?

此外,我想避免使用第三方库。 PHP具有足够的本机功能来简化我要完成的工作。

1 个答案:

答案 0 :(得分:1)

实际上,不需要魔术算法。只需一点entent,水合器和过滤器形式的php魔术。

在此答案中,您将获得一种面向对象的php方法,该方法会将json api响应合并为对象,您可以轻松对其进行过滤。请记住,在此oop方法中,所有都是对象。

数据对象-数据实体

首先,您必须了解数据的结构。通过这种结构,您可以构建php对象。从给定的JSON结构中,您可以使用以下对象。

namespace Application\Entity;

// Just for recognizing entities as entities later
interface EntityInterface
{

}

class Title implements EntityInterface, \JsonSerializable
{
    public $plain;

    public function getPlain() : ?string
    {
        return $this->plain;
    }

    public function setPlain(string $plain) : Title
    {
        $this->plain = $plain;
        return $this;
    }

    public function jsonSerialize() : array
    {
        return get_object_vars($this);
    }
}

class Fieldset implements EntityInterface, \JsonSerializable
{
    /**
     * Label object
     * @var Label
     */
    public $label;

    /**
     * Collection of Field objects
     * @var \ArrayObject
     */
    public $fieldset;

    // implement getter and setter methods here
}

class Section implements EntityInterface, \JsonSerializable
{
    public $title;

    public $fieldsets;

    public function getTitle() : ?Title
    {
        return $this->title;
    }

    public function setTitle(Title $title) : Section
    {
        $this->title = $title;
        return $this;
    }

    public function getFieldsets() : \ArrayObject
    {
        if (!$this->fieldsets) {
            $this->fieldsets = new \ArrayObject();
        }

        return $this->fieldsets;
    }

    public function setFieldsets(Fieldset $fieldset) : Section
    {
        if (!$this->fieldsets) {
            $this->fieldsets = new \ArrayObject();
        }

        $this->fieldsets->append($fieldset);
        return $this;
    }

    public function jsonSerialize() : array
    {
         return get_object_vars($this);
    }
}

好吧,此类描述了示例中给出的第一个json对象的属性。为什么此类实现JsonSerializable interface?通过此实现,您可以将类结构转换回结构良好的json字符串。我不确定,是否需要。但是可以肯定的是,与其他api通信时,它是安全的。您现在唯一要做的就是为每个预期的复杂数据结构/ json对象编程实体。您需要具有plin属性的title对象和具有label和fieldset属性的fieldset对象,等等。

如何将json数据导入php对象-水化

当然,您给定的json结构是一个字符串。当谈到水合作用时,实际上是指将json字符串转换为对象结构。这种方法需要上述实体。

但是首先是水合器类本身。

namespace Application\Hydrator;
use \Application\Entity\EntityInterface;

class ClassMethodsHydrator
{
    protected $strategies;

    public function hydrate(array $data, EntityInterface $entity) : EntityInterface
    {
        foreach ($data as $key => $value) {
            if (!method_exists($entity, 'set' . ucfirst($key)) {
                throw new \InvalidArgumentException(sprintf(
                    'The method %s does not exist in %s',
                    get_class($entity)
                ));
            }

            if ($this->strategies[$key]) {
                $strategy = $this->strategies[$key];
                $value = $strategy->hydrate($value);
            }

            $entity->{'set' . ucfirst($key)}($value);
        }

        return $entity;
    }

    public function addStrategy(string $name, StrategyInterface $strategy) : Hydrator
    {
        $this->strategies[$name] = $strategy;
        return $this;
    }
}

好吧,这是发生所有魔法的课程。我猜这就是您提到的算法。水化器从json响应中获取您的数据,并将其推送到您的实体中。使实体水合后,可以通过调用实体的get方法轻松访问给定的数据。 由于json数据复杂且嵌套,因此我们必须使用水化器策略。水合作用的常见模式。可以将策略挂接到对象属性中并执行另一个水化器。因此,我们确保以相同的对象结构表示嵌套数据。

这是一个水化策略的例子。

namespace Application\Hydrator\Strategy;
use \Application\Entity\EntityInterface;

interface HydratorStrategy
{
    public function hydrate(array $value) : EntityInterface;
}

use \Application\Entity\Title;
class TitleHydratorStrategy implements HydratorStrategy
{
    public function hydrate(array $value) : EntityInterface
    {
        $value = (new ClassMethods())->hydrate($value, new Title);
        return $value;
    }
}

// Use case of a strategy
$data = json_decode$($response, true);
$section = (new ClassMethods())
    ->addStrategy('title', new TitleHydratorStrategy())
    ->hydrate($data, new Section());

那么,水合作用策略实际上是做什么的呢?在遍历我们的json api响应时,存在严重元素,这些元素是一个对象或包含对象。为了正确地水合这种多维结构,我们使用策略。

为了与您的JSON响应示例保持一致,我添加了一个简单的用例。首先,我们将json响应解码为关联的多维数组。之后,我们使用实体,水合器和水合器策略来获取包含所有数据的对象。用例知道,JSON响应中的title属性是一个对象,应合并到我们的title实体中,该title实体包含plain属性。

最后,我们的水合物体具有这样的结构...

\Application\Entity\Section {
     public:title => \Application\Entity\Title [
         public:plain => string 'Send Money'
     }
     ...
}

实际上,您可以使用我们实体的getter方法访问属性。

echo $section->getTitle()->getPlain(); // echoes 'Send money'

知道如何补水我们的课程,将我们带入下一步。聚集!

通过聚合获取完整字符串

实际上,聚合是现代面向对象编程中的一种常见设计模式。聚合意味着不多于不少于数据分配。让我们看一下您发布的JSON响应。如我们所见,根对象的fieldset属性包含一个fieldset对象的集合,我们可以通过我们的getter和setter方法进行访问。考虑到这一点,我们可以在section实体中创建其他getter方法。让我们使用getFullName方法扩展我们的section实体。

...
public function getFullName() : string
{
    $firstname = $lastname = '';

    // fetch the personal info section
    if ($this->getFieldsets()->offsetExists(0)) {
         $personalInfoFieldset = $this->getFieldsets()->offsetGet(0)->getFiedlset()->offsetGet(0);
         $firstname = $personalInfoFieldset->getField()->offsetGet(0)->getValue();
         $lastname = $personalInfoFieldset->getField()->offsetGet(1)->getValue();
    }

    return $this->concatenate(' ', $firstname, $lastname);
}

public function concatenate(string $filler, ...$strings) : string
{
    $string = '';
    foreach ($strings as $partial) {
        $string .= $partial . $filler;
    }

    return trim($string);
}

此示例假定,名字和姓氏在节实体的字段集集合的第一项中都可用。因此我们得到Bob Hogan作为返回值。 concatenate方法只是一个小帮手,它用填充符(空格)连接多个字符串。

使用我们的实体和FilterIterator类过滤数据

您还提到,必须通过ID查找特定数据。一种可能的解决方案可能是使用Filter Iterator类通过特定项过滤我们的实体。

namespace Application\Filter;

class PersonIdFilter extends \FilterIterator
{
    protected $id;

    public function __construct(Iterator $iterator, string $id)
    {
        parent::__construct($iterator);
        $this->id = $id;
    }

    public function accept()
    {
        $person = $this->getInnerIterator()->current();
        return ($person->getId() == $this->id) ? true : false;
    }
}

由于对我们的集合使用ArrayObject类,因此我们能够使用迭代器来过滤特定的参数。在这种情况下,我们会在个人信息字段集中过滤ID。

从水化示例开始,我们可能类似于以下代码。

$personalIterator = $section->getFieldsets()->offsetGet(0)->getFieldset()->getIterator();
$filter = new PersonIdFilter($personalIterator, 'a_8');
foreach ($filter as $result) {
    var_dump($result); // will output the first fieldset with the personal data
}

太复杂了?绝对不会!

正如您所说,您需要一个可扩展的解决方案,而无需在巨大的循环中嵌套嵌套。在我眼中,不仅仅编写一个巨大的单一函数就很有意义,它可以迭代json响应并返回所需的数据。由于可伸缩性高,因此在这种情况下使用对象更加有意义。您可以通过调用正确的getter方法来快速浏览所需的所有数据。此外,代码比庞大的函数更具可读性,而后者又一次又一次地迭代。在上面显示的方法中,您只需编写一次代码,然后一次又一次地重复使用所有对象。

请记住,上面显示的代码只是理论上的建议。未经测试。