【PHP8.x】assert関数の使い方

Copy
1<?php
2
3/**
4 * assert() を使用して、2つの値が型まで含めて同一であることを表明する例。
5 *
6 * キーワード `assertSame` のような厳密な比較を、assert() と `===` 演算子で
7 * 実現する方法を示します。
8 *
9 * アサーションを有効にして実行してください。
10 * コマンドライン実行例: php -d zend.assertions=1 your_script_name.php
11 */
12function demonstrateAssertSameBehavior(): void
13{
14    // --- 成功例 ---
15    // 2つの値が型も値も同一 (`===`) なので、アサーションは成功します。
16    try {
17        $expected = 100;
18        $actual = 100;
19
20        assert($expected === $actual, '整数 100 は同一であるべきです。');
21
22        echo "成功: 整数 100 と 100 は同一です。\n";
23    } catch (AssertionError $e) {
24        echo "予期せぬ失敗: " . $e->getMessage() . "\n";
25    }
26
27    // --- 失敗例 ---
28    // 値は等価 (`==`) ですが、型が異なる (int と string) ため、
29    // 同一 (`===`) ではありません。
30    // その結果、アサーションは失敗し、AssertionError がスローされます。
31    try {
32        $expectedNumber = 100;
33        $actualString = '100';
34
35        // このアサーションは失敗し、catchブロックが実行されます。
36        assert(
37            $expectedNumber === $actualString,
38            "整数 100 と 文字列 '100' は同一ではありません。"
39        );
40
41        // アサーションが失敗するため、この行は実行されません。
42        echo "この行は表示されません。\n";
43
44    } catch (AssertionError $e) {
45        echo "失敗: アサーションが意図通り失敗しました。\n";
46        // assert()の第2引数で指定したメッセージが表示されます。
47        echo '  -> ' . $e->getMessage() . "\n";
48    }
49}
50
51// 関数を実行してデモを行います。
52demonstrateAssertSameBehavior();

assert関数は、プログラムの実行中に「この条件は正しいはずだ」という前提（アサーション）が満たされているかを確認するために使われるデバッグ用の機能です。第1引数には真偽値となる条件式（$assertion）を指定し、この条件がtrueであれば処理はそのまま続行されます。しかし、条件がfalseだった場合、AssertionErrorというエラーがスローされます。オプションである第2引数（$description）には、条件がfalseの際にAssertionErrorのメッセージとして表示される文字列を指定できます。この関数は戻り値を持ちません。

このサンプルコードは、assert関数と、値だけでなく型も厳密に比較する===演算子を組み合わせることで、二つの値が型まで含めて完全に同一であるかを確認する方法をデモンストレーションしています。これは、PHPUnitなどのテストフレームワークにあるassertSameのような厳密な比較を再現するものです。assert関数を有効にするには、コマンドラインでphp -d zend.assertions=1のように実行する必要があります。

成功例では、整数100と整数100が===で比較され、型も値も同一であるためアサーションは成功します。失敗例では、整数100と文字列'100'が===で比較されます。値は同じでも型が異なるため===はfalseを返し、その結果AssertionErrorが意図通り発生し、指定したエラーメッセージが表示される動作が確認できます。

Copy
1<?php
2
3// PHPのassert機能を有効化します。
4// 開発環境では有効にしますが、本番環境では通常無効にします。
5ini_set('assert.active', 1);
6
7// assertが失敗した際にAssertionErrorをスローするように設定します。
8// PHP 7以降のデフォルトの挙動ですが、明示的に記述することで意図を明確にします。
9ini_set('assert.exception', 1);
10
11/**
12 * 数値が指定された範囲内にあるかを確認する関数です。
13 * assertは、プログラムが特定の条件を「絶対に満たしているはず」という前提が
14 * 崩れた場合に、それを早期に検知するために使用します。
15 *
16 * @param int $value 確認する数値
17 * @param int $min 許容される最小値
18 * @param int $max 許容される最大値
19 * @param string $paramName 確認対象のパラメータ名 (エラーメッセージ用)
20 * @return string 条件が満たされた場合のメッセージ
21 * @throws AssertionError 条件が満たされない場合、AssertionErrorがスローされます
22 */
23function validateRange(int $value, int $min, int $max, string $paramName): string
24{
25    // $value が $min 以上であるべきであることを表明します。
26    // この条件がfalseの場合、AssertionErrorがスローされます。
27    assert($value >= $min, "{$paramName}は{$min}以上である必要があります。現在の値: {$value}");
28
29    // $value が $max 以下であるべきであることを表明します。
30    // この条件がfalseの場合、AssertionErrorがスローされます。
31    assert($value <= $max, "{$paramName}は{$max}以下である必要があります。現在の値: {$value}");
32
33    return "{$paramName}の値 {$value} は有効な範囲 ({$min}〜{$max}) 内にあります。";
34}
35
36echo "--- 正常なケース (assertion成功) ---" . PHP_EOL;
37try {
38    // 期待通り、条件が満たされるためAssertionErrorはスローされません
39    echo validateRange(5, 1, 10, '数値A') . PHP_EOL;
40    echo validateRange(1, 1, 10, '数値B') . PHP_EOL;
41    echo validateRange(10, 1, 10, '数値C') . PHP_EOL;
42} catch (AssertionError $e) {
43    // このブロックは通常実行されません
44    echo "エラーが発生しました (想定外のAssertionError): " . $e->getMessage() . PHP_EOL;
45}
46
47echo PHP_EOL . "--- 異常なケース (assertion失敗) ---" . PHP_EOL;
48
49// 最小値より小さい値でassertionが失敗するケース
50try {
51    echo validateRange(0, 1, 10, '数値D') . PHP_EOL;
52    // 上の行でAssertionErrorがスローされるため、この行は実行されません
53} catch (AssertionError $e) {
54    // assertが失敗するとAssertionErrorがスローされるため、ここでキャッチできます
55    echo "AssertionErrorをキャッチしました: " . $e->getMessage() . PHP_EOL;
56}
57
58echo PHP_EOL;
59
60// 最大値より大きい値でassertionが失敗するケース
61try {
62    echo validateRange(11, 1, 10, '数値E') . PHP_EOL;
63    // 上の行でAssertionErrorがスローされるため、この行は実行されません
64} catch (AssertionError $e) {
65    echo "AssertionErrorをキャッチしました: " . $e->getMessage() . PHP_EOL;
66}
67
68?>

PHPのassert関数は、プログラムが特定の条件を「絶対に満たしているはず」という前提が崩れた場合に、それを早期に検知するために使用するデバッグ機能です。主に開発段階でコードの正しさを確認し、予期せぬ状態を早期に発見することを目的とします。本番環境では通常無効にして使用します。

assert関数は二つの引数を取ります。最初の引数$assertionは真偽値として評価される条件です。この条件がtrueであれば何もせず、プログラムの実行を続行します。条件がfalseの場合、二番目の引数$descriptionに指定されたメッセージを持つAssertionErrorがスローされ、プログラムの実行が停止します。戻り値はありません。

サンプルコードでは、まずini_set関数を用いてassert.activeを有効にし、assert.exceptionを有効にすることで、アサーション失敗時にAssertionErrorがスローされるように設定しています。

validateRange関数は、渡された数値が指定された範囲内にあることをassertで確認する例です。正常なケースではassertの条件がtrueとなり、AssertionErrorは発生しません。一方、異常なケースではassertの条件がfalseとなり、指定したエラーメッセージとともにAssertionErrorがスローされます。このAssertionErrorはtry-catchブロックで捕捉し、エラー処理を行うことができます。このようにassertを活用することで、プログラムの信頼性を高めることができます。