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

Итак, я бродил вокруг php.net для получения информации о сериализации объектов PHP в JSON, когда я наткнулся на новый JsonSerializable Интерфейс. Это всего лишь PHP >= 5.4 хотя, и я бегу в 5.3.х окружающей среды.

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

я еще не много работал с JSON, но я пытаюсь поддерживать уровень API в приложении, и сброс объекта данных (который в противном случае был бы отправлен в view) в 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 ваши создают угрозу безопасности и endagering ваш проект. Если у вас нет веских причин оставаться на = 5.4,Не используйте этот ответ, и просто используйте PHP>= 5.4 (или, вы знаете, недавний) и реализовать интерфейс JsonSerializable


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

что-то вроде этого будет работать, как get_object_vars() вызывается изнутри класса, имея доступ к private / protected переменные:

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

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

$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 сериализатор, который преобразует объект в массив, который может быть закодирован в JSON.

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

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

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

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

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

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

этот преобразует любой объект в array

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;
}