【PHP8.x】JSON_ERROR_SYNTAX定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたJSON文字列をデコードし、特にJSON_ERROR_SYNTAXの検出と処理を示します。
5 *
6 * この関数は、`json_decode()`でJSON文字列をデコードする際に発生する可能性のある
7 * エラー、特に構文エラー(`JSON_ERROR_SYNTAX`)をどのように検出・処理するかを
8 * システムエンジニアを目指す初心者向けに示します。
9 *
10 * @param string $jsonString デコードを試みるJSON文字列。
11 * @return void
12 */
13function demonstrateJsonSyntaxErrorHandling(string $jsonString): void
14{
15    echo "--- デコード対象JSON: " . $jsonString . " ---\n";
16
17    // JSON文字列をデコードします。
18    // デコードに失敗した場合、通常はnullを返します。
19    $decodedData = json_decode($jsonString);
20
21    // デコード結果がnullの場合、エラーが発生したか、またはJSONが文字列の"null"であった
22    if ($decodedData === null) {
23        // 最後に発生したJSONエラーコードを取得します。
24        $lastErrorCode = json_last_error();
25
26        // エラーコードがJSON_ERROR_SYNTAXであるかを確認します。
27        if ($lastErrorCode === JSON_ERROR_SYNTAX) {
28            echo "エラー検出: JSON_ERROR_SYNTAX (構文エラー)\n";
29            echo "エラーコード: " . $lastErrorCode . "\n";
30            echo "エラーメッセージ: " . json_last_error_msg() . "\n";
31        } elseif ($lastErrorCode !== JSON_ERROR_NONE) {
32            // JSON_ERROR_NONE以外の、その他のJSONエラーの場合
33            echo "エラー検出: その他のJSONエラー\n";
34            echo "エラーコード: " . $lastErrorCode . "\n";
35            echo "エラーメッセージ: " . json_last_error_msg() . "\n";
36        } else {
37            // json_decode()がnullを返し、json_last_error()がJSON_ERROR_NONEの場合。
38            // これはJSON文字列がリテラルの "null" であったことを意味し、エラーではありません。
39            echo "デコード成功: JSON文字列が 'null' でした。\n";
40            echo "デコード結果: ";
41            var_dump($decodedData);
42        }
43    } else {
44        // デコードが成功した場合
45        echo "デコード成功:\n";
46        echo "デコード結果: ";
47        var_dump($decodedData);
48    }
49    echo "\n";
50}
51
52// --- サンプルコードの実行 ---
53
54// 1. 構文エラーを含むJSON文字列の例 (オブジェクトの末尾に不要なカンマ)
55$invalidJson1 = '{"name": "Alice", "age": 30,}';
56demonstrateJsonSyntaxErrorHandling($invalidJson1);
57
58// 2. 別の構文エラーの例 (JSONのキーが引用符で囲まれていない)
59$invalidJson2 = '{name: "Bob"}';
60demonstrateJsonSyntaxErrorHandling($invalidJson2);
61
62// 3. 正しいJSON文字列の例
63$validJson = '{"name": "Charlie", "age": 25}';
64demonstrateJsonSyntaxErrorHandling($validJson);
65
66// 4. 有効な "null" JSON文字列の例 (エラーではないが、デコード結果はnull)
67$nullLiteralJson = 'null';
68demonstrateJsonSyntaxErrorHandling($nullLiteralJson);
69
70?>

このPHPサンプルコードは、JSON文字列をデコードする際に発生する構文エラー（JSON_ERROR_SYNTAX）の検出と処理方法を、システムエンジニアを目指す初心者向けに示しています。demonstrateJsonSyntaxErrorHandling関数は、引数として受け取ったJSON文字列をjson_decode()でPHPのデータ型に変換することを試みます。json_decode()がデコードに失敗すると、通常はnullを返します。

デコード結果がnullであった場合、続けてjson_last_error()関数を呼び出すことで、発生したエラーの種類を示す整数値を取得します。JSON_ERROR_SYNTAXは引数を持たず、構文エラーが発生したことを示す整数値を持つ定数です。このエラーコードがJSON_ERROR_SYNTAX定数と一致する場合、与えられたJSON文字列に構文上の誤りがあったことを意味します。さらに、json_last_error_msg()関数を使用することで、より具体的なエラーメッセージを取得し、エラーの原因特定に役立てることができます。

