Сериализация объекта PHP в JSON

Поэтому я бродил по http://php.net/ за информацией о сериализации объектов PHP в JSON, когда наткнулся на новый интерфейс JsonSerializable. Это всего лишь PHP >= 5.4, и я работаю в среде 5.3.x.

Как достигается такая функциональность PHP <5.4?

Я еще не очень много работал с JSON, но я пытаюсь поддерживать уровень API в приложении, и выгрузка объекта данных (который в противном случае был бы отправлен в представление) в JSON была бы идеальной.

Если я пытаюсь сериализовать объект напрямую, он возвращает пустую строку JSON; потому что я предполагаю json_encode() не знает, что, черт возьми, делать с объектом. Должен ли я рекурсивно преобразовать объект в массив, а затем закодировать его?


пример

$data = new Mf_Data();
$data->foo->bar['hello'] = 'world';

echo json_encode($data) производит пустой объект:

{}

var_dump($data) Однако работает как ожидалось:

object(Mf_Data)#1 (5) {
  ["_values":"Mf_Data":private]=>
  array(0) {
  }
  ["_children":"Mf_Data":private]=>
  array(1) {
    [0]=>
    array(1) {
      ["foo"]=>
      object(Mf_Data)#2 (5) {
        ["_values":"Mf_Data":private]=>
        array(0) {
        }
        ["_children":"Mf_Data":private]=>
        array(1) {
          [0]=>
          array(1) {
            ["bar"]=>
            object(Mf_Data)#3 (5) {
              ["_values":"Mf_Data":private]=>
              array(1) {
                [0]=>
                array(1) {
                  ["hello"]=>
                  string(5) "world"
                }
              }
              ["_children":"Mf_Data":private]=>
              array(0) {
              }
              ["_parent":"Mf_Data":private]=>
              *RECURSION*
              ["_key":"Mf_Data":private]=>
              string(3) "bar"
              ["_index":"Mf_Data":private]=>
              int(0)
            }
          }
        }
        ["_parent":"Mf_Data":private]=>
        *RECURSION*
        ["_key":"Mf_Data":private]=>
        string(3) "foo"
        ["_index":"Mf_Data":private]=>
        int(0)
      }
    }
  }
  ["_parent":"Mf_Data":private]=>
  NULL
  ["_key":"Mf_Data":private]=>
  NULL
  ["_index":"Mf_Data":private]=>
  int(0)
}

добавление

1)

Так что это toArray() функция, которую я разработал для Mf_Data учебный класс:

public function toArray()
{
    $array = (array) $this;
    array_walk_recursive($array, function (&$property) {
        if ($property instanceof Mf_Data) {
            $property = $property->toArray();
        }
    });
    return $array;
}

Однако так как Mf_Data у объектов также есть ссылка на их родительский (содержащий) объект, это терпит неудачу с рекурсией. Работает как шарм, хотя, когда я удаляю _parent ссылка.

2)

Просто для продолжения, последняя функция для преобразования сложного объекта дерева-узла, с которым я пошел, была:

// class name - Mf_Data
// exlcuded properties - $_parent, $_index
public function toArray()
{
    $array = get_object_vars($this);
    unset($array['_parent'], $array['_index']);
    array_walk_recursive($array, function (&$property) {
        if (is_object($property) && method_exists($property, 'toArray')) {
            $property = $property->toArray();
        }
    });
    return $array;
}

3)

Я повторяю снова, с немного чище реализации. Использование интерфейсов для instanceof проверка кажется намного чище, чем method_exists() (однако method_exists() выполняет сквозное наследование / реализацию).

С помощью unset() тоже казался немного грязным, и кажется, что логика должна быть преобразована в другой метод. Однако эта реализация копирует массив свойств (из-за array_diff_key), так что стоит рассмотреть.

interface ToMapInterface
{

    function toMap();

    function getToMapProperties();

}

class Node implements ToMapInterface
{

    private $index;
    private $parent;
    private $values = array();

    public function toMap()
    {
        $array = $this->getToMapProperties();
        array_walk_recursive($array, function (&$value) {
            if ($value instanceof ToMapInterface) {
                $value = $value->toMap();
            }
        });
        return $array;
    }

