你所不知的 PHP 斷言(assert)

Pines_Cheng 發(fā)布于2019-07-01 12:51 / 728人閱讀

摘要：中的斷言常用于調(diào)試，檢查一個表達式或語句是否為。用的最多的場景就是單元測試，一般的單元測試框架都采用了斷言。運行結(jié)果中的斷言在中，采用函數(shù)對表達式進行斷言。單元測試測試不通過測試不通過是不是跟我們用寫單元測試很像

PHP 中的斷言常用于調(diào)試，檢查一個表達式或語句是否為 FALSE。本文帶你重新認識 PHP assert() 函數(shù)的神(Qi)通(Yin)廣(Ji)大(Qiao)。本文基于 PHP Version 7.1.28

什么是斷言

編寫程序時，常會做出一定的假設(shè)，那斷言就是用來捕獲假設(shè)的異常，我們也可以認為斷言是異常的一種特殊形式。

斷言一般用于程序執(zhí)行結(jié)構(gòu)的判斷，不可讓斷言處理業(yè)務(wù)流程。用的最多的場景就是單元測試，一般的單元測試框架都采用了斷言。

assert(1 == 2);

// 運行結(jié)果:
// Warning: assert(): assert(1 == 2) failed in /Users/shocker/Desktop/demo.php on line 25

PHP 中的斷言

在 PHP 中，采用 assert() 函數(shù)對表達式進行斷言。

// PHP 5
assert ( mixed $assertion [, string $description ] ) : bool

// PHP 7
assert ( mixed $assertion [, Throwable $exception ] ) : bool

傳統(tǒng)的斷言方式 (PHP 5 & 7)

參數(shù) assertion 既支持表達式，也支持表達式字符串（某些特定的場景會用到，比如判斷某個字符串表達式是否合法）

如果 assertion 是字符串，它將會被 assert() 當(dāng)做 PHP 代碼來執(zhí)行。assertion 是字符串的優(yōu)勢是當(dāng)禁用斷言時它的開銷會更小，并且在斷言失敗時消息會包含 assertion 表達式。

斷言這個功能應(yīng)該只被用來調(diào)試。你應(yīng)該用于完整性檢查時測試條件是否始終應(yīng)該為 TRUE，來指示某些程序錯誤，或者檢查具體功能的存在（類似擴展函數(shù)或特定的系統(tǒng)限制和功能）。

斷言不應(yīng)該用于普通運行時操作，類似輸入?yún)?shù)的檢查。作為一個經(jīng)驗法則，在斷言禁用時你的代碼也應(yīng)該能夠正確地運行。

使用示例:

function my_assert_handler($file, $line, $code, $desc)
{
    echo "Assertion Failed:
    File "{$file}"
    Line "{$line}"
    Code "{$code}"
    Desc "{$desc}"
";
}

// 設(shè)置回調(diào)函數(shù)
assert_options(ASSERT_CALLBACK, "my_assert_handler");

// 讓一則斷言失敗
assert("1 == 2", "1 不可能等于 2");

運行結(jié)果:

Assertion Failed:
    File "/Users/shocker/Desktop/demo.php"
    Line "29"
    Code "1 == 2"
    Desc "1 不可能等于 2"

支持異常的斷言 (僅 PHP 7)

在 PHP 7 中，assert() 是一個語言結(jié)構(gòu)，允許在不同環(huán)境中生效不同的措施，具體可見 zend.assertions 配置。

另外，還支持通過 AssertionError 捕獲錯誤。

使用示例:

assert_options(ASSERT_EXCEPTION, 1); // 在斷言失敗時產(chǎn)生異常

try {
    // 用 AssertionError 異常替代普通字符串
    assert(true == false, new AssertionError("True is not false!"));
} catch (Throwable $e) {
    echo $e->getMessage();
}

運行結(jié)果:

True is not false!

對斷言行為進行控制

PHP 支持 assert_options() 函數(shù)對斷言進行配置，也可用 ini 進行設(shè)置

以下配置中，常量標志用于 assert_options() 函數(shù)進行配置，ini 設(shè)置用于 ini_set() 函數(shù)設(shè)置，效果一樣

標志	INI 設(shè)置	默認值	描述
ASSERT_ACTIVE	assert.active	"1"	啟用 assert() 斷言
ASSERT_WARNING	assert.warning	"1"	為每個失敗的斷言產(chǎn)生一個 PHP 警告（warning）
ASSERT_BAIL	assert.bail	"0"	在斷言失敗時中止執(zhí)行
ASSERT_QUIET_EVAL	assert.quiet_eval	"0"	在斷言表達式求值時禁用 error_reporting
ASSERT_CALLBACK	assert.callback	NULL	斷言失敗時調(diào)用該回調(diào)函數(shù)
ASSERT_EXCEPTION	assert.exception	"0"	在斷言失敗時產(chǎn)生 AssertionError 異常（自 PHP 7.0.0 起有效）

zend.assertions 是個特殊的配置（PHP >= 7.0.0 支持），控制不同運行環(huán)境下斷言的行為，僅可用 ini_set() 進行設(shè)置。并且，設(shè)置了1就不能再設(shè)置為-1，反之亦然，其他不受限。


1: 編譯代碼，并執(zhí)行(開發(fā)模式)

0: 編輯代碼，但運行時跳過

-1: 不編譯代碼(生產(chǎn)模式)

版本的不兼容

PHP >= 5.4.8，description 可作為第四個參數(shù)提供給 ASSERT_CALLBACK 模式里的回調(diào)函數(shù)

在 PHP 5 中，參數(shù) assertion 必須是可執(zhí)行的字符串，或者運行結(jié)果為布爾值的表達式

在 PHP 7 中，參數(shù) assertion 可以是任意表達式，并用其運算結(jié)果作為斷言的依據(jù)

在 PHP 7 中，參數(shù) exception 可以是個 Throwable 對象，用于捕獲表達式運行錯誤或斷言結(jié)果為失敗。(當(dāng)然 assert.exception 需開啟)

PHP >= 7.0.0，支持 zend.assertions、assert.exception 相關(guān)配置及其特性

PHP >= 7.2 版本開始，參數(shù) assertion 不再支持字符串

詳見 PHP 7.2.x 中廢棄的功能

Deprecated: assert(): Calling assert() with a string argument is deprecated

應(yīng)用場景 調(diào)試輸出

先看示例:

assert("1 == 2", "1 不可能等于 2");

運行結(jié)果:

Warning: assert(): 1 不可能等于 2: "1 == 2" failed in /Users/shocker/Desktop/demo.php on line 10

類似于:

$expression = 1 == 2;
if (!($expression)) {
    echo "1 不可能等于 2
";
    var_dump($expression);
    echo __FILE__ . "
";
}

但是，我們無法得知 $expression 的具體表達式，也無法得知具體的執(zhí)行行數(shù)。

單元測試

function arraySum(array $nums) {
    $sum = 0;
    foreach ($nums as $n) {
        $sum += $n;
    }

    return $sum;
}

assert(arraySum([1, 2, 3]) == 6, "arraySum() 測試不通過:");
assert(is_numeric(arraySum([1, 2, 3])), "arraySum() 測試不通過:");

是不是跟我們用 PHPUnit 寫單元測試很像