【PHP8.x】JsonException::getFile()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 不正なJSON文字列をデコードし、JsonExceptionを捕捉するデモです。
7 *
8 * JSONのデコードに失敗すると JsonException がスローされます。
9 * catchブロックでは、例外オブジェクトの getFile() メソッドを使用して、
10 * エラーが発生したファイル名を取得し、表示します。
11 *
12 * @return void
13 */
14function demonstrateJsonExceptionGetFile(): void
15{
16    // JSONとして不正な文字列（キーがシングルクォートで囲まれている）
17    $invalidJsonString = "{'user': 'guest', 'id': 101}";
18
19    echo "以下の不正なJSON文字列をデコードしようとします...\n";
20    echo $invalidJsonString . "\n\n";
21
22    try {
23        // JSON_THROW_ON_ERRORフラグは、デコード失敗時にJsonExceptionをスローさせるために必要です
24        json_decode($invalidJsonString, true, 512, JSON_THROW_ON_ERROR);
25    } catch (JsonException $e) {
26        // JsonExceptionを捕捉します
27        echo "JsonExceptionが捕捉されました。\n";
28        echo "----------------------------------------\n";
29
30        // getFile()メソッドで例外が発生したファイルのフルパスを取得します
31        $errorFile = $e->getFile();
32        echo "エラーが発生したファイル: " . $errorFile . "\n";
33
34        // 参考: その他の有用なメソッド
35        echo "エラーが発生した行番号: " . $e->getLine() . "\n";
36        echo "エラーメッセージ: " . $e->getMessage() . "\n";
37        echo "----------------------------------------\n";
38    }
39}
40
41// 関数を実行します
42demonstrateJsonExceptionGetFile();

このPHPコードは、不正な形式のJSON文字列をデコードしようとした際に発生するJsonExceptionというエラーを捕捉し、そのエラーに関する情報を取得する方法を示しています。

中心となるのはJsonExceptionクラスが持つgetFile()メソッドです。このメソッドは、エラー（例外）が発生したPHPファイルのフルパスを文字列として取得するために使用します。このメソッドに引数は必要ありません。戻り値として、エラーが発生したファイルの名前が文字列として返されます。

サンプルコードでは、tryブロックの中でjson_decode関数にわざと不正なJSON文字列を渡しています。このとき、JSON_THROW_ON_ERRORオプションが指定されているため、デコードに失敗するとJsonExceptionがスロー（発生）されます。

続くcatchブロックでこの例外を捕捉し、受け取った例外オブジェクト（変数$e）に対して$e->getFile()を実行することで、エラー発生元のファイル名を取得し、画面に表示しています。この例では、エラーが発生したファイル名だけでなく、getLine()メソッドでエラー箇所の行番号、getMessage()メソッドでエラーの詳細メッセージも取得しており、プログラムのデバッグ時に役立つ情報が得られることがわかります。

Copy
1<?php
2
3/**
4 * file_get_contentsで読み込んだ不正なJSONファイルをデコードし、
5 * JsonExceptionからエラーが発生したファイル名を取得するサンプルです。
6 */
7function demonstrateJsonExceptionWithFileContents(): void
8{
9    // 1. デモ用に、構文エラーのあるJSONファイルを作成します。
10    $fileName = 'invalid_user_data.json';
11    // 'age'の後の余分なカンマがエラーの原因です。
12    $invalidJsonContent = '{"name": "Taro Yamada", "age": 30,}';
13    file_put_contents($fileName, $invalidJsonContent);
14
15    try {
16        // 2. file_get_contents() を使ってファイルの内容を読み込みます。
17        $jsonString = file_get_contents($fileName);
18
19        if ($jsonString === false) {
20            // ファイルが読み込めなかった場合の処理
21            throw new RuntimeException("ファイルの読み込みに失敗しました: {$fileName}");
22        }
23
24        // 3. 読み込んだ文字列をデコードします。
25        // JSON_THROW_ON_ERROR フラグにより、エラー時に JsonException がスローされます。
26        json_decode($jsonString, flags: JSON_THROW_ON_ERROR);
27
28    } catch (JsonException $e) {
29        // 4. JsonException をキャッチし、エラー情報を出力します。
30        // getFile() メソッドで、例外が発生したファイル（このスクリプト自身）のパスを取得します。
31        // ※注意: エラーの原因となったJSONファイル名ではなく、json_decode()が実行されたPHPファイル名が返されます。
32        echo "JSONデコードエラーが発生しました。" . PHP_EOL;
33        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
34        echo "エラー発生ファイル: " . $e->getFile() . PHP_EOL;
35        echo "エラー発生行番号: " . $e->getLine() . PHP_EOL;
36
37    } finally {
38        // 5. 後処理として、作成した一時ファイルを削除します。
39        if (file_exists($fileName)) {
40            unlink($fileName);
41        }
42    }
43}
44
45// 関数を実行します。
46demonstrateJsonExceptionWithFileContents();

JsonException::getFile()は、json_decode関数などでJSONデータの処理中にエラーが発生した際に、そのエラーがどのPHPファイルで起きたかを示すフルパスを取得するためのメソッドです。このメソッドに引数は必要ありません。戻り値として、例外が発生したPHPスクリプトのファイルパスを文字列で返します。

サンプルコードでは、まずfile_get_contents関数で意図的に構文が間違っているJSONファイルを読み込みます。次に、json_decode関数をJSON_THROW_ON_ERRORオプション付きで実行し、不正なJSONデータをデコードしようと試みます。この時、デコードに失敗するためJsonExceptionという種類の例外が発生します。

catchブロックでこの例外を捕捉し、$e->getFile()を呼び出すことで、エラーを引き起こしたjson_decode関数が記述されているPHPファイル自体のパスを取得し、表示しています。注意点として、このメソッドはエラーの原因となったJSONファイル名ではなく、あくまでPHPの処理が実行されたファイル名を返す、ということを理解しておくことが重要です。getLine()メソッドなどと組み合わせることで、エラー箇所の特定に役立ちます。