    public function getToMapProperties()
    {
        return array_diff_key(get_object_vars($this), array_flip(array(
            'index', 'parent'
        )));
    }

}

10 ответов

Решение

изменить: в настоящее время 2016-09-24, и PHP 5.4 был выпущен 2012-03-01, и поддержка закончилась 2015-09-01. Тем не менее, этот ответ, кажется, набирает обороты. Если вы все еще используете PHP < 5.4, вы создаете угрозу безопасности и ставите под угрозу свой проект. Если у вас нет веских причин оставаться на уровне <5.4 или даже использовать версию>= 5.4, не используйте этот ответ, а просто используйте PHP>= 5.4 (или, как вы знаете, недавний) и реализуйте интерфейс JsonSerializable


Вы бы определили функцию, например с именем getJsonData();, который будет возвращать либо массив, stdClass объект, или некоторый другой объект с видимыми параметрами, а не частными / защищенными, и сделать json_encode($data->getJsonData());, По сути, реализуйте функцию из 5.4, но вызывайте ее вручную.

Нечто подобное будет работать, как get_object_vars() вызывается из класса, имея доступ к закрытым / защищенным переменным:

function getJsonData(){
    $var = get_object_vars($this);
    foreach ($var as &$value) {
        if (is_object($value) && method_exists($value,'getJsonData')) {
            $value = $value->getJsonData();
        }
    }
    return $var;
}

В простейших случаях тип хинтинга должен работать:

$json = json_encode( (array)$object );

json_encode() будет кодировать только открытые переменные-члены. так что если вы хотите включить частное, как только вы должны сделать это самостоятельно (как предложили другие)

Следующий код выполняет работу, используя отражение. Предполагается, что у вас есть геттеры для свойств, которые вы хотите сериализовать

    <?php

    /**
     * Serialize a simple PHP object into json
     * Should be used for POPO that has getter methods for the relevant properties to serialize
     * A property can be simple or by itself another POPO object
     *
     * Class CleanJsonSerializer
     */
    class CleanJsonSerializer {

    /**
     * Local cache of a property getters per class - optimize reflection code if the same object appears several times
     * @var array
     */
    private $classPropertyGetters = array();

    /**
     * @param mixed $object
     * @return string|false
     */
    public function serialize($object)
    {
        return json_encode($this->serializeInternal($object));
    }

    /**
     * @param $object
     * @return array
     */
    private function serializeInternal($object)
    {
        if (is_array($object)) {
            $result = $this->serializeArray($object);
        } elseif (is_object($object)) {
            $result = $this->serializeObject($object);
        } else {
            $result = $object;
        }
        return $result;
    }

    /**
     * @param $object
     * @return \ReflectionClass
     */
    private function getClassPropertyGetters($object)
    {
        $className = get_class($object);
        if (!isset($this->classPropertyGetters[$className])) {
            $reflector = new \ReflectionClass($className);
            $properties = $reflector->getProperties();
            $getters = array();
            foreach ($properties as $property)
            {
                $name = $property->getName();
                $getter = "get" . ucfirst($name);
                try {
                    $reflector->getMethod($getter);
                    $getters[$name] = $getter;
                } catch (\Exception $e) {
                    // if no getter for a specific property - ignore it
                }
            }
            $this->classPropertyGetters[$className] = $getters;
        }
        return $this->classPropertyGetters[$className];
    }

    /**
     * @param $object
     * @return array
     */
    private function serializeObject($object) {
        $properties = $this->getClassPropertyGetters($object);
        $data = array();
        foreach ($properties as $name => $property)
        {
            $data[$name] = $this->serializeInternal($object->$property());
        }
        return $data;
    }

    /**
     * @param $array
     * @return array
     */
    private function serializeArray($array)
    {
        $result = array();
        foreach ($array as $key => $value) {
            $result[$key] = $this->serializeInternal($value);
        }
        return $result;
    }  
} 

Просто реализуйте интерфейс, предоставленный PHP JsonSerializable.

Моя версия:

json_encode(self::toArray($ob))

Реализация:

