json_decode() w PHP: JSON do tablic lub obiektów

json_decode($json, true) zamienia string JSON w wartości PHP, a każdy obiekt JSON w tablicę asocjacyjną. Pomiń true, a obiekty JSON staną się zamiast tego obiektami stdClass, odczytywanymi przez ->. Niepoprawny JSON daje null.

<?php
$json = '{"name": "Ada", "age": 36, "langs": ["php", "js"], "admin": true}';

$data = json_decode($json, true);   // associative array
echo $data['name'], "\n";
echo $data['langs'][1], "\n";

$obj = json_decode($json);          // stdClass object
echo $obj->name, "\n";
echo $obj->langs[0], "\n";

print_r($data);

Wynik:

Ada
js
Ada
php
Array
(
    [name] => Ada
    [age] => 36
    [langs] => Array
        (
            [0] => php
            [1] => js
        )

    [admin] => 1
)

Tablice JSON zawsze stają się listami PHP, niezależnie od wybranego trybu. W drugą stronę, z PHP do JSON, działa json_encode().

Tablica asocjacyjna czy obiekt: true vs false

Oba tryby zawierają te same dane; wybierz ten, który lepiej czyta się w twoim kodzie. Tablice działają z każdą funkcją tablicową (array_column, array_map, isset($data['key'])), więc większość kodu przekazuje true. Obiekty wymagają składni z nawiasami klamrowymi dla kluczy, które nie są poprawnymi nazwami właściwości, takich jak klucze z myślnikiem albo liczbą:

<?php
$json = '{"first-name": "Ada", "0": "zero", "address": {"city": "London"}}';

$arr = json_decode($json, true);
echo $arr['first-name'], ' ', $arr[0], ' ', $arr['address']['city'], "\n";

$obj = json_decode($json);
echo $obj->{'first-name'}, ' ', $obj->{'0'}, ' ', $obj->address->city, "\n";

var_dump($obj->address);

Wynik:

Ada zero London
Ada zero London
object(stdClass)#2 (1) {
  ["city"]=>
  string(6) "London"
}

Czwarty parametr przyjmuje flagi. JSON_OBJECT_AS_ARRAY też daje tablice, ale tylko wtedy, gdy drugi argument to null (jego wartość domyślna): json_decode($json, flags: JSON_OBJECT_AS_ARRAY) zwraca tablice, a json_decode($json, false, 512, JSON_OBJECT_AS_ARRAY) nadal zwraca obiekty.

Pętla po zagnieżdżonym JSON

Odpowiedzi API to zwykle lista obiektów wewnątrz obiektu. Zdekoduj raz, potem przejdź przez nią przez foreach, a dla pól, których może brakować, użyj ??:

<?php
$json = <<<'JSON'
{
    "page": 1,
    "users": [
        {"id": 1, "name": "Ada", "email": "ada@example.com", "roles": ["admin", "editor"]},
        {"id": 2, "name": "Linus", "roles": []},
        {"id": 3, "name": "Grace", "email": "grace@example.com", "roles": ["editor"]}
    ]
}
JSON;

$data = json_decode($json, true);

foreach ($data['users'] as $user) {
    $email = $user['email'] ?? 'no email';
    $roles = $user['roles'] ? implode(', ', $user['roles']) : 'none';
    echo "#{$user['id']} {$user['name']} <$email> roles: $roles\n";
}

$names = array_column($data['users'], 'name', 'id');
print_r($names);

Wynik:

#1 Ada <ada@example.com> roles: admin, editor
#2 Linus <no email> roles: none
#3 Grace <grace@example.com> roles: editor
Array
(
    [1] => Ada
    [2] => Linus
    [3] => Grace
)

Obsługa niepoprawnego JSON

json_decode() zwraca null dla niepoprawnego JSON, ale null to też poprawny wynik dla tekstu JSON null, więc samo null nie mówi, czy coś się nie udało. json_last_error_msg() podaje przyczynę ostatniego wywołania. Czystszy sposób to JSON_THROW_ON_ERROR, który rzuca JsonException:

<?php
var_dump(json_decode('{"a": 1,}'));   // trailing comma
echo json_last_error_msg(), "\n";

var_dump(json_decode('null'));        // valid JSON, also null
echo json_last_error_msg(), "\n";

