1. php 錯(cuò)誤處理
在創(chuàng)建腳本和 web 應(yīng)用程序時(shí),錯(cuò)誤處理是一個(gè)重要的部分。如果您的代碼缺少錯(cuò)誤檢測(cè)編碼,那么程序看上去很不專業(yè),也為安全風(fēng)險(xiǎn)敞開(kāi)了大門。
本教程介紹了 php 中一些最為重要的錯(cuò)誤檢測(cè)方法。
我們將為您講解不同的錯(cuò)誤處理方法:
- 簡(jiǎn)單的 "die()" 語(yǔ)句
- 自定義錯(cuò)誤和錯(cuò)誤觸發(fā)器
- 錯(cuò)誤報(bào)告
2. 基本的錯(cuò)誤處理:使用 die() 函數(shù)
第一個(gè)范例展示了一個(gè)打開(kāi)文本文件的簡(jiǎn)單腳本:
<?php $file=fopen("welcome.txt","r"); ?>
如果文件不存在,您會(huì)得到類似這樣的錯(cuò)誤:
warning: fopen(welcome.txt) [function.fopen]: failed to open stream: no such file or directory in /www/yapf/test/test.php on line 2
為了避免用戶得到類似上面的錯(cuò)誤消息,我們?cè)谠L問(wèn)文件之前檢測(cè)該文件是否存在:
<?php if(!file_exists("welcome.txt")) { die("文件不存在"); } else { $file=fopen("welcome.txt","r"); } ?>
現(xiàn)在,如果文件不存在,您會(huì)得到類似這樣的錯(cuò)誤消息:
文件不存在
相比之前的代碼,上面的代碼更有效,這是由于它采用了一個(gè)簡(jiǎn)單的錯(cuò)誤處理機(jī)制在錯(cuò)誤之后終止了腳本。
然而,簡(jiǎn)單地終止腳本并不總是恰當(dāng)?shù)姆绞?。讓我們研究一下用于處理錯(cuò)誤的備選的 php 函數(shù)。
3. 創(chuàng)建自定義錯(cuò)誤處理器
創(chuàng)建一個(gè)自定義的錯(cuò)誤處理器非常簡(jiǎn)單。我們很簡(jiǎn)單地創(chuàng)建了一個(gè)專用函數(shù),可以在 php 中發(fā)生錯(cuò)誤時(shí)調(diào)用該函數(shù)。
該函數(shù)必須有能力處理至少兩個(gè)參數(shù) (error level 和 error message),但是可以接受最多五個(gè)參數(shù)(可選的:file, line-number 和 error context):
error_function(error_level,error_message, error_file,error_line,error_context)
參數(shù) | 描述 |
---|---|
error_level | 必需。為用戶定義的錯(cuò)誤規(guī)定錯(cuò)誤報(bào)告級(jí)別。必須是一個(gè)數(shù)字。參見(jiàn)下面的表格:錯(cuò)誤報(bào)告級(jí)別。 |
error_message | 必需。為用戶定義的錯(cuò)誤規(guī)定錯(cuò)誤消息。 |
error_file | 可選。規(guī)定錯(cuò)誤發(fā)生的文件名。 |
error_line | 可選。規(guī)定錯(cuò)誤發(fā)生的行號(hào)。 |
error_context | 可選。規(guī)定一個(gè)數(shù)組,包含了當(dāng)錯(cuò)誤發(fā)生時(shí)在用的每個(gè)變量以及它們的值。 |
4. 錯(cuò)誤報(bào)告級(jí)別
這些錯(cuò)誤報(bào)告級(jí)別是用戶自定義的錯(cuò)誤處理程序處理的不同類型的錯(cuò)誤:
值 | 常量 | 描述 |
---|---|---|
2 | e_warning | 非致命的 run-time 錯(cuò)誤。不暫停腳本執(zhí)行。 |
8 | e_notice | run-time 通知。在腳本發(fā)現(xiàn)可能有錯(cuò)誤時(shí)發(fā)生,但也可能在腳本正常運(yùn)行時(shí)發(fā)生。 |
256 | e_user_error | 致命的用戶生成的錯(cuò)誤。這類似于程序員使用 php 函數(shù) trigger_error() 設(shè)置的 e_error。 |
512 | e_user_warning | 非致命的用戶生成的警告。這類似于程序員使用 php 函數(shù) trigger_error() 設(shè)置的 e_warning。 |
1024 | e_user_notice | 用戶生成的通知。這類似于程序員使用 php 函數(shù) trigger_error() 設(shè)置的 e_notice。 |
4096 | e_recoverable_error | 可捕獲的致命錯(cuò)誤。類似 e_error,但可被用戶定義的處理程序捕獲。(參見(jiàn) set_error_handler()) |
8191 | e_all | 所有錯(cuò)誤和警告。(在 php 5.4 中,e_strict 成為 e_all 的一部分) |
現(xiàn)在,讓我們創(chuàng)建一個(gè)處理錯(cuò)誤的函數(shù):
function customerror($errno, $errstr) { echo "<b>error:</b> [$errno] $errstr<br>"; echo "腳本結(jié)束"; die(); }
上面的代碼是一個(gè)簡(jiǎn)單的錯(cuò)誤處理函數(shù)。當(dāng)它被觸發(fā)時(shí),它會(huì)取得錯(cuò)誤級(jí)別和錯(cuò)誤消息。然后它會(huì)輸出錯(cuò)誤級(jí)別和消息,并終止腳本。
現(xiàn)在,我們已經(jīng)創(chuàng)建了一個(gè)錯(cuò)誤處理函數(shù),我們需要確定在何時(shí)觸發(fā)該函數(shù)。
5. 設(shè)置錯(cuò)誤處理程序
php 的默認(rèn)錯(cuò)誤處理程序是內(nèi)建的錯(cuò)誤處理程序。我們打算把上面的函數(shù)改造為腳本運(yùn)行期間的默認(rèn)錯(cuò)誤處理程序。
可以修改錯(cuò)誤處理程序,使其僅應(yīng)用到某些錯(cuò)誤,這樣腳本就能以不同的方式來(lái)處理不同的錯(cuò)誤。然而,在本例中,我們打算針對(duì)所有錯(cuò)誤來(lái)使用我們自定義的錯(cuò)誤處理程序:
set_error_handler("customerror");
由于我們希望我們的自定義函數(shù)能處理所有錯(cuò)誤,set_error_handler() 僅需要一個(gè)參數(shù),可以添加第二個(gè)參數(shù)來(lái)規(guī)定錯(cuò)誤級(jí)別。
通過(guò)嘗試輸出不存在的變量,來(lái)測(cè)試這個(gè)錯(cuò)誤處理程序:
<?php // 錯(cuò)誤處理函數(shù) function customerror($errno, $errstr) { echo "<b>error:</b> [$errno] $errstr"; } // 設(shè)置錯(cuò)誤處理函數(shù) set_error_handler("customerror"); // 觸發(fā)錯(cuò)誤 echo($test); ?>
以上代碼的輸出如下所示:
error: [8] undefined variable: test
6. 觸發(fā)錯(cuò)誤
在腳本中用戶輸入數(shù)據(jù)的位置,當(dāng)用戶的輸入無(wú)效時(shí)觸發(fā)錯(cuò)誤是很有用的。在 php 中,這個(gè)任務(wù)由 trigger_error() 函數(shù)完成。
在本例中,如果 "test" 變量大于 "1",就會(huì)發(fā)生錯(cuò)誤:
<?php $test=2; if ($test>1) { trigger_error("變量值必須小于等于 1"); } ?>
以上代碼的輸出如下所示:
notice: 變量值必須小于等于 1 in /www/test/yapf.php on line 5
您可以在腳本中任何位置觸發(fā)錯(cuò)誤,通過(guò)添加的第二個(gè)參數(shù),您能夠規(guī)定所觸發(fā)的錯(cuò)誤類型。
可能的錯(cuò)誤類型:
- e_user_error - 致命的用戶生成的 run-time 錯(cuò)誤。錯(cuò)誤無(wú)法恢復(fù)。腳本執(zhí)行被中斷。
- e_user_warning - 非致命的用戶生成的 run-time 警告。腳本執(zhí)行不被中斷。
- e_user_notice - 默認(rèn)。用戶生成的 run-time 通知。在腳本發(fā)現(xiàn)可能有錯(cuò)誤時(shí)發(fā)生,但也可能在腳本正常運(yùn)行時(shí)發(fā)生。
在本例中,如果 "test" 變量大于 "1",則發(fā)生 e_user_warning 錯(cuò)誤。如果發(fā)生了 e_user_warning,我們將使用我們自定義的錯(cuò)誤處理程序并結(jié)束腳本:
<?php // 錯(cuò)誤處理函數(shù) function customerror($errno, $errstr) { echo "<b>error:</b> [$errno] $errstr<br>"; echo "腳本結(jié)束"; die(); } // 設(shè)置錯(cuò)誤處理函數(shù) set_error_handler("customerror",e_user_warning); // 觸發(fā)錯(cuò)誤 $test=2; if ($test>1) { trigger_error("變量值必須小于等于 1",e_user_warning); } ?>
以上代碼的輸出如下所示:
error: [512] 變量值必須小于等于 1 腳本結(jié)束
現(xiàn)在,我們已經(jīng)學(xué)習(xí)了如何創(chuàng)建自己的 error,以及如何觸發(fā)它們,接下來(lái)我們研究一下錯(cuò)誤記錄。
7. 錯(cuò)誤記錄
在默認(rèn)的情況下,根據(jù)在 php.ini 中的 error_log 配置,php 向服務(wù)器的記錄系統(tǒng)或文件發(fā)送錯(cuò)誤記錄。通過(guò)使用 error_log() 函數(shù),您可以向指定的文件或遠(yuǎn)程目的地發(fā)送錯(cuò)誤記錄。
通過(guò)電子郵件向您自己發(fā)送錯(cuò)誤消息,是一種獲得指定錯(cuò)誤的通知的好辦法。
8. 通過(guò) e-mail 發(fā)送錯(cuò)誤消息
在下面的例子中,如果特定的錯(cuò)誤發(fā)生,我們將發(fā)送帶有錯(cuò)誤消息的電子郵件,并結(jié)束腳本:
<?php // 錯(cuò)誤處理函數(shù) function customerror($errno, $errstr) { echo "<b>error:</b> [$errno] $errstr<br>"; echo "已通知網(wǎng)站管理員"; error_log("error: [$errno] $errstr",1, "someone@example.com","from: webmaster@example.com"); } // 設(shè)置錯(cuò)誤處理函數(shù) set_error_handler("customerror",e_user_warning); // 觸發(fā)錯(cuò)誤 $test=2; if ($test>1) { trigger_error("變量值必須小于等于 1",e_user_warning); } ?>
以上代碼的輸出如下所示:
error: [512] 變量值必須小于等于 1 已通知網(wǎng)站管理員
接收自以上代碼的郵件如下所示:
error: [512] 變量值必須小于等于 1
這個(gè)方法不適合所有的錯(cuò)誤。常規(guī)錯(cuò)誤應(yīng)當(dāng)通過(guò)使用默認(rèn)的 php 記錄系統(tǒng)在服務(wù)器上進(jìn)行記錄。