【PHP8.x】json_last_error関数の使い方

<?php

// JSON エンコード/デコード処理で発生した最後のエラーコードを取得するサンプル
$json_string = '{ "name": "John", "age": 30, "city": "New York" }';

// JSON 文字列をデコード
$data = json_decode($json_string);

// エラーが発生した場合
if (json_last_error() !== JSON_ERROR_NONE) {
    // エラーコードを取得
    $error_code = json_last_error();

    // エラーメッセージを取得 (PHP 5.5 以降)
    $error_message = json_last_error_msg();

    echo "JSON デコードエラーが発生しました。\n";
    echo "エラーコード: " . $error_code . "\n";
    echo "エラーメッセージ: " . $error_message . "\n";
} else {
    echo "JSON デコード成功!\n";
    print_r($data);
}

// 無効なJSON文字列をデコードしてみる
$invalid_json_string = "{ 'name': 'John' }"; // シングルクォートはJSONとして無効

$invalid_data = json_decode($invalid_json_string);

if (json_last_error() !== JSON_ERROR_NONE) {
    $error_code = json_last_error();
    $error_message = json_last_error_msg();

    echo "\n無効なJSON文字列のデコードエラーが発生しました。\n";
    echo "エラーコード: " . $error_code . "\n";
    echo "エラーメッセージ: " . $error_message . "\n";
}

?>

PHP 8.4 の json_last_error() 関数は、直近の JSON エンコードまたはデコード処理で発生したエラーコードを整数値で返します。引数は不要で、エラーが発生しなかった場合は JSON_ERROR_NONE を返します。

このサンプルコードでは、まず有効な JSON 文字列を json_decode() 関数でデコードしています。json_last_error() 関数を使って、デコード処理でエラーが発生したかどうかを確認します。もしエラーが発生した場合は、エラーコードとエラーメッセージ（PHP 5.5 以降で使用可能な json_last_error_msg() 関数を使用）を表示します。エラーが発生しなかった場合は、デコードされたデータを print_r() 関数で表示します。

次に、無効な JSON 文字列（シングルクォートを使用）をデコードする例を示しています。意図的にエラーを発生させ、json_last_error() 関数がエラーコードを正しく返すことを確認します。この例では、JSON の構文規則に違反しているため、エラーが発生し、対応するエラーコードとメッセージが表示されます。

json_last_error() 関数を使用することで、JSON データの処理におけるエラーを検出し、適切なエラーハンドリングを行うことができます。システムエンジニアを目指す上で、データの整合性を保つために重要な関数です。

<?php

declare(strict_types=1);

/**
 * JSON文字列をデコードし、エラーが発生した場合にエラーコードとメッセージを表示します。
 *
 * @param string $jsonString デコード対象のJSON文字列
 */
function checkJsonError(string $jsonString): void
{
    echo "--- デコード試行: \"{$jsonString}\" ---" . PHP_EOL;

    // JSON文字列をPHPのオブジェクトにデコード
    $decodedData = json_decode($jsonString);

    // json_last_error() は、最後に発生したJSONエラーのコード(int)を返します。
    // エラーがなければ JSON_ERROR_NONE (値は 0) を返します。
    $errorCode = json_last_error();

    if ($errorCode !== JSON_ERROR_NONE) {
        // json_last_error_msg() は、最後のエラーに対応する人間が読める
        // 文字列メッセージ(string)を返します。
        $errorMessage = json_last_error_msg();

        echo "デコード失敗" . PHP_EOL;
        echo "エラーコード: {$errorCode}" . PHP_EOL;
        echo "エラーメッセージ: {$errorMessage}" . PHP_EOL;
    } else {
        echo "デコード成功" . PHP_EOL;
        print_r($decodedData);
    }
    echo PHP_EOL;
}

// わざと構文エラー（末尾にカンマ）を発生させる不正なJSON文字列
$invalidJson = '{"name": "Taro", "age": 30,}';
checkJsonError($invalidJson);

// 正しいJSON文字列
$validJson = '{"name": "Hanako", "age": 25}';
checkJsonError($validJson);

PHPのjson_last_error関数は、直前に行われたJSON関連の処理でエラーが発生したかどうかを確認するために使用されます。この関数は引数を一つも取りません。戻り値は整数（int）で、エラーの種類を示すコードを返します。もしエラーが発生していなければ、JSON_ERROR_NONEという定数（値は0）が戻り値として返されます。

サンプルコードでは、json_decode関数でJSON文字列をデコードした後に、json_last_error関数を使ってエラーコードを取得しています。取得したエラーコードがJSON_ERROR_NONEでない場合、エラーが発生したと判断し、さらにjson_last_error_msg関数を用いて人間が読めるエラーメッセージを取得・表示しています。これにより、不正なJSON形式の文字列が入力された際に、何が問題だったのかを具体的に把握し、適切なエラーハンドリングを行うことができます。正しいJSON文字列であれば、デコードは成功し、結果が表示されます。このように、JSONデータを扱う際には、エラーチェックを組み込むことが重要です。