private static function toArray($object) {
    $reflectionClass = new \ReflectionClass($object);

    $properties = $reflectionClass->getProperties();

    $array = [];
    foreach ($properties as $property) {
        $property->setAccessible(true);
        $value = $property->getValue($object);
        if (is_object($value)) {
            $array[$property->getName()] = self::toArray($value);
        } else {
            $array[$property->getName()] = $value;
        }
    }
    return $array;
}

JsonUtils: GitHub

Так как ваш тип объекта является пользовательским, я склонен согласиться с вашим решением - разбить его на более мелкие сегменты, используя метод кодирования (например, JSON или сериализацию содержимого), а на другом конце иметь соответствующий код для повторного конструирования объекта.

Измените свои типы переменных private к public

Это просто и удобнее.

Например

Не работает;

class A{
   private $var1="valuevar1";
   private $var2="valuevar2";
   public function tojson(){
    return json_encode($this)
   }
}

Это работает;

class A{
   public $var1="valuevar1";
   public $var2="valuevar2";
   public function tojson(){
    return json_encode($this)
   }
}

Попробуйте использовать это, это работало нормально для меня.

json_encode(unserialize(serialize($array)));

Я сделал хороший вспомогательный класс, который преобразует объект с методами get в массив. Он не зависит от свойств, а только от методов.

Итак, у меня есть следующий объект обзора, который содержит два метода:

Обзор

  • getAmountReviews: int
  • getReviews: массив комментариев

Комментарий

  • getSubject
  • getDescription

Сценарий, который я написал, преобразует его в массив со свойствами, которые выглядят так:

    {
      amount_reviews: 21,
      reviews: [
        {
          subject: "In een woord top 1!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
        },
        {
          subject: "En een zwembad 2!",
          description: "Maecenas et aliquet mi, a interdum mauris. Donec in egestas sem. Sed feugiat commodo maximus. Pellentesque porta consectetur commodo. Duis at finibus urna."
        },
        {
          subject: "In een woord top 3!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
        },
        {
          subject: "En een zwembad 4!",
          description: "Maecenas et aliquet mi, a interdum mauris. Donec in egestas sem. Sed feugiat commodo maximus. Pellentesque porta consectetur commodo. Duis at finibus urna."
       },
       {
          subject: "In een woord top 5!",
          description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque laoreet lacus quis eros venenatis, sed tincidunt mi rhoncus. Aliquam ut pharetra diam, nec lobortis dolor."
    }
]}

Источник: PHP Serializer, который преобразует объект в массив, который может быть закодирован в JSON.

Все, что вам нужно сделать, это обернуть json_encode вокруг вывода.

Некоторая информация о скрипте:

  • Добавлены только те методы, которые начинаются с get
  • Частные методы игнорируются
  • Конструктор игнорируется
  • Заглавные буквы в имени метода будут заменены символом подчеркивания и строчной буквы

Я потратил несколько часов на ту же проблему. Мой объект для преобразования содержит много других, определения которых я не должен касаться (API), поэтому я нашел решение, которое может быть медленным, но я использую его для целей разработки.

Этот преобразует любой объект в массив

function objToArr($o) {
$s = '<?php
class base {
    public static function __set_state($array) {
        return $array;
    }
}
function __autoload($class) {
    eval("class $class extends base {}");
}
$a = '.var_export($o,true).';
var_export($a);
';
$f = './tmp_'.uniqid().'.php';
file_put_contents($f,$s);
chmod($f,0755);
$r = eval('return '.shell_exec('php -f '.$f).';');
unlink($f);
return $r;
}

Это преобразует любой объект в stdClass

class base {
    public static function __set_state($array) {
        return (object)$array;
    }
}
function objToStd($o) {
$s = '<?php
class base {
    public static function __set_state($array) {
        $o = new self;
        foreach($array as $k => $v) $o->$k = $v;
        return $o;
    }
}
function __autoload($class) {
    eval("class $class extends base {}");
}
$a = '.var_export($o,true).';
var_export($a);
';
$f = './tmp_'.uniqid().'.php';
file_put_contents($f,$s);
chmod($f,0755);
$r = eval('return '.shell_exec('php -f '.$f).';');
unlink($f);
return $r;
}
Другие вопросы по тегам