【PHP8.x】getMessageメソッドの使い方

Copy
1<?php
2
3class MyDatabase {
4    private SQLite3 $db;
5
6    public function __construct(string $dbPath) {
7        try {
8            $this->db = new SQLite3($dbPath);
9        } catch (SQLite3Exception $e) {
10            // 例外発生時にgetMessage()をオーバーライドして、より詳細な情報を付加する
11            throw new MyCustomSQLite3Exception($e->getMessage(), $e->getCode());
12        }
13    }
14
15    public function execute(string $sql): SQLite3Result|bool {
16        return $this->db->query($sql);
17    }
18}
19
20class MyCustomSQLite3Exception extends SQLite3Exception {
21    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null) {
22        // 親クラスのコンストラクタを呼び出す
23        parent::__construct($message, $code, $previous);
24    }
25
26    public function getMessage(): string {
27        // エラーメッセージをオーバーライド
28        return "Custom Error: " . parent::getMessage() . " (Code: " . $this->getCode() . ")";
29    }
30}
31
32// Example Usage
33try {
34    $db = new MyDatabase(':memory:'); // メモリ上にデータベースを作成
35    $db->execute("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)");
36    $db->execute("INSERT INTO users (name) VALUES ('John Doe')");
37
38    // 存在しないテーブルに対してクエリを実行し、例外を発生させる
39    $db->execute("SELECT * FROM non_existent_table");
40
41} catch (MyCustomSQLite3Exception $e) {
42    echo "Caught exception: " . $e->getMessage() . "\n"; // カスタム例外メッセージを表示
43} catch (Exception $e) {
44    echo "Generic exception: " . $e->getMessage() . "\n";
45}

このサンプルコードは、PHPのSQLite3ExceptionクラスのgetMessage()メソッドをオーバーライドする方法を示しています。getMessage()メソッドは、例外が発生した際のエラーメッセージを文字列で返すメソッドです。

まず、MyCustomSQLite3Exceptionクラスを定義し、SQLite3Exceptionクラスを継承しています。このクラス内で、getMessage()メソッドをオーバーライドしています。

オーバーライドされたgetMessage()メソッドでは、親クラス（SQLite3Exception）のgetMessage()メソッドの結果に、カスタムのエラーメッセージ（"Custom Error: "）とエラーコードを付加して返しています。これにより、例外発生時に、より詳細な情報を取得できます。

MyDatabaseクラスは、SQLite3データベースへの接続とクエリ実行を管理するクラスです。コンストラクタ内でSQLite3データベースへの接続を試み、接続に失敗した場合は、SQLite3Exceptionをキャッチし、MyCustomSQLite3Exceptionをスローしています。

サンプルコードでは、存在しないテーブルに対してクエリを実行することで、意図的に例外を発生させています。そして、try-catchブロックで例外をキャッチし、MyCustomSQLite3ExceptionのgetMessage()メソッドで取得したカスタムエラーメッセージを表示しています。

この例から、例外処理においてgetMessage()メソッドをオーバーライドすることで、アプリケーション固有のより詳細なエラー情報を提供できることがわかります。特にデータベース処理においては、エラーの原因を特定しやすくするために有効なテクニックです。

Copy
1<?php
2
3// SQLite3Exception をキャッチし、getMessage() でエラーメッセージを取得するサンプル
4
5try {
6    $db = new SQLite3(':memory:'); // インメモリデータベースを作成
7
8    // 存在しないテーブルにクエリを実行し、例外を発生させる
9    $result = $db->query('SELECT * FROM non_existent_table');
10
11} catch (SQLite3Exception $exception) {
12    // エラーメッセージが truncated される場合があるため、getFullMessage() が利用可能な場合はそちらを推奨
13    $errorMessage = $exception->getMessage();
14
15    // エラーメッセージを表示
16    echo "エラーが発生しました: " . $errorMessage . PHP_EOL;
17} finally {
18    if (isset($db)) {
19        $db->close(); // データベース接続を閉じる
20    }
21}

このサンプルコードは、PHPのSQLite3拡張機能で発生するSQLite3Exceptionを捕捉し、エラーメッセージを取得する方法を示しています。SQLite3ExceptionクラスのgetMessage()メソッドは、例外が発生した際のエラーメッセージを文字列として返します。

この例では、まずtry-catchブロックを使用し、SQLite3データベースへの接続と存在しないテーブルへのクエリ実行を試みます。存在しないテーブルへのクエリはSQLite3Exceptionを発生させるため、catchブロックに処理が移ります。

catchブロック内では、getMessage()メソッドを呼び出し、エラーメッセージを変数 $errorMessage に格納します。そして、取得したエラーメッセージをechoで表示します。 getMessage()メソッドで取得できるエラーメッセージは、場合によってはtruncated (切り詰められる) 可能性がある点に注意が必要です。 もしより詳細なエラーメッセージが必要な場合は、SQLite3拡張機能で提供されている別のメソッドの利用を検討してください。

finallyブロックでは、データベース接続が確立されている場合に、close()メソッドを呼び出してデータベース接続を閉じます。これは、リソースリークを防ぐための重要な処理です。このように、getMessage()メソッドは、発生した例外に関する基本的なエラー情報を取得するために利用できます。