- JSON в PHP
- Что такое JSON
- Синтаксис JSON на примерах
- Пример
- Пример
- PHP и JSON
- Кодирование данных JSON в PHP
- Синтаксис
- Параметры
- Пример
- Пример
- Пример
- Пример
- Пример
- Декодирование данных JSON в PHP
- Синтаксис
- Параметры
- Пример
- Пример
- Доступ к декодированным значениям JSON в PHP
- Пример
- Пример
- Пример
- Извлечение значений из вложенных данных JSON в PHP
- Пример
- json_encode
- Список параметров
- Возвращаемые значения
- Список изменений
- Примеры
- Примечания
- Смотрите также
JSON в PHP
В этом уроке вы узнаете, как кодировать и декодировать данные JSON в PHP.
Что такое JSON
JSON расшифровывается как аббревиатура от J ava S cript O bject N otation. JSON — это стандартный текстовый формат обмена данными, основанный на JavaScript, который представляет собой набор пар .
В JSON, ключи всегда строки, в то время как значение может быть string , number , true или false , null , object или array . Строки должны быть заключены в двойные кавычки » и могут содержать управляющие символы, такие как \n , \t и \ . JSON более компактный, чем xml, поэтому он более предпочтителен для обмена данными между веб-браузером и сервером.
Синтаксис JSON на примерах
Объект JSON может выглядеть так:
Пример
В то время как пример массива JSON будет выглядеть примерно так:
Пример
PHP и JSON
Структуры данных JSON очень похожи на массивы PHP. В языке PHP существуют специальные функции для кодирования и декодирования данных JSON. Это функции json_encode() и json_decode() соответственно. Они уже встроены в ядро PHP, поэтому никаких библиотек подключать не нужно. Обе функции работают только со строковыми данными в кодировке UTF-8.
Кодирование данных JSON в PHP
В PHP функция json_encode() используется для кодирования значения в формат JSON. Кодируемое значение может быть любым типом данных PHP, кроме ресурса, такого как база данных или дескриптор файла.
Синтаксис
Параметры
value — значение, которое будет закодировано. Может быть любого типа за исключением resource. Все строковые данные должны быть в кодировке UTF-8. options Битовая маска составляемая из значений JSON_HEX_QUOT , JSON_HEX_TAG , JSON_HEX_AMP , JSON_HEX_APOS , JSON_NUMERIC_CHECK , JSON_PRETTY_PRINT , JSON_UNESCAPED_SLASHES , JSON_FORCE_OBJECT , JSON_UNESCAPED_UNICODE . depth Задает максимальную глубину. Должен быть больше нуля.
В приведенном ниже примере показано, как кодировать ассоциативный массив PHP в объект JSON:
Пример
65, "Harry"=>80, "John"=>78, "Clark"=>90); echo json_encode($marks); ?>
Результат приведенного выше примера будет выглядеть так:
В следующем примере посмотрим, как будут кодироваться кириллические символы:
Пример
65, "Игорь"=>80, "Денис"=>78, "Николай"=>90); echo json_encode($marks); ?>
Результат приведенного выше примера будет выглядеть так:
Как видно кириллица кодируется, исправляется это добавлением опции: JSON_UNESCAPED_UNICODE .
Пример
65, "Игорь"=>80, "Денис"=>78, "Николай"=>90); echo json_encode($marks, JSON_UNESCAPED_UNICODE); ?>
Результат выполнения кода:
Точно так же вы можете закодировать индексированный массив PHP в массив JSON, например:
В следующем примере посмотрим, как будут кодироваться кириллические символы:
Пример
Результат выполнения кода:
Если применить параметр JSON_FORCE_OBJECT , то функция json_encode() будет возвращать индексированный массив PHP как объект JSON:
Пример
Результат выполнения кода:
Примечание: Неассоциативный массив может быть закодирован как массив или объект. Однако ассоциативный массив всегда кодируется как объект.
Декодирование данных JSON в PHP
Функция PHP json_decode() используется для декодирования JSON в PHP. Эта функция возвращает значение, декодированное из json в соответствующий тип данных PHP.
Синтаксис
mixed json_decode ( string $json [, bool $assoc = false [, int $depth = 512 [, int $options = 0 ]]] )
Параметры
json — json строка (string) для декодирования. Эта функция работает только со строками в UTF-8 кодировке. assoc Если TRUE, возвращаемые объекты будут преобразованы в ассоциативные массивы. depth Указывает глубину рекурсии. options Битовая маска опций декодирования JSON. В настоящий момент поддерживается только JSON_BIGINT_AS_STRING (по умолчанию большие целые числа приводятся к числам с плавающей запятой (float))
В следующем примере показано, как декодировать или преобразовать объект JSON в объект PHP:
Пример
Результат выполнения кода:
Функция json_decode() по умолчанию возвращает объект. Если нужно JSON декодировать в ассоциативный массив, то укажите значение второго параметра $assoc в качестве true . По умолчанию его значение — false :
Пример
'; var_dump(json_decode($json, true)); ?>
Результат выполнения кода:
Доступ к декодированным значениям JSON в PHP
Теперь рассмотрим пример, который показывает, как декодировать данные JSON и получить доступ к отдельным элементам объекта JSON в PHP:
Пример
'; $obj = json_decode($jsonobj); // Доступ к значениям из возвращенного объекта echo $obj->Peter; // вывод 35 echo $obj->Ben; // вывод 37 echo $obj->Joe; // вывод 43 ?>
В этом примере показано, как получить доступ к отдельным элементам ассоциативного массива PHP:
Пример
'; $arr = json_decode($json, true); // Доступ к значениям из ассоциативного массива echo $arr["Peter"]; // вывод: 65 echo $arr["Harry"]; // вывод: 80 echo $arr["John"]; // вывод: 78 echo $arr["Clark"]; // вывод: 90 ?>
Вы также можете перебирать декодированные данные с помощью цикла foreach(), например:
Пример
'; // Декодирование данных JSON в ассоциативный массив PHP $arr = json_decode($json, true); // Перебираем ассоциативный массив foreach($arr as $key=>$value)< echo $key . "=>" . $value . "
"; > echo "
"; // Декодируем данные JSON в объект PHP $obj = json_decode($json); // Перебираем в цикле значения объекта foreach($obj as $key=>$value)< echo $key . "=>" . $value . "
"; > ?>
Извлечение значений из вложенных данных JSON в PHP
Объекты и массивы JSON также могут быть вложенными. Объект JSON может содержать другие объекты JSON, массивы, вложенные массивы, массивы объектов JSON и т.д. В следующем примере показано, как декодировать вложенный объект JSON и распечатать все его значения в PHP:
Пример
/* Прокручиваем в цикле массив, если значение само по себе является массивом, рекурсивно вызываем функцию else добавляет найденное значение в массив элементов вывода, и увеличивает счетчик на 1 для каждого найденного значения */ foreach($arr as $key=>$value) < if(is_array($value))< printValues($value); >else < $values[] = $value; $count++; >> // Возвращает общее количество и значения, найденные в массиве return array('total' => $count, 'values' => $values); > // Назначаем закодированную строку JSON переменной PHP $json = ' < "book": < "name": "Harry Potter and the Goblet of Fire", "author": "J. K. Rowling", "year": 2000, "characters": ["Harry Potter", "Hermione Granger", "Ron Weasley"], "genre": "Fantasy Fiction", "price": < "paperback": "$10.40", "hardcover": "$20.32", "kindle": "4.11" >> >'; // Декодирование данных JSON в формат ассоциативного массива PHP $arr = json_decode($json, true); // Вызвать функцию и распечатать все значения $result = printValues($arr); echo "" . $result["total"] . " value(s) found:
"; echo implode("
", $result["values"]); echo "
"; // Вывести одно значение echo $arr["book"]["author"] . "
"; // Вывод: J.K. Rowling echo $arr["book"]["characters"][0] . "
"; // Вывод: Harry Potter echo $arr["book"]["price"]["hardcover"]; // Вывод: $20.32 ?>
json_encode
Возвращает строку, содержащую JSON-представление value .
Список параметров
value — значение, которое будет закодировано. Может быть любого типа за исключением resource .
Все строковые данные должны быть в кодировке UTF-8.
Замечание:
PHP реализует надмножество JSON, который описан в первоначальном » RFC 4627, — также кодируя и декодируя скалярные типы и NULL . RFC 4627 поддерживает эти значения только в случае, если они находятся внутри массива или объекта.
И хотя это надмножество согласуется с расширенным определением «JSON текста» из новых » RFC 7159 (который старается заменить собой RFC 4627) и » ECMA-404, это все равно может приводить к проблемам совместимости со старыми парсерами JSON, которые строго придерживаются RFC 4627 с кодированием скалярных значений.
Битовая маска составляемая из значений JSON_HEX_QUOT , JSON_HEX_TAG , JSON_HEX_AMP , JSON_HEX_APOS , JSON_NUMERIC_CHECK , JSON_PRETTY_PRINT , JSON_UNESCAPED_SLASHES , JSON_FORCE_OBJECT , JSON_UNESCAPED_UNICODE . Смысл этих констант объясняется на странице JSON констант.
Задает максимальную глубину. Должен быть больше нуля.
Возвращаемые значения
Возвращает JSON закодированную строку ( string ) в случае успеха или FALSE в случае возникновения ошибки.
Список изменений
Версия | Описание |
---|---|
5.5.0 | Добавлен параметр depth . |
5.4.0 | В options были добавлены константы JSON_PRETTY_PRINT , JSON_UNESCAPED_SLASHES , и JSON_UNESCAPED_UNICODE . |
5.3.3 | Константа JSON_NUMERIC_CHECK была добавлена в option . |
5.3.0 | Был добавлен параметр options . |
Примеры
Пример #1 Пример использования json_encode()
$arr = array( ‘a’ => 1 , ‘b’ => 2 , ‘c’ => 3 , ‘d’ => 4 , ‘e’ => 5 );
?php
Результат выполнения данного примера:
Пример #2 Пример использования json_encode() , показывающий действия некоторых его опций
echo «Обычно: » , json_encode ( $a ), «\n» ;
echo «Тэги: » , json_encode ( $a , JSON_HEX_TAG ), «\n» ;
echo «Апострофы: » , json_encode ( $a , JSON_HEX_APOS ), «\n» ;
echo «Кавычки: » , json_encode ( $a , JSON_HEX_QUOT ), «\n» ;
echo «Амперсанды: » , json_encode ( $a , JSON_HEX_AMP ), «\n» ;
echo «Юникод: » , json_encode ( $a , JSON_UNESCAPED_UNICODE ), «\n» ;
echo «Все: » , json_encode ( $a , JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE ), «\n\n» ;
echo «Отображение пустого массива как массива: » , json_encode ( $b ), «\n» ;
echo «Отображение пустого массива как объекта: » , json_encode ( $b , JSON_FORCE_OBJECT ), «\n\n» ;
echo «Отображение неассоциативного массива как массива: » , json_encode ( $c ), «\n» ;
echo «Отображение неассоциативного массива как объекта: » , json_encode ( $c , JSON_FORCE_OBJECT ), «\n\n» ;
$d = array( ‘foo’ => ‘bar’ , ‘baz’ => ‘long’ );
echo «Ассоциативный массив всегда отображается как объект: » , json_encode ( $d ), «\n» ;
echo «Ассоциативный массив всегда отображается как объект: » , json_encode ( $d , JSON_FORCE_OBJECT ), «\n\n» ;
?>
Результат выполнения данного примера:
Обычно: [«»,»‘bar'»,»\»baz\»»,»&blong&»,»\u00e9″] Тэги: [«\u003Cfoo\u003E»,»‘bar'»,»\»baz\»»,»&blong&»,»\u00e9″] Апострофы: [«»,»\u0027bar\u0027″,»\»baz\»»,»&blong&»,»\u00e9″] Кавычки: [«»,»‘bar'»,»\u0022baz\u0022″,»&blong&»,»\u00e9″] Амперсанды: [«»,»‘bar'»,»\»baz\»»,»\u0026blong\u0026″,»\u00e9″] Unicode: [«»,»‘bar'»,»\»baz\»»,»&blong&»,»é»] Все: [«\u003Cfoo\u003E»,»\u0027bar\u0027″,»\u0022baz\u0022″,»\u0026blong\u0026″,»é»] Отображение пустого массива как массива: [] Отображение не ассоциативного массива как объекта: <> Отображение неассоциативного массива как массива: [[1,2,3]] Отображение неассоциативного массива как объекта: > Ассоциативный массив всегда отображается как объект: Ассоциативный массив всегда отображается как объект:
Пример #3 Пример с последовательными индексами начинающимися с нуля и непоследовательными индексами массивов
echo «Последовательный массив» . PHP_EOL ;
$sequential = array( «foo» , «bar» , «baz» , «blong» );
var_dump (
$sequential ,
json_encode ( $sequential )
);
?php
echo PHP_EOL . «Непоследовательный массив» . PHP_EOL ;
$nonsequential = array( 1 => «foo» , 2 => «bar» , 3 => «baz» , 4 => «blong» );
var_dump (
$nonsequential ,
json_encode ( $nonsequential )
);
echo PHP_EOL . «Последовательный массив с одним удаленным индексом» . PHP_EOL ;
unset( $sequential [ 1 ]);
var_dump (
$sequential ,
json_encode ( $sequential )
);
?>
Результат выполнения данного примера:
Последовательный массив array(4) < [0]=>string(3) "foo" [1]=> string(3) "bar" [2]=> string(3) "baz" [3]=> string(5) "blong" > string(27) "["foo","bar","baz","blong"]" Непоследовательный массив array(4) < [1]=>string(3) "foo" [2]=> string(3) "bar" [3]=> string(3) "baz" [4]=> string(5) "blong" > string(43) "" Последовательный массив с одним удаленным индексом array(3) < [0]=>string(3) "foo" [2]=> string(3) "baz" [3]=> string(5) "blong" > string(33) ""
Примечания
Замечание:
В случае ошибки кодирования, можно использовать json_last_error() для определения точной ошибки.
Замечание:
При кодировании массива в случае, если его индексы не являются последовательными числами от нуля, то все индексы кодируются в строковые ключи для каждой пары индекс-значение.
Замечание:
Как и эталонный кодировщик JSON, json_encode() будет создавать JSON в виде простого значения (т.е. не объект и не массив), если ему переданы string , integer , float или boolean в качестве входящего значения value . Большинство декодеров воспринимают эти значения как правильный JSON, но некоторые нет, потому что спецификация неоднозначна на этот счет.
Всегда проверяйте, что ваш JSON декодер может правильно обрабатывать данные, которые вы создаете с помощью json_encode() .
Смотрите также
- JsonSerializable
- json_decode() — Декодирует JSON строку
- json_last_error() — Возвращает последнюю ошибку
- serialize() — Генерирует пригодное для хранения представление переменной