Перейти до змісту
Intita
Лекція · 35 хв

JSON: json_encode і json_decode

Що ви дізнаєтесь

  • Як влаштований формат JSON і як він відповідає масивам PHP
  • Як перетворити масив на JSON і назад
  • Що робить PHP зі зламаним JSON і як цього не проґавити
  • Як зберегти масив записів у файлі й віддати JSON у відповідь API

У лекції «Файли: читання й запис» у файл потрапляв рядок тексту. Записи гостьової книги — масив масивів, а файл зберігає лише текст. Потрібен формат, що перетворює масив на текст і назад без втрат.

Формат JSON

JSON (JavaScript Object Notation) — текстовий формат даних. Його розуміють PHP, JavaScript, Python та інші мови, тож ним обмінюються сайти й програми. Список справ у JSON:

[
    {
        "title": "Купити каву",
        "done": false,
        "tags": ["дім", "терміново"],
        "note": null
    },
    {
        "title": "Полити квіти",
        "done": true,
        "tags": [],
        "note": "двічі на тиждень"
    }
]
  • [ … ] — масив: значення через кому, як індексний масив PHP.
  • { … } — об'єкт: "ключ": значення через кому, як асоціативний масив.
  • Значення — рядок, число, true / false, null, масив чи об'єкт. Рядки й ключі пишуть лише в подвійних лапках.
  • Коментарів і коми після останнього елемента JSON не дозволяє.

json_encode(): з масиву в JSON

json_encode() — вбудована функція, що перетворює значення PHP на рядок JSON:

<?php
$task = ['id' => 1, 'title' => 'Купити каву', 'done' => false];

echo json_encode($task), "\n";
echo json_encode($task, JSON_UNESCAPED_UNICODE), "\n";
echo json_encode([$task], JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT), "\n";
{"id":1,"title":"\u041a\u0443\u043f\u0438\u0442\u0438 \u043a\u0430\u0432\u0443","done":false}
{"id":1,"title":"Купити каву","done":false}
[
    {
        "id": 1,
        "title": "Купити каву",
        "done": false
    }
]
  • Асоціативний масив стає об'єктом {}, індексний з ключами 0, 1, 2… — масивом []. Типи зберігаються: 1 — число, false — логічне значення.
  • Без прапорців кожна літера кирилиці стає кодом \uXXXX. Це правильний JSON, і json_decode() поверне «Купити каву», але людина такий файл не прочитає. JSON_UNESCAPED_UNICODE залишає літери як є.
  • JSON_PRETTY_PRINT додає переноси й відступи з 4 пробілів — зручно для файлу, який ви відкриватимете в IDE.
  • Прапорці поєднують через |, як FILE_APPEND | LOCK_EX.
Що виведе echo json_encode(['name' => 'Ян', 'rating' => 5]);?

json_decode(): з JSON у масив

<?php
$json = '{"id":1,"title":"Купити каву","done":false}';

$task = json_decode($json, true);
var_dump($task['title']);              // string(21) "Купити каву"
var_dump($task['done']);               // bool(false)

$broken = "{'title': 'Купити каву'}";  // одинарні лапки — не JSON
var_dump(json_decode($broken, true));  // NULL
echo json_last_error_msg();            // Syntax error
  • json_decode($json, true) — true другим аргументом просить асоціативні масиви. Без нього кожен об'єкт {…} стає об'єктом stdClass, і $task['title'] зупиняє скрипт: Cannot use object of type stdClass as array. Об'єкти нам не потрібні, тож true пишемо завжди.
  • Зламаний JSON json_decode() не зупиняє скрипт і не попереджає — просто повертає null. Причину називає json_last_error_msg(): Syntax error, а якщо помилки не було — No error.

Тихий null небезпечний. Якщо файл зі списком зіпсовано (скажімо, зайвою комою), сторінка вирішить, що справ немає, а наступне збереження перезапише файл одним новим записом — решта пропаде. Прапорець JSON_THROW_ON_ERROR робить помилку гучною: json_decode($broken, true, 512, JSON_THROW_ON_ERROR) зупиняє скрипт з Fatal error: Uncaught JsonException: Syntax error. Прапорці в json_decode() — четвертий аргумент, тож перед ними стоїть третій — найбільша глибина вкладеності, 512 за замовчуванням.

