PHP面向?qū)ο缶幊讨械拇砼c異常定制
一、 DBQuery對(duì)象
現(xiàn)在，我們的DBQuery對(duì)象簡(jiǎn)單地模仿一個(gè)存儲(chǔ)過(guò)程—一旦被執(zhí)行，即返回一個(gè)必須進(jìn)行保存的結(jié)果資源；并且如果你想使用該結(jié)果集上的函數(shù)（例如num_rows()或fetch_row()）的話(huà)，你必須傳遞MySqlDB對(duì)象。那么，如果由DBQuery對(duì)象來(lái)實(shí)現(xiàn)MySqlDB對(duì)象（其設(shè)計(jì)目的是對(duì)一個(gè)執(zhí)行查詢(xún)的結(jié)果進(jìn)行操作）實(shí)現(xiàn)的函數(shù)，效果如何呢？讓我們繼續(xù)使用上一篇示例中的代碼；并且讓我們假定，現(xiàn)在由DBQuery對(duì)象管理我們的結(jié)果資源。DBQuery類(lèi)的源碼如列表1所示。
列表1.使用DBQuery類(lèi)。
- require 'mysql_db.php';
- require_once 'query.php';
- $db = new MySqlDb;
- $db->connect('host'， 'username'， 'pass');
- $db->query('use content_management_system');
- $query = new DBQuery($db);
- $query->prepare('SELECT fname，sname FROM users WHERE username=:1S AND pword=:2S AND expire_time<:3I');
- try {
- if($query->execute("visualad"， "apron"， time()))->num_rows() == 1) {
- echo('Correct Credentials');
- } else {
- echo('Incorrect Credentials / Session Expired');
- }
- } catch (QueryException $e) {
- echo('Error executing query: ' . $e);
- }
上面修改后的代碼中我們最感興趣的是，catch語(yǔ)句和execute語(yǔ)句。
◆execute語(yǔ)句不再返回一個(gè)結(jié)果資源，現(xiàn)在它返回DBQuery對(duì)象本身。
◆DBQuery對(duì)象現(xiàn)在實(shí)現(xiàn)num_rows()函數(shù)—我們從DB接口中已經(jīng)熟悉。
◆如果查詢(xún)執(zhí)行失敗，它拋出一個(gè)QueryException類(lèi)型的異常。當(dāng)被轉(zhuǎn)換成一個(gè)字符串時(shí)，它將返回發(fā)生的錯(cuò)誤的細(xì)節(jié)信息。
為此，你需要使用PHP代理。事實(shí)上，你在我們的DBQuery對(duì)象中已經(jīng)使用代理了，但是現(xiàn)在將更為深入地使用它來(lái)把它與MySqlDB對(duì)象緊密綁定。該DBQuery對(duì)象已經(jīng)被使用一個(gè)實(shí)現(xiàn)DB接口的對(duì)象初始化，并且它已經(jīng)包含一個(gè)成員函數(shù)execute—由它調(diào)用DB對(duì)象的query()方法來(lái)執(zhí)行該查詢(xún)。這個(gè)DBQuery對(duì)象本身并不實(shí)際地查詢(xún)數(shù)據(jù)庫(kù)，它把這項(xiàng)任務(wù)交由DB對(duì)象來(lái)完成。這就是代理，其實(shí)是一個(gè)進(jìn)程—借助于這個(gè)進(jìn)程，通過(guò)把消息發(fā)送給另一個(gè)實(shí)現(xiàn)相同的或類(lèi)似行為的對(duì)象，一個(gè)對(duì)象可以實(shí)現(xiàn)一個(gè)特別的行為。
為此，你需要修改DBQuery對(duì)象以便包括所有的函數(shù)—它們操作一個(gè)來(lái)自DB對(duì)象的結(jié)果資源。當(dāng)執(zhí)行查詢(xún)以調(diào)用DB對(duì)象的相應(yīng)函數(shù)并且返回它的結(jié)果時(shí)，你需要使用存儲(chǔ)的結(jié)果。下列函數(shù)將被添加：
列表2:使用代理擴(kuò)展DBQuery類(lèi)。
- class DBQuery
- {
- .....
- public function fetch_array()
- {
- if (! is_resource($this->result)) {
- throw new Exception('Query not executed.');
- }
- return $this->db->fetch_array($this->result);
- }
- public function fetch_row()
- {
- if (! is_resource($this->result)) {
- throw new Exception('Query not executed.');
- }
- return $this->db->fetch_row($this->result);
- }
- public function fetch_assoc()
- {
- if (! is_resource($this->result)) {
- throw new Exception('Query not executed.');
- }
- return $this->db->fetch_assoc($this->result);
- }
- public function fetch_object()
- {
- if (! is_resource($this->result)) {
- throw new Exception('Query not executed.');
- }
- return $this->db->fetch_object($this->result);
- }
- public function num_rows()
- {
- if (! is_resource($this->result)) {
- throw new Exception('Query not executed.');
- }
- return $this->db->num_rows($this->result);
- }
- }
每個(gè)函數(shù)的實(shí)現(xiàn)相當(dāng)簡(jiǎn)單。它首先進(jìn)行檢查，以確保已經(jīng)執(zhí)行查詢(xún)，然后把任務(wù)代理到DB對(duì)象，返回它的結(jié)果就好象它是查詢(xún)對(duì)象本身（稱(chēng)作是基本數(shù)據(jù)庫(kù)函數(shù)）一樣。#p#
二、 類(lèi)型提示（Type Hinting）
為了使代理能夠工作，我們需要確保DBQuery對(duì)象的$db變量是一個(gè)實(shí)現(xiàn)了DB接口的對(duì)象的實(shí)例。類(lèi)型提示是PHP 5中的一種新特征，它能夠使你把函數(shù)參數(shù)強(qiáng)制轉(zhuǎn)換成特定類(lèi)型的對(duì)象。在PHP 5之前，唯一的確保函數(shù)參數(shù)是一個(gè)特定對(duì)象類(lèi)型的方法是使用PHP中所提供的類(lèi)型檢查函數(shù)（也即是is_a()）?，F(xiàn)在，你可以簡(jiǎn)單地強(qiáng)制轉(zhuǎn)換對(duì)象類(lèi)型—通過(guò)在函數(shù)參數(shù)的前面加上類(lèi)型名。你已經(jīng)從我們的DBQuery對(duì)象中看到了類(lèi)型提示，這樣可以確保一個(gè)實(shí)現(xiàn)DB接口的對(duì)象被傳遞到對(duì)象構(gòu)造器中。
- public function __construct(DB $db)
- {
- $this->db = $db;
- }
當(dāng)使用類(lèi)型提示時(shí)，你不僅可以指定對(duì)象類(lèi)型，還可以指定抽象類(lèi)和接口。
三、 拋出異常
你可能已經(jīng)從上面的代碼中注意到，你捕獲的是一個(gè)稱(chēng)為QueryException（我們將在后面實(shí)現(xiàn)這個(gè)對(duì)象）的異常。一個(gè)異常類(lèi)似于一個(gè)錯(cuò)誤，然而卻更具有一般性。描述一個(gè)異常的最好的方法是使用emergency。盡管一個(gè)emergency可以不會(huì)是“致命的”，但是還是必須處理它。當(dāng)在PHP中拋出一個(gè)異常時(shí)，執(zhí)行的當(dāng)前范圍很快地被終止，不管它是一個(gè)函數(shù)，try..catch塊還是腳本本身。然后，該異常遍歷調(diào)用?！K止每個(gè)執(zhí)行范圍，直到或者在一個(gè)try..catch塊中捕獲它或者它到達(dá)調(diào)用棧的頂部—此時(shí)它將生成一個(gè)致命錯(cuò)誤。
異常處理是PHP 5中的另外一個(gè)新特征，當(dāng)與面向?qū)ο缶幊搪?lián)用時(shí)，它能夠?qū)崿F(xiàn)良好地控制錯(cuò)誤處理和報(bào)告。一個(gè)try..catch塊是一種處理異常的重要機(jī)制。一旦被捕獲，腳本將會(huì)從異常被捕獲和被處理的代碼的下一行繼續(xù)執(zhí)行。
如果查詢(xún)失敗，你需要改變你的execute函數(shù)以?huà)伋鲆粋€(gè)PHP異常。你將拋出一個(gè)稱(chēng)為QueryException的定制異常對(duì)象—導(dǎo)致錯(cuò)誤的DBQuery對(duì)象被傳遞給它。
列表3.拋出一個(gè)異常。
- /**
- *執(zhí)行當(dāng)前查詢(xún)
- *
- * 執(zhí)行當(dāng)前查詢(xún)—用提供的參數(shù)代替任何點(diǎn)位符
- * .
- *
- * @參數(shù)： mixed $queryParams，... 查詢(xún)參數(shù)
- * @返回：資源A—參考描述執(zhí)行查詢(xún)的資源。
- */
- public function execute($queryParams = ')
- {
- //例如: SELECT * FROM table WHERE name=:1S AND type=:2I AND level=:3N
- $args = func_get_args();
- if ($this->stored_procedure) {
- /*調(diào)用compile函數(shù)以得到查詢(xún)*/
- $query = call_user_func_array(array($this， 'compile')， $args);
- } else {
- /*一個(gè)存儲(chǔ)過(guò)程沒(méi)被初始化，因此，作為一種標(biāo)準(zhǔn)查詢(xún)來(lái)執(zhí)行之*/
- $query = $queryParams;
- }
- $result = $this->db->query($query);
- if (! $result) {
- throw new QueryException($this);
- }
- $this->result = $result;
- /* 注意現(xiàn)在我們?cè)趺捶祷貙?duì)象本身，這使我們能夠從這個(gè)函數(shù)的返回結(jié)果中調(diào)用成員函數(shù)
- */
- return $this;
- }
四、 使用繼承拋出定制異常
在PHP中，你可以?huà)伋鋈魏螌?duì)象作為一個(gè)PHP異常；但是，首先該異常應(yīng)該繼承自PHP的內(nèi)置異常類(lèi)。通過(guò)創(chuàng)建你自己的定制異常，你可以記錄其它有關(guān)于該錯(cuò)誤的信息，例如在一個(gè)日志文件中創(chuàng)建一個(gè)入口，或做你喜歡做的任何事情。你的定制異常將要做如下幾件事情：
◆記錄由查詢(xún)產(chǎn)生的來(lái)自DB對(duì)象的錯(cuò)誤消息。
◆給出查詢(xún)錯(cuò)誤發(fā)生所在行代碼的準(zhǔn)確細(xì)節(jié)—通過(guò)檢查調(diào)用棧。
◆顯示錯(cuò)誤消息和查詢(xún)文本—當(dāng)被轉(zhuǎn)換成一個(gè)字符串時(shí)。
為了得到錯(cuò)誤信息和查詢(xún)文本，需要對(duì)DBQuery對(duì)象作多處更改。
1. 一個(gè)新的protected屬性—compiledQuery—需要被添加到類(lèi)中。
2. compile()函數(shù)使用查詢(xún)文本更新查詢(xún)compiledQuery屬性。
3. 應(yīng)該加入一個(gè)檢索編譯的查詢(xún)文本的函數(shù)。
4. 還應(yīng)該加入一個(gè)函數(shù)—它得到當(dāng)前的與DBQuery對(duì)象相關(guān)聯(lián)的DB對(duì)象。
列表4.拋出一個(gè)PHP異常。
- class DBQuery
- {
- /**
- *在調(diào)用compile()或execute()之后存儲(chǔ)查詢(xún)的編譯版本
- *
- * @var string $compiledQuery
- */
- protected $compiledQuery;
- /**
- * 返回編譯的查詢(xún)而不執(zhí)行它。
- * @參數(shù)：mixed $params，...查詢(xún)參數(shù)
- * @返回：字符串—編譯的查詢(xún)
- */
- public function compile($params=')
- {
- if (! $this->stored_procedure) {
- throw new Exception("存儲(chǔ)過(guò)程沒(méi)被初始化.");
- }
- /*代替參數(shù)*/
- $params = func_get_args(); //得到函數(shù)參數(shù)
- $query = preg_replace("/(?compile_callback($params， 1， "2")'， $this->query);
- return ($this->compiledQuery = $this->add_strings($query)); //把字符串放回查詢(xún)中
- }
- public function getDB()
- {
- return $this->db;
- }
- public function getCompiledQuery()
- {
- return $this->compiledQuery;
- }
- }
現(xiàn)在，你可以實(shí)現(xiàn)QueryException類(lèi)。注意你是如何遍歷調(diào)用棧以在腳本中查找實(shí)際導(dǎo)致錯(cuò)誤的位置的。這正好適用于當(dāng)拋出異常的DBQuery對(duì)象是一個(gè)繼承自DBQuery對(duì)象的子類(lèi)的情況。
列表5:QueryException類(lèi)。
- /**
- *查詢(xún)異常
- *
- *當(dāng)試圖執(zhí)行一個(gè)查詢(xún)時(shí)，如果一個(gè)錯(cuò)誤發(fā)生，將由{@link DBQuery}對(duì)象拋出錯(cuò)誤
- */
- class QueryException extends Exception
- {
- /**
- * 查詢(xún)文本
- *
- * @var字符串$QueryText;
- */
- protected $QueryText;
- /**
- *來(lái)自數(shù)據(jù)庫(kù)的錯(cuò)誤號(hào)/代碼
- *
- * @var字符串$ErrorCode
- */
- protected $ErrorNumber;
- /**
- *來(lái)自數(shù)據(jù)庫(kù)的錯(cuò)誤消息
- *
- * @var字符串$ErrorMessage
- */
- protected $ErrorMessage;
- /**
- *類(lèi)構(gòu)造器
- *
- * @參數(shù)：DBQuery $db，是拋出異常的查詢(xún)對(duì)象
- */
- public function __construct(DBQuery $query)
- {
- /*得到調(diào)用棧*/
- $backtrace = $this->GetTrace();
- /*把行和文件設(shè)置到錯(cuò)誤實(shí)際發(fā)生的位置*/
- if (count($backtrace) > 0) {
- $x = 1;
- /*如果查詢(xún)類(lèi)被繼承，那么我們需要忽略由子類(lèi)所進(jìn)行的調(diào)用*/
- while((! isset($backtrace[$x]['line'])) ||
- (isset($backtrace[$x]['class']) && is_subclass_of($backtrace[$x]['class']， 'DBQuery')) ||
- (strpos(strtolower(@$backtrace[$x]['function'])， 'call_user_func')) !== false ) {
- /*循環(huán)執(zhí)行，只要沒(méi)有行號(hào)或調(diào)用的函數(shù)是DBQuery類(lèi)的一個(gè)子類(lèi)*/
- ++$x;
- /*如果我們到達(dá)棧底，那么我們使用***個(gè)調(diào)用者*/
- if (($x) >= count($backtrace)) {
- $x = count($backtrace);
- break;
- }
- }
- /*如果上面的循環(huán)至少執(zhí)行一次，那么我們可以把它減1以查找實(shí)際的引起錯(cuò)誤的代碼行
- */
- if ($x != 1) {
- $x -= 1;
- }
- /****，我們可以設(shè)置文件和行號(hào)，這應(yīng)該可以反映出引起錯(cuò)誤的SQL語(yǔ)句*/
- $this->line = $backtrace[$x]['line'];
- $this->file = $backtrace[$x]['file'];
- }
- $this->QueryText = $query->getCompiledQuery();
- $this->ErrorNumber = $query->getDB()->errno();
- $this->ErrorMessage = $query->getDB()->error();
- /*調(diào)用超類(lèi)的異常構(gòu)造器*/
- parent::__construct('Query Error'， 0);
- }
- /**
- *得到查詢(xún)文本
- *
- * @返回字符串查詢(xún)文本
- */
- public function GetQueryText()
- {
- return $this->QueryText;
- }
- /**
- *得到錯(cuò)誤號(hào)
- *
- * @返回字符串錯(cuò)誤號(hào)
- */
- public function GetErrorNumber()
- {
- return $this->ErrorNumber;
- }
- /**
- *得到錯(cuò)誤消息
- *
- * @返回字符串錯(cuò)誤消息
- */
- public function GetErrorMessage()
- {
- return $this->ErrorMessage;
- }
- /**
- *當(dāng)對(duì)象被轉(zhuǎn)換為一個(gè)字符串時(shí)調(diào)用。
- * @返回字符串
- */
- public function __toString()
- {
- $output = "Query Error in {$this->file} on line {$this->line}nn";
- $output .= "Query: {$this->QueryText}n";
- $output .= "Error: {$this->ErrorMessage} ({$this->ErrorNumber})nn";
- return $output;
- }
- }
至此，在本節(jié)開(kāi)始看到的代碼可以工作了。
五、 結(jié)論
在本文中，你看到了PHP代理是怎樣把與查詢(xún)相聯(lián)系的DB接口映射到針對(duì)一個(gè)特定的查詢(xún)結(jié)果上的操作。DBQuery對(duì)象暴露相同的函數(shù)，例如fetch_assoc()，作為DB對(duì)象。然而，這些都是針對(duì)單個(gè)查詢(xún)起作用。你還學(xué)習(xí)了如何使用定制異常來(lái)給出詳細(xì)信息—一個(gè)錯(cuò)誤發(fā)生在何時(shí)何地，以及它們?cè)鯓痈玫乜刂棋e(cuò)誤的處理。
【編輯推薦】