try {
    $data = json_decode("{'a': 1}", true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
    echo 'Invalid JSON: ', $e->getMessage(), "\n";
}

Wynik:

NULL
Syntax error
NULL
No error
Invalid JSON: Syntax error

Trzeci argument, 512, to maksymalna głębokość zagnieżdżenia (domyślna). Z argumentami nazwanymi możesz go pominąć: json_decode($json, true, flags: JSON_THROW_ON_ERROR).

Sprawdzanie poprawności JSON przez json_validate()

PHP 8.3 dodało json_validate(). Odpowiada true albo false bez budowania zdekodowanych tablic, więc zużywa mniej pamięci niż dekodowanie, gdy potrzebujesz tylko odpowiedzi tak lub nie, na przykład aby wcześnie odrzucić treść żądania:

<?php
$inputs = ['{"a": 1}', '[1, 2, 3]', '"text"', '{a: 1}', "{'a': 1}", ''];

foreach ($inputs as $input) {
    $ok = json_validate($input) ? 'valid' : 'invalid: ' . json_last_error_msg();
    echo str_pad(var_export($input, true), 14), $ok, "\n";
}

Wynik:

'{"a": 1}'    valid
'[1, 2, 3]'   valid
'"text"'      valid
'{a: 1}'      invalid: Syntax error
'{\'a\': 1}'  invalid: Syntax error
''            invalid: Syntax error

Jeśli i tak użyjesz danych, pomiń json_validate() i dekoduj z JSON_THROW_ON_ERROR: walidacja przed dekodowaniem parsuje string dwa razy.

Odczyt pliku JSON

Odczytaj plik przez file_get_contents() i zdekoduj string. Ten blok najpierw zapisuje settings.json, żeby było co czytać:

<?php
file_put_contents('settings.json', '{"theme": "dark", "fontSize": 14, "plugins": ["git", "lint"]}');

$text = file_get_contents('settings.json');
if ($text === false) {
    exit("Cannot read settings.json\n");
}

$settings = json_decode($text, true, flags: JSON_THROW_ON_ERROR);
echo "Theme: {$settings['theme']}\n";
echo "Plugins: ", count($settings['plugins']), "\n";

// Change a value and write the file back
$settings['fontSize'] = 16;
file_put_contents('settings.json', json_encode($settings, JSON_PRETTY_PRINT));
echo file_get_contents('settings.json'), "\n";

Wynik:

Theme: dark
Plugins: 2
{
    "theme": "dark",
    "fontSize": 16,
    "plugins": [
        "git",
        "lint"
    ]
}

Dlaczego json_decode zwraca null: typowe przyczyny

JSON jest bardziej rygorystyczny niż składnia tablic w JavaScripcie i PHP. Każdy string poniżej wygląda rozsądnie i każdy zwraca null. Uruchom to, aby zobaczyć przyczynę każdego, potem popraw jeden i uruchom ponownie:

<?php
$cases = [
    'single quotes'   => "{'name': 'Ada'}",
    'unquoted key'    => '{name: "Ada"}',
    'trailing comma'  => '{"name": "Ada",}',
    'comment'         => '{"name": "Ada" /* admin */}',
    'byte order mark' => "\xEF\xBB\xBF" . '{"name": "Ada"}',
    'too deep'        => '[[["Ada"]]]',
];

foreach ($cases as $label => $json) {
    $depth = $label === 'too deep' ? 2 : 512;
    $result = json_decode($json, true, $depth);
    echo str_pad($label, 17), $result === null ? json_last_error_msg() : 'ok', "\n";
}

// Big integers lose precision unless you ask for strings
var_dump(json_decode('{"id": 12345678901234567890}', true)['id']);
var_dump(json_decode('{"id": 12345678901234567890}', true, 512, JSON_BIGINT_AS_STRING)['id']);

Wynik:

single quotes    Syntax error
unquoted key     Syntax error
trailing comma   Syntax error
comment          Syntax error
byte order mark  Syntax error
too deep         Maximum stack depth exceeded
float(1.2345678901234567E+19)
string(20) "12345678901234567890"

Znacznik BOM (byte order mark) jest niewidoczny w większości edytorów i to klasyczny powód, dla którego plik JSON „wygląda dobrze”, ale nie daje się zdekodować. Usuń go przed dekodowaniem przez $text = preg_replace('/^\xEF\xBB\xBF/', '', $text);.