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

Copy
1<?php
2
3/**
4 * PHPのjson_encode関数を使ったデータ変換とエラーハンドリングの例を示します。
5 * JSON_PARTIAL_OUTPUT_ON_ERROR オプションと json_error_none 定数を使用します。
6 *
7 * @param array $data JSONエンコードする元のデータ配列
8 */
9function encodeDataToJsonAndCheckError(array $data): void
10{
11    echo "--- JSONエンコード処理 ---" . PHP_EOL;
12    echo "入力データ:" . PHP_EOL;
13    print_r($data);
14
15    // JSON_PARTIAL_OUTPUT_ON_ERROR オプションを付けてデータをJSON文字列にエンコードします。
16    // このオプションを使用すると、エンコード中にJSONとして無効な値（例: 無限大INF、非数NAN）
17    // が含まれていても、エラー部分をnullに置き換えて、可能な限り部分的なJSONを出力しようとします。
18    $jsonString = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
19
20    echo "エンコード結果: " . ($jsonString !== false ? $jsonString : 'エンコード失敗') . PHP_EOL;
21
22    // json_last_error() 関数で、直前のJSON操作で発生したエラーコードを取得します。
23    $lastError = json_last_error();
24
25    // json_error_none 定数と比較して、エラーが発生していないか確認します。
26    // JSON_ERROR_NONE は、エラーが全く発生しなかったことを示す値です。
27    if ($lastError === JSON_ERROR_NONE) {
28        echo "結果: JSONエンコードは正常に完了しました。" . PHP_EOL;
29    } else {
30        // エラーが発生した場合、json_last_error_msg() 関数で具体的なエラーメッセージを取得します。
31        echo "結果: JSONエンコード中にエラーが発生しました。" . PHP_EOL;
32        echo "エラーコード: " . $lastError . PHP_EOL;
33        echo "エラーメッセージ: " . json_last_error_msg() . PHP_EOL;
34    }
35    echo "-------------------------" . PHP_EOL . PHP_EOL;
36}
37
38// --- 使用例 ---
39
40// 1. 正常にJSONエンコードできるデータ
41$successfulData = [
42    'name' => '田中 太郎',
43    'age' => 30,
44    'city' => '東京'
45];
46encodeDataToJsonAndCheckError($successfulData);
47
48// 2. JSONで表現できない値（例: 無限大 `INF`）を含むデータ
49// JSON_PARTIAL_OUTPUT_ON_ERROR のおかげで、`INF` は `null` に変換され、部分的なJSONが出力されます。
50// しかし、エラーは発生したとみなされ、エラーメッセージが表示されます。
51$dataWithInvalidValue = [
52    'product' => 'PC',
53    'price' => 150000,
54    'rating' => INF // JSONでは表現できない無限大 (Infinity)
55];
56encodeDataToJsonAndCheckError($dataWithInvalidValue);
57
58// 3. JSONで表現できない値（例: 非数 `NAN`）を含むデータ
59// 同様に `NAN` は `null` に変換され、エラーメッセージが出力されます。
60$dataWithNanValue = [
61    'temperature' => 25.5,
62    'humidity' => NAN, // JSONでは表現できない非数 (Not a Number)
63    'unit' => 'celsius'
64];
65encodeDataToJsonAndCheckError($dataWithNanValue);
66
67?>

このサンプルコードは、PHPで配列データをJSON形式に変換し、その過程で発生する可能性のあるエラーを適切に処理する方法を示しています。encodeDataToJsonAndCheckError関数は、引数として受け取った配列$dataをJSON文字列にエンコードし、エラーの有無を確認して結果を表示します。この関数はvoidを戻り値とし、特定の値を返しません。

データのエンコードにはjson_encode関数が使われ、その際にJSON_PARTIAL_OUTPUT_ON_ERRORという定数（int型）がオプションとして指定されています。この定数を使用すると、もしエンコード対象のデータに無限大（INF）や非数（NAN）のようなJSONでは表現できない値が含まれていても、それらをnullに置き換えて、可能な限り部分的なJSON文字列を出力しようとします。これにより、完全にエラーで出力が途絶えることを避けることができます。

エンコード処理後、json_last_error()関数を使って直前のJSON操作で発生したエラーコードを取得します。取得したエラーコードがJSON_ERROR_NONEという定数（int型）と一致する場合、JSONエンコードは正常に完了したと判断できます。JSON_ERROR_NONEは、エラーが全く発生しなかったことを示す値です。もしエラーが発生していた場合は、json_last_error_msg()関数で具体的なエラーメッセージを取得し、表示しています。これにより、何が問題だったのかを把握しやすくなります。

