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

Copy
1<?php
2
3// アサーションの動作を設定します。
4// 開発環境ではアサーションを有効にし、失敗時にAssertionError例外をスローするようにします。
5// 本番環境では通常、zend.assertionsを-1（無効）に設定し、アサーションのコードをコンパイルから除外します。
6ini_set('zend.assertions', '1');      // アサーションを有効にする (0:無効, 1:有効, -1:コンパイル時に無効化)
7ini_set('assert.exception', '1');     // アサーション失敗時にAssertionError例外をスローする (0:警告, 1:例外)
8
9/**
10 * 特定の条件を検証するサンプル関数です。
11 * assert関数を使用して、条件が満たされない場合にAssertionError例外を捕捉し、エラーメッセージを返します。
12 *
13 * @param mixed $input 検証する値
14 * @return string 検証結果またはエラーメッセージ
15 */
16function processAndValidate($input): string
17{
18    try {
19        // assert関数は、第一引数($assertion)がfalseと評価される場合、
20        // 設定(assert.exception=1)に従ってAssertionErrorをスローします。
21        // 第二引数($description)は、エラーメッセージの一部として使用されます。
22        assert(is_int($input) && $input > 0, '入力は正の整数である必要があります。');
23
24        // アサーションが成功した場合（例外がスローされなかった場合）の処理
25        return "入力値は有効です: " . $input;
26
27    } catch (AssertionError $e) {
28        // assert関数によってスローされたAssertionErrorを捕捉します。
29        return "データ検証エラー: " . $e->getMessage();
30    }
31}
32
33// -- サンプル使用例 --
34
35// 1. 有効な入力の場合
36echo processAndValidate(10) . PHP_EOL;
37
38// 2. 無効な入力の場合（文字列） - is_int($input) が false となり、AssertionErrorがスローされる
39echo processAndValidate("hello") . PHP_EOL;
40
41// 3. 無効な入力の場合（負の整数） - $input > 0 が false となり、AssertionErrorがスローされる
42echo processAndValidate(-5) . PHP_EOL;
43
44// 4. 無効な入力の場合（ゼロ） - $input > 0 が false となり、AssertionErrorがスローされる
45echo processAndValidate(0) . PHP_EOL;
46
47// 5. 無効な入力の場合（浮動小数点数） - is_int($input) が false となり、AssertionErrorがスローされる
48echo processAndValidate(3.14) . PHP_EOL;
49
50?>

PHPのassert関数は、プログラムが特定の条件を満たしていることを検証するために使用されます。第一引数$assertionには検証したい真偽値の条件式を指定し、その条件がfalseと評価された場合にアサーションが失敗します。第二引数$descriptionはオプションで、アサーション失敗時に表示されるエラーメッセージとして利用できます。この関数自体は戻り値を持ちませんが、PHPの設定(assert.exception=1)により、アサーション失敗時にはAssertionError例外がスローされます。

開発中はini_set('zend.assertions', '1')でアサーションを有効にし、ini_set('assert.exception', '1')で失敗時に例外をスローする設定にすることで、予期せぬプログラムの状態を早期に発見できます。本番環境では通常、zend.assertionsを-1に設定し、アサーションコードをコンパイルから除外することでパフォーマンスを向上させます。サンプルコードでは、processAndValidate関数内でassertを使って入力値が正の整数であるかを検証し、条件が満たされない場合にスローされるAssertionErrorを捕捉して適切なエラーメッセージを返す例を示しています。

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/**
4 * assert関数の基本的な使用方法を示すサンプル関数。
5 * 条件が真であることを確認し、失敗した場合はAssertionErrorをスローします。
6 * システムエンジニアを目指す初心者の方へ、開発時のデバッグや前提条件の確認に役立つ関数です。
7 */
8function demonstrateAssertUsage(): void
9{
10    // PHPのデフォルト設定では、assertは有効であり、失敗時にAssertionErrorをスローします。
11    // (通常、本番環境ではパフォーマンスのために無効に設定されます: zend.assertions=0)
12
13    echo "--- assert関数のデモンストレーションを開始します ---\n\n";
14
15    // ケース1: 条件が真であることを確認するアサーション (成功例)
16    // 変数 $quantity が0より大きいことを確認します。
17    $quantity = 5;
18    assert($quantity > 0, "エラー: 数量は正の値である必要があります。");
19    echo "ケース1 (成功): 数量 ($quantity) は正の値です。アサーションがパスしました。\n\n";
20
21    // ケース2: キーワード 'asserttrue' に関連する例 (真偽値がtrueであることを確認)
22    // 変数 $isActive が厳密にtrueであることを確認します。
23    $isActive = true;
24    assert($isActive === true, "エラー: isActiveフラグはtrueであるべきです。");
25    echo "ケース2 (成功): isActiveフラグは ($isActive) trueです。アサーションがパスしました。\n\n";
26
27    // ケース3: 条件が偽であるアサーション (失敗例)
28    // 変数 $age が18歳以上であることを確認しますが、実際には17です。
29    // このアサーションは失敗し、AssertionErrorがスローされます。
30    $age = 17;
31    try {
32        assert($age >= 18, "エラー: 年齢 ($age) は18歳以上である必要があります。");
33        // アサーションが失敗しなかった場合のみ、この行が表示されます。
34        echo "この行はアサーションが失敗しなかった場合にのみ表示されます。\n";
35    } catch (AssertionError $e) {
36        echo "ケース3 (失敗): アサーションが失敗しました。メッセージ: " . $e->getMessage() . "\n";
37        echo "assert関数の第2引数で指定したエラーメッセージがここで表示されます。\n\n";
38    }
39
40    // ケース4: 別の成功例
41    // 変数 $userName が空でない文字列であることを確認します。
42    $userName = "JohnDoe";
43    assert(is_string($userName) && !empty($userName), "エラー: ユーザー名は空でない文字列である必要があります。");
44    echo "ケース4 (成功): ユーザー名 ($userName) は有効な文字列です。アサーションがパスしました。\n\n";
45
46    echo "--- assert関数のデモンストレーションを終了します ---\n";
47}
48
49// 上記の関数を実行して、assert関数の動作を確認します。
50demonstrateAssertUsage();

PHPのassert関数は、開発段階で特定の条件が真 (true) であることを確認するために使用される機能です。システムエンジニアを目指す方にとって、コードのデバッグや、プログラムが正常に動作するための前提条件が満たされているかをチェックする際に非常に役立ちます。

この関数は、第1引数$assertionに評価したい任意の条件式を指定します。この条件式は真偽値に評価され、その結果が真であることを期待します。第2引数$descriptionはオプションで、アサーションが失敗した際に詳細なエラー情報として表示されるメッセージ（文字列またはThrowableオブジェクト）を指定できます。この引数を省略した場合は、PHPが提供するデフォルトのエラーメッセージが使用されます。

assert関数はどのような場合も戻り値を返しません。条件式が真であれば、関数は何の処理も行わずに通過し、プログラムは続行されます。しかし、条件式が偽であった場合、assert関数はAssertionErrorというエラーをスローし、プログラムの実行を中断させます。この挙動により、開発者は予期せぬ状態やロジックの誤りを早期に発見し、修正することができます。

例えば、「asserttrue」というキーワードに関連する用途として、あるフラグ変数が厳密にtrueであるべきかをassert($flag === true, "フラグが真ではありません");のように確認する際に利用されます。この機能は開発時の堅牢性向上に貢献しますが、通常、本番環境ではパフォーマンス上の理由から無効に設定される点にご留意ください。

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を活用することで、プログラムの信頼性を高めることができます。