Серіалізація PHP-об'єкта в JSON


101

Тому я блукав по 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'
        )));
    }

}

4
+1 Приємне запитання, я ще не знав цієї функції.
takehin

@takeshin - Yeop, дата редагування на сторінці doc - 4 дні тому. Я радий це бачити!
Ден Лугг

2
Для посилання на інших, хто дивиться на це, json_encode може добре обробляти об'єкти. Однак він кодує лише публічних членів цього об’єкта. Отже, якщо у вас є захищені чи приватні змінні класу, то вам потрібен або один із розміщених методів, або JsonSerializable.
Метью Гербст

@MatthewHerbst Безумовно. Старе питання зараз старе, і <5.4 все-таки вже не є варіантом (або, принаймні, не повинен бути) ОднозначноJsonSerializable
Dan Lugg

Відповіді:


45

редагувати : наразі це 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об'єкт або який-небудь інший об'єкт із видимими параметрами, а не приватні / захищені, і робити a 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;
}

2
Дякуємо @Wrikken - Чи є ярлик для зменшення об'єкта, об'єктів, що містяться в ньому ( усіх членів незалежно від видимості чи типу ), до асоціативного масиву чи набираєш його stdClass? Я думаю в напрямку відбиття , але якщо ні, я просто вигадаю щось, щоб рекурсивно його виконати.
Ден Лугг

Роздум був би довгим шляхом. Коли ви перебуваєте всередині класу у своїй getJsonData()функції, ви можете просто зателефонувати get_object_vars()та переглядати цей результат, шукаючи більше об'єктів.
Wrikken

Я майже розібрався з цим; питання зараз - рекурсія. Кожен об’єкт має _parentвластивість, так що дерево можна перенести до кореня. Перегляньте мою редакцію для оновлення; можливо, я повинен поставити ще одне запитання, оскільки це питання зараз абстрагується від мого оригіналу.
Ден Лугг

Простий unset($array['_parent']);перед прогулянкою повинен зробити трюк.
Wrikken

Дивовижний, дякую @Wrikken - Я починав пробувати складні тести рівності, передаючи контекстний об’єкт $parentяк дані користувача array_walk_recursive(). Просто - красиво! Крім того, це $array["\0class\0property"]через забруднення нуля байтів, тому що я використовував кастинг. Думаю, я перейду на get_object_vars().
Ден Лугг

91

У найпростіших випадках натяк на тип повинен працювати:

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

7
Це дає довгі звиті / потворні імена властивостей, якщо ви працюєте з просторами імен та автозавантажувачем.
BetaRide

це найкраще рішення, точне і стисле!
Sujal Mandal

4
чи є спосіб отримати більш чисті імена властивостей?
Крістофер

5
чому він додає \ u0000 * \ u0000 на початку підтримки імен?
Елія Вайс

1
Марно з приватною власністю. Ви всі повинні дізнатися про en.wikipedia.org/wiki/Open/closed_principle .
Fabian Picone

19

json_encode()буде кодувати лише змінні публічного члена тому якщо ви хочете включити приватне, коли вам доведеться це зробити самостійно (як запропонували інші)


8

Наступний код виконує роботу за допомогою відображення. Це передбачає, що у вас є дістачі для властивостей, які ви хочете серіалізувати

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

1
Я зараз так закоханий у тебе! Я надішлю тобі бекон чи пиво чи кекс, а як кекс?
Джонатан дос Сантос

це чудовий клас! він також працює з об'єктами, що захищаються.
Roelof Berkepeis


2

Оскільки тип вашого об’єкта є звичайним, я схильний би погодитися з вашим рішенням - розбийте його на більш дрібні сегменти, використовуючи метод кодування (наприклад, JSON або серіалізуючи вміст), а на іншому кінці маю відповідний код для реконструкції об'єкта.


2

Моя версія:

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


Саме те, що я шукав. Вирішує проблему з приватними особами. Просте і маленьке.
Фабіан Піконе


1

Перейдіть до типів змінних 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)
   }
}

дуже дивно. але це правда.
Абілогос

0

Я зробив хороший хелперний клас, який перетворює об'єкт методами 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
  • Приватні методи ігноруються
  • Конструктор ігнорується
  • Великі літери у назві методу будуть замінені символом підкреслення та нижчим регістром

-7

Я витратив кілька годин на ту саму проблему. Мій об’єкт для перетворення містить багато інших, до визначень яких я не повинен торкатися (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;
}

Є ще одна тонка і точно відповідь, вже прийнята. Чи додає ваша відповідь щось радикально інше, більш ефективне чи компактне? Гадаю, ні
Ярослав

Я буду чесним; Я не думаю, що це взагалі відповідає на питання.
Ден Лугг

5
Минуло близько 6 місяців; Я періодично повертався сюди через оновлення та вносити зміни для майбутніх відвідувачів; Я досі не маю уявлення, що, до біса, це має робити.
Ден Лугг

unlink($thisAnswer);
Ден Лугг

люди схиляються до того, що вони не розуміють. Це, можливо, не скажеш точне рішення, але це щось, на що слід звернути увагу. У такому випадку ви звертаєтесь із проханням до роз'яснень перед головою.
Гімалі
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.