Hàm json_decode() trong PHP: chuyển JSON thành mảng

json_decode($json, true) chuyển một chuỗi JSON thành giá trị PHP, trong đó mọi đối tượng JSON trở thành mảng kết hợp. Bỏ true đi thì đối tượng JSON sẽ thành đối tượng stdClass, được đọc bằng ->. JSON không hợp lệ cho ra 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);

Đầu ra:

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

    [admin] => 1
)

Mảng JSON luôn trở thành list trong PHP, dù bạn chọn chế độ nào. Chiều ngược lại, từ PHP sang JSON, là json_encode().

Mảng kết hợp hay đối tượng: true và false

Cả hai chế độ chứa cùng một dữ liệu; hãy chọn cách đọc dễ hiểu hơn trong code của bạn. Mảng dùng được với mọi hàm mảng (array_column, array_map, isset($data['key'])), nên phần lớn code truyền true. Đối tượng cần cú pháp ngoặc nhọn cho những khóa không phải tên thuộc tính hợp lệ, như khóa có dấu gạch ngang hoặc khóa là số:

<?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);

Đầu ra:

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

Tham số thứ tư nhận các cờ. JSON_OBJECT_AS_ARRAY cũng cho ra mảng, nhưng chỉ khi đối số thứ hai là null (giá trị mặc định của nó): json_decode($json, flags: JSON_OBJECT_AS_ARRAY) trả về mảng, còn json_decode($json, false, 512, JSON_OBJECT_AS_ARRAY) vẫn trả về đối tượng.

Duyệt JSON lồng nhau

Response của API thường là một danh sách đối tượng nằm trong một đối tượng. Decode một lần, rồi duyệt bằng foreach, và dùng ?? cho những trường có thể bị thiếu:

<?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);

Đầu ra:

#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
)

Xử lý JSON không hợp lệ

json_decode() trả về null với JSON không hợp lệ, nhưng null cũng là kết quả đúng cho văn bản JSON null, nên chỉ riêng null không cho biết lệnh có thất bại hay không. json_last_error_msg() cho biết lý do của lần gọi gần nhất. Để tìm chỗ lỗi trong một tài liệu dài, hãy dán nó vào công cụ định dạng JSON, công cụ này chỉ ra dòng có lỗi. Cách gọn gàng hơn là JSON_THROW_ON_ERROR, cờ này ném ra một 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";
}

Đầu ra:

NULL
Syntax error
NULL
No error
Invalid JSON: Syntax error

Đối số thứ ba, 512, là độ sâu lồng nhau tối đa (giá trị mặc định). Với named argument, bạn có thể bỏ qua nó: json_decode($json, true, flags: JSON_THROW_ON_ERROR).

Kiểm tra chuỗi JSON hợp lệ với json_validate()

PHP 8.3 bổ sung json_validate(). Hàm trả lời true hoặc false mà không tạo ra các mảng đã decode, nên tốn ít bộ nhớ hơn decode khi bạn chỉ cần câu trả lời có hoặc không, ví dụ để từ chối sớm một request body:

<?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";
}

Đầu ra:

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

Nếu đằng nào bạn cũng dùng dữ liệu, hãy bỏ qua json_validate() và decode với JSON_THROW_ON_ERROR: kiểm tra trước sẽ khiến chuỗi bị phân tích hai lần.

Đọc file JSON

Đọc file bằng file_get_contents() rồi decode chuỗi. Khối code này ghi settings.json trước để có file mà đọc:

<?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";

Đầu ra:

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

Vì sao json_decode trả về null: các nguyên nhân thường gặp

JSON chặt chẽ hơn cú pháp JavaScript và cú pháp mảng của PHP. Chuỗi nào bên dưới trông cũng có vẻ hợp lý, nhưng tất cả đều trả về null. Chạy để xem lý do của từng chuỗi, rồi sửa một chuỗi và chạy lại:

<?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']);

Đầu ra:

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"

Byte order mark không hiện ra trong phần lớn trình soạn thảo và là lý do kinh điển khiến một file JSON "trông vẫn ổn" nhưng không decode được. Hãy loại bỏ nó bằng $text = preg_replace('/^\xEF\xBB\xBF/', '', $text); trước khi decode.