一起學習PHP中斷言函數的使用

原來一直以爲斷言相關的函數是 PHPUnit 這些單元測試組件提供的,在閱讀手冊後才發現,這個 assert() 斷言函數是 PHP 本身就自帶的一個函數。也就是說,我們在代碼中進行簡單的測試的時候是不需要完全引入整個單元測試組件的。

assert() 斷言函數


assert(1==1);

assert(1==2);
// assert.exception = 0 時,Warning: assert(): assert(1 == 2)
// assert.exception = 1 時,Fatal error: Uncaught AssertionError: 驗證不通過

很明顯,第二段代碼無法通過斷言驗證。這時,PHP 就會返回一個警告或者異常錯誤。爲什麼有可能是兩種錯誤形式呢?當我們設置 php.ini 中的 assert.exception 爲 off 或者 0 時,也就是關閉這個參數的能力時,程序就會以 PHP5 的形式依然返回一個警告,就像上面代碼中的註釋一樣。同時,通過 try...catch 也無法進行異常的捕獲了。這個參數其實就是控制是否以正宗的異常對象進行拋出。如果保持這個參數爲默認情況也就是設置爲 on 或者 1 的話,就會直接拋出異常,程序中止。

從上述代碼可以看出,斷言的第一個參數是一個表達式,而且是需要一個返回 bool 類型對象的表達式。如果我們傳遞的是一個字符串或者一個數字呢?

// 設置 assert.exception = 0 進行多條測試

assert(" ");
// Deprecated: assert(): Calling assert() with a string argument is deprecated
// Warning: assert(): Assertion " " failed

assert("1");
// Deprecated: assert(): Calling assert() with a string argument is deprecated

assert(0);
// Warning: assert(): assert(0) failed

assert(1);

assert("1==2");
// Deprecated: assert(): Calling assert() with a string argument is deprecated
// Warning: assert(): Assertion "1==2" failed 

很明顯第一個參數的表達式會進行類型強制轉換,但是字符串類型會多出一個過時提醒,表明給 assert() 函數傳遞字符串類型的表達式類型已經過時了。當前的測試版本是 7.3 ,在將來可能就會直接報中止運行的錯誤或異常了。主要問題在於,如果傳遞的字符串本身也是一個表達式的話,會以這個表達式的內容爲基礎進行判斷,這樣很容易產生歧義,就像最後一段代碼一樣。當然,已經過時的使用方式還是不推薦的,這裏僅是做一個瞭解即可。

接下來我們看一下 assert() 函數的其他參數,它的第二個參數是兩種類型,要麼給一個字符串用來定義錯誤的信息,要麼給一個 異常類 用於拋出異常。

assert(1==1, "驗證不通過");

assert(1==2, "驗證不通過");
// Warning: assert(): 驗證不通過 failed 

如果直接給的一個字符串,那麼在警告的提示信息中,顯示的就是我們定義的這個錯誤信息的內容。這個非常好理解。

// 注意 assert.exception 設置不同的區別

assert(1==1,  new Exception("驗證不通過"));

assert(1==2,  new Exception("驗證不通過"));
// assert.exception = 1 時,Fatal error: Uncaught Exception: 驗證不通過
// assert.exception = 0 時,Warning: assert(): Exception: 驗證不通過

當然,我們也可以給一個 異常類 讓斷言拋出一個異常。在默認情況下,這個異常的拋出將中止程序的運行。也就是一個正常的異常拋出流程,我們可以使用 try...catch 進行異常的捕獲。

try{
    assert(1==2,  new Exception("驗證不通過"));
}catch(Exception $e){
    echo "驗證失敗!:", $e->getMessage(), PHP_EOL;
}
// 驗證失敗!:驗證不通過

另外還有一個參數會對斷言的整體運行產生影響,那就是 php.ini 中的 zend.assertions 參數。它包含三個值:

  • 1,生成並執行代碼,一般在測試環境使用
  • 0,生成代碼但是在運行時會路過
  • -1,不生成代碼,一般在正式環境使用

這個參數大家可以自行配置測試,默認的 php.ini 中它的默認值是 1 ,也就是正常的執行 assert() 函數。

assert_options() 及相對應的 php.ini 中的參數配置

PHP 中的斷言功能還爲我們提供了一個 assert_options() 函數,用於方便地設置和獲取一些和斷言能力有關的參數配置。它能夠設置的斷言標誌包括:

標誌 INI設置 默認值 描述
ASSERT_ACTIVE assert.active 1 啓用 assert() 斷言
ASSERT_WARNING assert.warning 1 爲每個失敗的斷言產生一個 PHP 警告(warning)
ASSERT_BAIL assert.bail 0 在斷言失敗時中止執行
ASSERT_QUIET_EVAL assert.quiet_eval 0 在斷言表達式求值時禁用 error_reporting
ASSERT_CALLBACK assert.callback (NULL) 斷言失敗時調用回調函數

這些參數的含義都非常好理解,大家可以自己測試一下。我們就來看一下最後一個 ASSERT_CALLBACK 的作用。其實它的說明也非常清楚,就是斷言失敗的情況下就進入到這個選項定義的回調函數中。

assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 1);
assert_options(ASSERT_BAIL, 1);

assert_options(ASSERT_CALLBACK, function($params){
    echo "====faild====", PHP_EOL;
    var_dump($params);
    echo "====faild====", PHP_EOL;
});

assert(1!=1);
// ====faild====
// string(105) ".../source/一起學習PHP中斷言函數的使用.php"
// ====faild====

當斷言失敗的時候,我們就進入了回調函數中,在回調函數直接簡單的打印了傳給回調函數的參數內容。可以看出,這個回調函數裏面傳遞過來的是無法通過斷言的文件信息。

總結

學習掌握一下斷言函數的使用及配置,可以爲我們將來學習 PHPUnit 單元測試打下基礎,當然,本身這個能力的東西就不是很多,大家記住就好啦!

測試代碼:

https://github.com/zhangyue0503/dev-blog/blob/master/php/202005/source/%E4%B8%80%E8%B5%B7%E5%AD%A6%E4%B9%A0PHP%E4%B8%AD%E6%96%AD%E8%A8%80%E5%87%BD%E6%95%B0%E7%9A%84%E4%BD%BF%E7%94%A8.php

參考文檔:

https://www.php.net/manual/zh/function.assert-options.php

https://www.php.net/manual/zh/function.assert.php

===========

各自媒體平臺均可搜索【硬核項目經理】

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章