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

Copy
1<?php
2
3/**
4 * AssertionError の getMessage メソッドの使用例を示します。
5 *
6 * PHPのアサーション機能は、開発中にコードの前提条件をチェックするために使用されます。
7 * assert() が失敗した際に、AssertionError がスローされるように設定し、
8 * そのエラーを捕捉して getMessage() でエラーメッセージを取得する方法を示します。
9 */
10function demonstrateAssertionErrorGetMessage(): void
11{
12    // アサーションを有効化します。
13    // 本番環境では通常無効化されていますが、ここでは動作確認のために有効化します。
14    assert_options(ASSERT_ACTIVE, true);
15
16    // アサーションが失敗したときに AssertionError をスローするように設定します。
17    // この設定がないと、assert() は警告を出すだけでエラーはスローされません。
18    assert_options(ASSERT_EXCEPTION, true);
19
20    echo "--- 最初の AssertionError の例 ---\n";
21    try {
22        // 意図的に失敗するアサーションを実行します。
23        // assert() の第2引数は、アサーションが失敗した際に
24        // AssertionError のメッセージとして使用されます。
25        $expectedValue = 10;
26        $actualValue = 5;
27        assert($actualValue === $expectedValue, '期待される値と実際の値が一致しませんでした。');
28
29    } catch (AssertionError $e) {
30        // AssertionError を捕捉します。
31        // getMessage() メソッドを使って、エラーの詳細なメッセージを取得します。
32        echo "AssertionError が発生しました。\n";
33        echo "エラーメッセージ: " . $e->getMessage() . "\n";
34    }
35
36    echo "\n--- 2番目の AssertionError の例 ---\n";
37    try {
38        // 別の失敗するアサーションの例。
39        $userAge = 17;
40        assert($userAge >= 18, 'ユーザーは成人ではありません。');
41
42    } catch (AssertionError $e) {
43        // 捕捉した AssertionError からメッセージを取得して表示します。
44        echo "AssertionError が発生しました。\n";
45        echo "エラーメッセージ: " . $e->getMessage() . "\n";
46    }
47
48    // アサーションの設定を元に戻すか、無効化することが推奨されます。
49    // (この例ではデモンストレーションのため、このまま終了します)
50    assert_options(ASSERT_ACTIVE, false);
51    assert_options(ASSERT_EXCEPTION, false);
52}
53
54// 関数を実行して動作を確認します。
55demonstrateAssertionErrorGetMessage();

このサンプルコードは、PHPのアサーション機能で発生するAssertionErrorから、エラーメッセージを取得する方法を示しています。アサーションは、開発中にプログラムの前提条件が正しく機能しているかを確認するために使用されます。

まず、assert_options関数を使い、アサーションが失敗した際にAssertionErrorがスローされるように設定します。通常、アサーションが失敗すると警告が出るだけですが、ASSERT_EXCEPTIONを有効にすることで、エラーとして捕捉できるようになります。

try-catchブロックの中では、意図的に失敗するアサーションを実行しています。assert()関数の第2引数に渡した文字列は、アサーションが失敗した際にAssertionErrorのメッセージとして使用されます。

アサーションが失敗するとAssertionErrorがスローされ、catchブロックでこのエラーを捕捉します。捕捉したAssertionErrorオブジェクト（例では$e）に対して、getMessage()メソッドを呼び出すことで、アサーション失敗時に設定されたエラーの詳細なメッセージを文字列として取得できます。このgetMessage()メソッドは引数を取らず、エラーの内容を説明するstring型の値を返します。取得したメッセージは画面に表示され、何が問題だったかを開発者が容易に確認できる仕組みです。

Copy
1<?php
2
3/**
4 * AssertionError の getMessage メソッドの使用例を示します。
5 *
6 * このコードは、assert() 関数が失敗した際にスローされる AssertionError を捕捉し、
7 * そのエラーメッセージを取得する方法をシステムエンジニアを目指す初心者向けに示します。
8 */
9
10// assert() 関数が失敗したときに AssertionError をスローするように設定します。
11// プロダクション環境では通常、zend.assertions を無効にするか、
12// assert.exception を無効にして Assertion を処理するべきです。
13ini_set('assert.exception', '1');
14
15try {
16    // 意図的に失敗する assert() を実行します。
17    // 第1引数が false となるため、AssertionError がスローされます。
18    // 第2引数はエラーメッセージとして使用されます。
19    assert(false, "この条件は意図的に偽となり、AssertionError を発生させます。");
20
21    // 上記の assert() がエラーをスローするため、この行は実行されません。
22    echo "このメッセージは表示されません。\n";
23
24} catch (AssertionError $e) {
25    // AssertionError がスローされた場合、ここで捕捉します。
26    // getMessage() メソッドを使用して、エラーメッセージを取得します。
27    echo "AssertionError が捕捉されました。\n";
28    echo "エラーメッセージ: " . $e->getMessage() . "\n";
29
30} catch (Throwable $e) {
31    // AssertionError 以外の予期せぬエラー (Throwable インターフェースを実装するもの)
32    // が発生した場合に備えて、汎用的な catch ブロックも用意できます。
33    echo "予期せぬエラーが捕捉されました。\n";
34    echo "エラータイプ: " . get_class($e) . "\n";
35    echo "エラーメッセージ: " . $e->getMessage() . "\n";
36}
37
38// プログラムの正常終了を示すメッセージ
39echo "プログラムの実行が完了しました。\n";
40
41?>

このPHPサンプルコードは、assert()関数が失敗した際に発生するAssertionErrorを捕捉し、そのエラーメッセージを取得する方法を初心者向けに示しています。まず、ini_set('assert.exception', '1')によって、assert()の失敗がAssertionErrorとしてスローされるように設定しています。tryブロック内で、assert(false, "エラーメッセージ")を実行することで意図的にエラーを発生させています。この行のfalseが条件を満たさないため、AssertionErrorがスローされます。

catch (AssertionError $e)ブロックでは、スローされたAssertionErrorオブジェクトを$eとして捕捉しています。ここで$e->getMessage()メソッドを呼び出すと、AssertionErrorが保持しているエラーメッセージを文字列（string）として取得できます。このgetMessageメソッドは、外部から情報を受け取るための引数を必要としません。取得されたメッセージは、assert()関数の第2引数で指定した内容です。このようにエラーメッセージを取得することで、プログラムのどの部分で何が問題だったのかを特定し、適切なエラーハンドリングを行うための基礎を学ぶことができます。