この処理は、無効なJSONデータが入力された際にプログラムが予期せぬ動作をしないよう、堅牢なエラーハンドリングを実装するための基本的なアプローチです。demonstrateJsonSyntaxErrorHandling関数は処理結果を画面に出力するのみで、戻り値は持ちません（void）。また、json_decode()がnullを返しても、json_last_error()がJSON_ERROR_NONE（エラーなし）である場合は、JSON文字列自体が "null" リテラルであったことを示しており、これはエラーではない点も重要です。このコードは、様々なJSON文字列でのエラー処理の挙動を具体的に示しています。

Copy
1<?php
2
3/**
4 * JSON文字列をデコードし、特にJSON_ERROR_SYNTAXエラーが発生した場合を検出して報告します。
5 * システムエンジニアを目指す初心者の方にも、JSONの構文エラーの検出方法を理解してもらうためのサンプルです。
6 *
7 * @param string $jsonString デコードを試みるJSON形式の文字列。
8 * @return void
9 */
10function decodeAndCheckJsonSyntaxError(string $jsonString): void
11{
12    echo "--- JSON文字列のデコード試行 ---" . PHP_EOL;
13    echo "入力JSON: " . $jsonString . PHP_EOL;
14
15    // json_decode() を使用してJSON文字列をPHPの変数に変換します。
16    // 無効なJSONが入力された場合、null を返します。
17    $decodedData = json_decode($jsonString);
18
19    // json_last_error() で直近のJSON操作で発生したエラーコードを取得します。
20    $errorCode = json_last_error();
21
22    if ($errorCode === JSON_ERROR_NONE) {
23        // エラーコードが JSON_ERROR_NONE の場合、デコードは成功しています。
24        echo "デコード成功！" . PHP_EOL;
25        echo "デコード結果: ";
26        var_dump($decodedData);
27    } else {
28        // エラーが発生した場合、その種類をチェックします。
29        echo "デコード失敗！JSONエラーが発生しました。" . PHP_EOL;
30        echo "エラーコード: " . $errorCode . PHP_EOL;
31        // json_last_error_msg() で、エラーコードに対応する人間が読める形式のメッセージを取得します。
32        echo "エラーメッセージ: " . json_last_error_msg() . PHP_EOL;
33
34        // JSON_ERROR_SYNTAX は、入力されたJSON文字列の形式が正しくない（構文エラー）ことを示します。
35        if ($errorCode === JSON_ERROR_SYNTAX) {
36            echo "これはJSONの構文エラーです。括弧の不足、余分なカンマ、不正なクォーテーションなどが原因で発生します。" . PHP_EOL;
37        } else {
38            echo "その他の種類のJSONエラーです。" . PHP_EOL;
39        }
40    }
41    echo PHP_EOL;
42}
43
44// --- サンプルコードの実行例 ---
45
46// 1. 正常なJSON文字列の例
47decodeAndCheckJsonSyntaxError('{"name": "Alice", "age": 30, "city": "New York"}');
48
49// 2. 構文エラーの例：オブジェクトの閉じ括弧が不足している
50decodeAndCheckJsonSyntaxError('{"item": "Laptop", "price": 1200');
51
52// 3. 構文エラーの例：キーがダブルクォーテーションで囲まれていない
53decodeAndCheckJsonSyntaxError('{status: "active", "value": 100}');
54
55// 4. 構文エラーの例：最後に余分なカンマがある
56decodeAndCheckJsonSyntaxError('{"color": "blue", "size": "M",}');
57
58// 5. 構文エラーの例：不正なエスケープシーケンス
59decodeAndCheckJsonSyntaxError('{"message": "Hello\xWorld"}');
60
61?>

このPHPサンプルコードは、JSON文字列をデコードする際に発生するエラー、特に構文エラー（JSON_ERROR_SYNTAX）を検出する方法を学ぶためのものです。decodeAndCheckJsonSyntaxError関数は、引数として与えられた$jsonStringというJSON形式の文字列をデコードし、その結果を画面に出力します。戻り値はvoidで、特定の値を返しません。

関数内部では、まずjson_decode()を使ってJSON文字列をPHPの変数に変換しようと試みます。その後、json_last_error()関数で直前のJSON操作で発生したエラーコードを取得します。取得したエラーコードがJSON_ERROR_NONEであればデコードは成功したと判断し、それ以外の場合はエラーとして処理します。

JSON_ERROR_SYNTAXは、入力されたJSON文字列がPHPのJSONパーサーにとって正しくない形式、つまり構文エラーであることを示す定数です。例えば、閉じ括弧の不足、キーがダブルクォーテーションで囲まれていない、余分なカンマがあるといった場合にこのエラーが発生します。エラーが発生した際にはjson_last_error_msg()関数でエラーの詳しい内容をメッセージとして確認することができます。このコードは、システム開発においてJSONデータを取り扱う際のエラーハンドリングの基礎を理解するのに役立ちます。