В этом материале мы рассмотрим как кодировать и декодировать JSON данные в PHP.
Содержание
Что такое JSON
JSON означает JavaScript Object Notation (нотация объектов JavaScript). JSON — это стандартный облегченный формат обмена данными, который быстро и легко анализировать и генерировать.
JSON, как и XML, является текстовым форматом, который легко пишется и понятен как людям, так и компьютерам, но в отличие от XML, структуры данных JSON занимают меньше полосы пропускания, чем их XML-версии. JSON основан на двух основных структурах:
- Объект (Object): Определяется как набор пар ключ/значение (т.е.
key:value
). Каждый объект начинается с левой фигурной скобки{
и заканчивается правой фигурной скобкой}
. Несколько пар ключ/значение разделены запятой,
. - Массив (Array): Определяется как упорядоченный список значений. Массив начинается с левой скобки
[
и заканчивается правой скобкой]
. Значения разделены запятой,
.
В JSON ключами всегда являются строки, а значением может быть строка, число, true или false, null или даже объект или массив. Строки должны быть заключены в двойные кавычки "
и могут содержать экранирующие символы, такие как \n
, \t
и \
. JSON объект может выглядеть так:
{
"book": {
"name": "Harry Potter and the Goblet of Fire",
"author": "J. K. Rowling",
"year": 2000,
"genre": "Fantasy Fiction",
"bestseller": true
}
}
В то время как пример массива JSON будет выглядеть примерно так:
{
"fruits": [
"Apple",
"Banana",
"Strawberry",
"Mango"
]
}
Парсинг
Структуры данных JSON очень похожи на массивы PHP. PHP имеет встроенные функции для кодирования и декодирования данных JSON. Этими функциями являются json_encode()
и json_decode()
соответственно. Обе функции работают только с строковыми данными в кодировке UTF-8.
Кодирование JSON данных
В PHP функция json_encode()
используется для кодирования значения в формат JSON.
Кодируемое значение может быть любым типом данных PHP, кроме ресурса, например, базы данных или дескриптора файла. В приведенном ниже примере показано, как кодировать ассоциативный массив PHP в объект JSON:
<?php
// ассоциативный массив
$marks = array("Peter"=>65, "Harry"=>80, "John"=>78, "Clark"=>90);
echo json_encode($marks);
?>
Вывод вышеприведенного примера будет выглядеть следующим образом:
{"Peter":65,"Harry":80,"John":78,"Clark":90}
Точно так же вы можете закодировать индексированный массив PHP в массив JSON, например так:
<?php
// индексированный массив
$colors = array("Red", "Green", "Blue", "Orange", "Yellow");
echo json_encode($colors);
?>
Вывод вышеприведенного примера будет выглядеть следующим образом:
["Red","Green","Blue","Orange","Yellow"]
Вы также можете заставить функцию json_encode()
возвращать индексированный массив PHP как объект JSON, используя опцию JSON_FORCE_OBJECT
, как показано в примере ниже:
<?php
// индексированный массив
$colors = array("Red", "Green", "Blue", "Orange");
echo json_encode($colors, JSON_FORCE_OBJECT);
?>
Вывод вышеприведенного примера будет выглядеть следующим образом:
{"0":"Red","1":"Green","2":"Blue","3":"Orange"}
Как вы можете видеть в приведенных выше примерах, неассоциативный массив может быть закодирован как массив или объект. Однако ассоциативный массив всегда кодируется как объект.
Декодирование данных JSON
Декодирование данных JSON так же просто, как и их кодирование. Вы можете использовать функцию PHP json_decode()
для преобразования строки в кодировке JSON в соответствующий тип данных PHP. В следующем примере показано, как декодировать или преобразовать объект JSON в объект PHP.
<?php
// сохранение данных JSON в переменной PHP
$json = '{"Peter":65,"Harry":80,"John":78,"Clark":90}';
var_dump(json_decode($json));
?>
Вывод вышеприведенного примера будет выглядеть примерно так:
object(stdClass)#1 (4) { ["Peter"]=> int(65) ["Harry"]=> int(80) ["John"]=> int(78) ["Clark"]=> int(90) }
По умолчанию функция json_decode()
возвращает объект. Однако можно дополнительно указать второй параметр $assoc
, который принимает булевое значение, при котором при установке в качестве true
JSON объекты декодируются в ассоциативные массивы. По умолчанию оно равно false
. Приведем пример:
<?php
// сохранение данных JSON в переменной PHP
$json = '{"Peter":65,"Harry":80,"John":78,"Clark":90}';
var_dump(json_decode($json, true));
?>
Вывод вышеприведенного примера будет выглядеть примерно так:
array(4) { ["Peter"]=> int(65) ["Harry"]=> int(80) ["John"]=> int(78) ["Clark"]=> int(90) }
Теперь рассмотрим пример, который покажет, как декодировать JSON-данные и получить доступ к отдельным элементам JSON-объекта или массива в PHP.
<?php
// присвоение строки в кодировке JSON переменной PHP
$json = '{"Peter":65,"Harry":80,"John":78,"Clark":90}';
// декодировать JSON данные в ассоциативный массив PHP
$arr = json_decode($json, true);
// доступ к значениям из ассоциативного массива
echo $arr["Peter"]; // вывод: 65
echo $arr["Harry"]; // вывод: 80
echo $arr["John"]; // вывод: 78
echo $arr["Clark"]; // вывод: 90
// декодировать JSON данные в объект PHP
$obj = json_decode($json);
// доступ к значениям из возвращенного объекта
echo $obj->Peter; // вывод: 65
echo $obj->Harry; // вывод: 80
echo $obj->John; // вывод: 78
echo $obj->Clark; // вывод: 90
?>
Также можно перебирать декодированные данные, используя цикл foreach()
:
<?php
// присвоение строки в кодировке JSON переменной PHP
$json = '{"Peter":65,"Harry":80,"John":78,"Clark":90}';
// декодировать JSON данные в ассоциативный массив PHP
$arr = json_decode($json, true);
// цикл по ассоциативному массиву
foreach($arr as $key=>$value){
echo $key . "=>" . $value . "<br>";
}
echo "<hr>";
// декодировать JSON данные в объект PHP
$obj = json_decode($json);
// перебираем объект в цикле
foreach($obj as $key=>$value){
echo $key . "=>" . $value . "<br>";
}
?>
Извлечение значений из вложенных данных JSON в PHP
Объекты и массивы JSON также могут быть вложенными. Объект JSON может произвольно содержать другие объекты JSON, массивы, вложенные массивы, массивы объектов JSON и т.д. В следующем примере показано, как декодировать вложенный объект JSON и вывести все его значения в PHP.
<?php
// Определение рекурсивной функции для извлечения вложенных значений
function printValues($arr) {
global $count;
global $values;
// проверяем массив ли на входе
if(!is_array($arr)){
die("ERROR: Input is not an array");
}
/*
Проходим по массиву, если значение само является массивом, рекурсивно вызываем функцию, иначе добавляем найденное значение в массив выходных элементов и увеличиваем счетчик на 1 для каждого найденного значения
*/
foreach($arr as $key=>$value){
if(is_array($value)){
printValues($value);
} else{
$values[] = $value;
$count++;
}
}
// возвращаем суммарное количество и значения, найденные в массиве
return array('total' => $count, 'values' => $values);
}
// присваиваем переменной PHP строку в кодировке JSON
$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 "<h3>" . $result["total"] . " value(s) found: </h3>";
echo implode("<br>", $result["values"]);
echo "<hr>";
// Выводим одиночные значения
echo $arr["book"]["author"] . "<br>"; // Output: J. K. Rowling
echo $arr["book"]["characters"][0] . "<br>"; // Output: Harry Potter
echo $arr["book"]["price"]["hardcover"]; // Output: $20.32
?>