json_encode() теж буває невдалим: рядок, розрізаний посеред літери, — не UTF-8, і функція повертає false, а file_put_contents($path, false) записує порожній файл. З JSON_THROW_ON_ERROR скрипт зупиниться до запису з Malformed UTF-8 characters, possibly incorrectly encoded, і старий файл лишиться цілим.

Сторінка читає список справ кодом нижче — і зупиняється з Fatal error: Uncaught Error: Cannot use object of type stdClass as array. Де помилка?
<?php
$tasks = json_decode(file_get_contents($path));
echo $tasks[0]['title'];

Масив записів у файлі й API

Сторінки досі віддавали HTML для людей. API (Application Programming Interface) — адреси для програм: мобільного застосунку, JavaScript на сторінці, іншого сервера. Вони обмінюються даними, найчастіше в JSON. Ось маленьке API списку справ: воно читає масив із файлу, додає справу з POST і відповідає всім списком.

<?php
// src/public/api/tasks.php — список справ у файлі JSON
$path = __DIR__ . '/../../storage/tasks.json';

// прочитати: файлу ще немає — список порожній
$tasks = file_exists($path)
    ? json_decode(file_get_contents($path), true, 512, JSON_THROW_ON_ERROR)
    : [];

// додати справу з POST і записати весь масив назад
$title = trim($_POST['title'] ?? '');
if ($title !== '') {
    $tasks[] = ['title' => $title, 'done' => false];
    $json = json_encode($tasks, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR);
    file_put_contents($path, $json, LOCK_EX);
}

header('Content-Type: application/json; charset=utf-8');
echo json_encode($tasks, JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR);
  • Це цикл «прочитати → змінити → записати» з попередньої лекції: JSON не дописують у кінець, а перезаписують весь файл, тому LOCK_EX.
  • JSON_THROW_ON_ERROR і під час читання, і під час запису: зламаний файл зупинить сторінку, а не обнулить список.
  • Файл — для людей, тож із JSON_PRETTY_PRINT: у src/storage/tasks.json справи стоять по рядках, з кирилицею. Відповідь — для програм, тож компактна.
  • header() з лекції «Сесії: вхід, вихід і flash-повідомлення» ставить заголовок Content-Type (лекція «HTTP: запит і відповідь»): у тілі JSON. Без нього PHP оголошує відповідь як text/html.

Додамо дві справи:

curl -s -d "title=Купити каву" http://localhost:8080/api/tasks.php
curl -si -d "title=Полити квіти" http://localhost:8080/api/tasks.php

Друга команда показує й заголовки:

HTTP/1.1 200 OK
…
Content-Type: application/json; charset=utf-8
…

[{"title":"Купити каву","done":false},{"title":"Полити квіти","done":false}]

Firefox для application/json вмикає перегляд деревом, яке можна згортати, а програма-клієнт розбирає відповідь своїм аналогом json_decode().

Мобільний застосунок відкидає відповідь api/tasks.php: «очікувався JSON». curl -i показує тіло нижче і заголовок Content-Type: text/html; charset=UTF-8. Де помилка?
[{"title":"Купити каву","done":false}]

Підсумок

  • JSON — текстовий формат: об'єкти {}, масиви [], рядки й ключі в подвійних лапках, числа, true / false, null.
  • json_encode() перетворює масив на JSON: асоціативний — на об'єкт, індексний — на масив.
  • JSON_UNESCAPED_UNICODE залишає кирилицю літерами, JSON_PRETTY_PRINT додає відступи; прапорці поєднують через |.
  • json_decode($json, true) повертає масив; без true вийдуть об'єкти stdClass.
  • Зламаний JSON json_decode() тихо перетворює на null: причину каже json_last_error_msg(), а JSON_THROW_ON_ERROR зупиняє скрипт.
  • Масив записів у файлі JSON перезаписують цілим, з LOCK_EX; API віддає JSON із заголовком Content-Type: application/json.

Що далі

Практика «Гостьова книга, крок 8: записи у файлі JSON», а потім модуль 14 «Бази даних і SQL» — записи переїдуть із файлу в таблицю бази даних.