Справочники, инструменты, документация

PHP: Руководство по обработке JSON

JSON расшифровывается как JavaScript Object Notation. JSON — это стандартный легкий формат обмена данными, который просто и быстро анализировать и генерировать.

JSON, как и XML, представляет собой текстовый формат, который легко писать и легко читать как людям, так и для компьютерам, но в отличие от XML, структуры JSON-данных имеют меньшую пропускную способность, чем их версии XML. JSON основан на двух основных структурах:

  • Object: определяется как набор пар ключ/значение key:value. Каждый объект начинается с левой фигурной скобки { и заканчивается правой фигурной скобкой }. Несколько пар ключ/значение разделяются запятой ,.
  • Array: это упорядоченный список значений. Массив начинается с левой скобки [ и заканчивается правой скобкой ]. Значения разделяются запятой ,.

В JSON ключи всегда являются строками, а значение может быть string, number, true или false, null и даже object или array. Строки должны быть заключены в двойные кавычки " и могут содержать escape-символы, такие как \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 — самый популярный и легкий формат обмена данными для веб-приложений.

Парсинг JSON с помощью PHP

Структуры JSON-данных очень похожи на массивы PHP. PHP имеет встроенные функции для кодирования и декодирования данных JSON. Это функции json_encode() и json_decode() соответственно. Обе функции работают только со строковыми данными в кодировке UTF-8.

Кодирование данных JSON в PHP

В PHP функция json_encode() используется для кодирования значения в JSON-формат. Кодируемое значение может быть любым типом данных PHP, кроме ресурса, такого как база данных или дескриптор файла. В приведенном ниже примере показано, как кодировать ассоциативный массив PHP в объект JSON:

// Ассоциативный массив
$marks = array("Peter"=>65, "Harry"=>80, "John"=>78, "Clark"=>90);

echo json_encode($marks);

/* Выводит: {"Peter":65,"Harry":80,"John":78,"Clark":90} */

Точно так же вы можете закодировать индексированный массив PHP в массив JSON, например:

// Индексированный массив
$colors = array("Red", "Green", "Blue", "Orange", "Yellow");

echo json_encode($colors);

/* Выводит: ["Red","Green","Blue","Orange","Yellow"] */

Вы также можете заставить функцию json_encode() возвращать индексированный массив PHP как объект JSON, используя параметр JSON_FORCE_OBJECT, как показано в примере ниже:

// Индексированный массив
$colors = array("Red", "Green", "Blue", "Orange");

echo json_encode($colors, JSON_FORCE_OBJECT);

/* Выводит: {"0":"Red","1":"Green","2":"Blue","3":"Orange"} */

Как вы можете видеть в приведенных выше примерах, неассоциативный массив может быть закодирован как массив или объект. Однако ассоциативный массив всегда кодируется как объект.

Декодирование данных JSON в PHP

Расшифровать или декодировать JSON-данные так же просто, как и закодировать. Вы можете использовать PHP-функцию json_decode() для преобразования закодированной JSON-строки в соответствующий тип данных PHP. В следующем примере показано, как декодировать или преобразовать объект JSON в объект 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. Вот пример:

// Хранение 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.

// Назначаем закодированную 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(), например:

// Назначаем закодированную 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.

// Определяем рекурсивную функцию для извлечения вложенных значений
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);
}

// Назначаем закодированную 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 "<h3>" . $result["total"] . " value(s) found: </h3>";
echo implode("<br>", $result["values"]);

echo "<hr>";

// Выводим одно значение
echo $arr["book"]["author"] . "<br>"; // Выводит: J. K. Rowling
echo $arr["book"]["characters"][0] . "<br>"; // Выводит: Harry Potter
echo $arr["book"]["price"]["hardcover"]; // Выводит: $20.32