Работа с JSON: кодирование PHP массивов и объектов

Пример с частичным выводом при ошибках: JSON_PARTIAL_OUTPUT_ON_ERROR

Этот флаг позволяет получить JSON даже если некоторые значения не могут быть закодированы. Некорректные значения заменяются на null.

<?php
$data = [
    'valid' => 'строка',
    'invalid' => fopen('php://memory', 'r'),
    'nested' => ['also valid' => 123]
];
$json = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_UNICODE);
echo $json;
?>

{"valid":"строка","invalid":null,"nested":{"also valid":123}}

Как видно, ресурс не удалось сериализовать, и он заменен на null. Остальные данные корректны. Это удобно для логирования или частичной передачи данных.

Пример рекурсивной сериализации с JsonSerializable

Когда объект содержит другие объекты, которые также реализуют JsonSerializable, кодирование происходит рекурсивно.

<?php
class Address implements JsonSerializable {
    private $city, $street;
    public function __construct($city, $street) {
        $this->city = $city;
        $this->street = $street;
    }
    public function jsonSerialize() {
        return ['city' => $this->city, 'street' => $this->street];
    }
}
class Person implements JsonSerializable {
    private $name;
    private $address;
    public function __construct($name, Address $address) {
        $this->name = $name;
        $this->address = $address;
    }
    public function jsonSerialize() {
        return ['name' => $this->name, 'address' => $this->address];
    }
}
$person = new Person('Мария', new Address('Москва', 'Тверская'));
echo json_encode($person, JSON_UNESCAPED_UNICODE);
?>

{"name":"Мария","address":{"city":"Москва","street":"Тверская"}}

Метод jsonSerialize в Person возвращает массив, содержащий объект Address. При кодировании этого массива json_encode вызывает jsonSerialize у объекта Address, создавая вложенную структуру.

Влияние флагов на экранирование слэшей и Unicode

По умолчанию json_encode экранирует обратный слэш и символы Unicode. С помощью флагов можно управлять этим.

<?php
$data = ['path' => '/home/user/file.txt', 'text' => 'Привет мир'];
echo "Без флагов:\n" . json_encode($data) . "\n\n";
echo "С JSON_UNESCAPED_SLASHES:\n" . json_encode($data, JSON_UNESCAPED_SLASHES) . "\n\n";
echo "С JSON_UNESCAPED_UNICODE:\n" . json_encode($data, JSON_UNESCAPED_UNICODE) . "\n\n";
echo "С обоими флагами:\n" . json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . "\n";
?>

Без флагов:
{"path":"\/home\/user\/file.txt","text":"\u041f\u0440\u0438\u0432\u0435\u0442 \u043c\u0438\u0440"}

С JSON_UNESCAPED_SLASHES:
{"path":"/home/user/file.txt","text":"\u041f\u0440\u0438\u0432\u0435\u0442 \u043c\u0438\u0440"}

С JSON_UNESCAPED_UNICODE:
{"path":"\/home\/user\/file.txt","text":"Привет мир"}

С обоими флагами:
{"path":"/home/user/file.txt","text":"Привет мир"}

Обратите внимание: без флагов слэши экранируются, а Unicode кодируется в escape-последовательности. Флаг JSON_UNESCAPED_SLASHES убирает экранирование слэшей. JSON_UNESCAPED_UNICODE оставляет кириллицу читаемой.

Преобразование больших чисел с JSON_BIGINT_AS_STRING

В PHP целые числа могут превышать максимальное значение, поддерживаемое JSON (2^53). При кодировании такие числа теряют точность. Флаг JSON_BIGINT_AS_STRING сохраняет их как строки.

<?php
$bigInt = 12345678901234567890;
$data = ['big' => $bigInt];
echo "Без флага:\n" . json_encode($data) . "\n";
echo "С JSON_BIGINT_AS_STRING:\n" . json_encode($data, JSON_BIGINT_AS_STRING);
?>

Без флага:
{"big":12345678901234568000}
С JSON_BIGINT_AS_STRING:
{"big":"12345678901234567890"}

Без флага число 12345678901234567890 было округлено до 12345678901234568000 из-за ограничения 64-битного представления. Использование флага сохраняет точность за счет строки.

Кодирование пустых массивов: объект или массив

Пустой массив [] по умолчанию кодируется как []. Но если нужно получить пустой объект {}, можно использовать JSON_FORCE_OBJECT. Однако это повлияет и на непустые массивы. Для выборочного контроля лучше использовать приведение массива к объекту.

<?php
$emptyArray = [];
$nonEmpty = ['a' => 1, 'b' => 2];
echo "Пустой массив:\n" . json_encode($emptyArray) . "\n";
echo "С JSON_FORCE_OBJECT:\n" . json_encode($emptyArray, JSON_FORCE_OBJECT) . "\n";
echo "Непустой ассоциативный массив:\n" . json_encode($nonEmpty, JSON_FORCE_OBJECT);
?>

Пустой массив:
[]
С JSON_FORCE_OBJECT:
{}
Непустой ассоциативный массив:
{"a":1,"b":2}

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