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

Поэтому я бродил по 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 ссылку _parent .

2)

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

 // 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' ))); } } 


edit : в настоящее время 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 или сериализацию содержимого), а с другой стороны – соответствующий код для повторной конструирования объекта.

Моя версия:

 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

Я сделал хороший вспомогательный класс, который преобразует объект с методами 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; }