Copy
1<?php
2
3/**
4 * JSON_PARTIAL_OUTPUT_ON_ERROR 定数の使用例と、
5 * json_last_error() 関数によるエラー処理を示します。
6 *
7 * この関数は、JSONエンコード時にエラーが発生するデータを用意し、
8 * JSON_PARTIAL_OUTPUT_ON_ERROR オプションの有無で挙動がどう変わるか、
9 * そしてその際に json_last_error() と json_last_error_msg() で
10 * どのようにエラーを検出・確認できるかを初心者向けにデモンストレーションします。
11 */
12function demonstrateJsonPartialOutputOnError(): void
13{
14    // JSONで直接表現できない値 (NaN, Not a Number) を含むデータ
15    // これにより、json_encode はデフォルトでエラーを発生させます。
16    $dataWithError = [
17        'id' => 101,
18        'name' => 'Sample Product',
19        'price' => NAN, // JSON_ERROR_INF_OR_NAN の原因となる
20        'details' => 'This is a test item.',
21    ];
22
23    echo "--- 1. JSON_PARTIAL_OUTPUT_ON_ERROR オプションなしの場合 ---\n";
24
25    // オプションなしでデータをJSONエンコード
26    $jsonWithoutOption = json_encode($dataWithError);
27
28    // json_encodeが失敗した場合、falseを返します
29    if ($jsonWithoutOption === false) {
30        echo "エンコードに失敗しました。\n";
31        // 最後に発生したJSONエラーコードを取得
32        echo "JSON エラーコード: " . json_last_error() . "\n";
33        // 最後に発生したJSONエラーメッセージを取得
34        echo "JSON エラーメッセージ: " . json_last_error_msg() . "\n";
35    } else {
36        echo "エンコード結果: " . $jsonWithoutOption . "\n";
37        // エラーがない場合の確認 (通常は JSON_ERROR_NONE)
38        echo "JSON エラーコード: " . json_last_error() . "\n";
39        echo "JSON エラーメッセージ: " . json_last_error_msg() . "\n";
40    }
41    echo "\n";
42
43    echo "--- 2. JSON_PARTIAL_OUTPUT_ON_ERROR オプションありの場合 ---\n";
44
45    // JSON_PARTIAL_OUTPUT_ON_ERROR オプションを付けてJSONエンコード
46    // このオプションは、エラーが発生しても可能な限り部分的な出力を生成しようとします。
47    $jsonWithOption = json_encode($dataWithError, JSON_PARTIAL_OUTPUT_ON_ERROR);
48
49    // オプションありの場合、エラーがあっても通常は false ではなく部分的なJSON文字列が返されます。
50    // しかし、json_last_error() はエラーコードを保持します。
51    if ($jsonWithOption === false) {
52        // このパスは通常、JSON_PARTIAL_OUTPUT_ON_ERROR 使用時には実行されません。
53        echo "エンコードに致命的な失敗が発生しました。\n";
54    } else {
55        echo "部分的なエンコード結果: " . $jsonWithOption . "\n";
56        // エラーコードとメッセージを確認
57        echo "JSON エラーコード: " . json_last_error() . "\n";
58        echo "JSON エラーメッセージ: " . json_last_error_msg() . "\n";
59
60        // エラーコードが JSON_ERROR_NONE でない場合、何らかの問題があったことを示します。
61        if (json_last_error() !== JSON_ERROR_NONE) {
62            echo "注意: 部分的な出力が生成されましたが、エンコード中にエラーがありました。\n";
63        }
64    }
65}
66
67// 関数を実行してデモンストレーションを開始します。
68demonstrateJsonPartialOutputOnError();

このサンプルコードは、PHPでJSONエンコード時のエラー処理と、JSON_PARTIAL_OUTPUT_ON_ERROR定数の利用方法を解説しています。まず、json_encode()関数でデータをJSON形式に変換する際に、NAN（非数）のようなJSONでは直接表現できない値が含まれているとエラーが発生するケースを例示しています。

JSON_PARTIAL_OUTPUT_ON_ERRORオプションを指定しない場合、json_encode()はエンコード中にエラーを検出するとfalseを返して処理を中断します。このとき、json_last_error()関数は最後に発生したJSONエラーの数値コード（戻り値はint型）を、json_last_error_msg()関数はそのエラー内容を文字列で取得でき、変換失敗の原因特定に役立ちます。

次に、json_encode()の第2引数にJSON_PARTIAL_OUTPUT_ON_ERROR定数（int型）を指定した場合の挙動を見ています。この定数を使用すると、エンコード中にエラーが発生してもjson_encode()は可能な限りJSONの部分的な出力文字列を生成しようとします。完全に正しいJSONではない可能性はありますが、何らかのデータが得られることがあります。この場合でも、json_last_error()関数とjson_last_error_msg()関数を使えば、エンコード中にエラーがあったことを確認できます。これにより、致命的なエラーでない限り処理を継続し、部分的なデータを利用する柔軟なエラーハンドリングが可能になります。