PHP面向對象編程中的代理與異常定制
一、 DBQuery對象
現在,我們的DBQuery對象簡單地模仿一個存儲過程—一旦被執行,即返回一個必須進行保存的結果資源;并且如果你想使用該結果集上的函數(例如num_rows()或fetch_row())的話,你必須傳遞MySqlDB對象。那么,如果由DBQuery對象來實現MySqlDB對象(其設計目的是對一個執行查詢的結果進行操作)實現的函數,效果如何呢?讓我們繼續使用上一篇示例中的代碼;并且讓我們假定,現在由DBQuery對象管理我們的結果資源。DBQuery類的源碼如列表1所示。
列表1.使用DBQuery類。
- 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語句和execute語句。
◆execute語句不再返回一個結果資源,現在它返回DBQuery對象本身。
◆DBQuery對象現在實現num_rows()函數—我們從DB接口中已經熟悉。
◆如果查詢執行失敗,它拋出一個QueryException類型的異常。當被轉換成一個字符串時,它將返回發生的錯誤的細節信息。
為此,你需要使用PHP代理。事實上,你在我們的DBQuery對象中已經使用代理了,但是現在將更為深入地使用它來把它與MySqlDB對象緊密綁定。該DBQuery對象已經被使用一個實現DB接口的對象初始化,并且它已經包含一個成員函數execute—由它調用DB對象的query()方法來執行該查詢。這個DBQuery對象本身并不實際地查詢數據庫,它把這項任務交由DB對象來完成。這就是代理,其實是一個進程—借助于這個進程,通過把消息發送給另一個實現相同的或類似行為的對象,一個對象可以實現一個特別的行為。
為此,你需要修改DBQuery對象以便包括所有的函數—它們操作一個來自DB對象的結果資源。當執行查詢以調用DB對象的相應函數并且返回它的結果時,你需要使用存儲的結果。下列函數將被添加:
列表2:使用代理擴展DBQuery類。
- 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);
- }
- }
每個函數的實現相當簡單。它首先進行檢查,以確保已經執行查詢,然后把任務代理到DB對象,返回它的結果就好象它是查詢對象本身(稱作是基本數據庫函數)一樣。#p#
二、 類型提示(Type Hinting)
為了使代理能夠工作,我們需要確保DBQuery對象的$db變量是一個實現了DB接口的對象的實例。類型提示是PHP 5中的一種新特征,它能夠使你把函數參數強制轉換成特定類型的對象。在PHP 5之前,唯一的確保函數參數是一個特定對象類型的方法是使用PHP中所提供的類型檢查函數(也即是is_a())。現在,你可以簡單地強制轉換對象類型—通過在函數參數的前面加上類型名。你已經從我們的DBQuery對象中看到了類型提示,這樣可以確保一個實現DB接口的對象被傳遞到對象構造器中。
- public function __construct(DB $db)
- {
- $this->db = $db;
- }
當使用類型提示時,你不僅可以指定對象類型,還可以指定抽象類和接口。
三、 拋出異常
你可能已經從上面的代碼中注意到,你捕獲的是一個稱為QueryException(我們將在后面實現這個對象)的異常。一個異常類似于一個錯誤,然而卻更具有一般性。描述一個異常的最好的方法是使用emergency。盡管一個emergency可以不會是“致命的”,但是還是必須處理它。當在PHP中拋出一個異常時,執行的當前范圍很快地被終止,不管它是一個函數,try..catch塊還是腳本本身。然后,該異常遍歷調用棧—終止每個執行范圍,直到或者在一個try..catch塊中捕獲它或者它到達調用棧的頂部—此時它將生成一個致命錯誤。
異常處理是PHP 5中的另外一個新特征,當與面向對象編程聯用時,它能夠實現良好地控制錯誤處理和報告。一個try..catch塊是一種處理異常的重要機制。一旦被捕獲,腳本將會從異常被捕獲和被處理的代碼的下一行繼續執行。
如果查詢失敗,你需要改變你的execute函數以拋出一個PHP異常。你將拋出一個稱為QueryException的定制異常對象—導致錯誤的DBQuery對象被傳遞給它。
列表3.拋出一個異常。
- /**
- *執行當前查詢
- *
- * 執行當前查詢—用提供的參數代替任何點位符
- * .
- *
- * @參數: mixed $queryParams,... 查詢參數
- * @返回:資源A—參考描述執行查詢的資源。
- */
- public function execute($queryParams = ')
- {
- //例如: SELECT * FROM table WHERE name=:1S AND type=:2I AND level=:3N
- $args = func_get_args();
- if ($this->stored_procedure) {
- /*調用compile函數以得到查詢*/
- $query = call_user_func_array(array($this, 'compile'), $args);
- } else {
- /*一個存儲過程沒被初始化,因此,作為一種標準查詢來執行之*/
- $query = $queryParams;
- }
- $result = $this->db->query($query);
- if (! $result) {
- throw new QueryException($this);
- }
- $this->result = $result;
- /* 注意現在我們怎么返回對象本身,這使我們能夠從這個函數的返回結果中調用成員函數
- */
- return $this;
- }
四、 使用繼承拋出定制異常
在PHP中,你可以拋出任何對象作為一個PHP異常;但是,首先該異常應該繼承自PHP的內置異常類。通過創建你自己的定制異常,你可以記錄其它有關于該錯誤的信息,例如在一個日志文件中創建一個入口,或做你喜歡做的任何事情。你的定制異常將要做如下幾件事情:
◆記錄由查詢產生的來自DB對象的錯誤消息。
◆給出查詢錯誤發生所在行代碼的準確細節—通過檢查調用棧。
◆顯示錯誤消息和查詢文本—當被轉換成一個字符串時。
為了得到錯誤信息和查詢文本,需要對DBQuery對象作多處更改。
1. 一個新的protected屬性—compiledQuery—需要被添加到類中。
2. compile()函數使用查詢文本更新查詢compiledQuery屬性。
3. 應該加入一個檢索編譯的查詢文本的函數。
4. 還應該加入一個函數—它得到當前的與DBQuery對象相關聯的DB對象。
列表4.拋出一個PHP異常。
- class DBQuery
- {
- /**
- *在調用compile()或execute()之后存儲查詢的編譯版本
- *
- * @var string $compiledQuery
- */
- protected $compiledQuery;
- /**
- * 返回編譯的查詢而不執行它。
- * @參數:mixed $params,...查詢參數
- * @返回:字符串—編譯的查詢
- */
- public function compile($params=')
- {
- if (! $this->stored_procedure) {
- throw new Exception("存儲過程沒被初始化.");
- }
- /*代替參數*/
- $params = func_get_args(); //得到函數參數
- $query = preg_replace("/(?compile_callback($params, 1, "2")', $this->query);
- return ($this->compiledQuery = $this->add_strings($query)); //把字符串放回查詢中
- }
- public function getDB()
- {
- return $this->db;
- }
- public function getCompiledQuery()
- {
- return $this->compiledQuery;
- }
- }
現在,你可以實現QueryException類。注意你是如何遍歷調用棧以在腳本中查找實際導致錯誤的位置的。這正好適用于當拋出異常的DBQuery對象是一個繼承自DBQuery對象的子類的情況。
列表5:QueryException類。
- /**
- *查詢異常
- *
- *當試圖執行一個查詢時,如果一個錯誤發生,將由{@link DBQuery}對象拋出錯誤
- */
- class QueryException extends Exception
- {
- /**
- * 查詢文本
- *
- * @var字符串$QueryText;
- */
- protected $QueryText;
- /**
- *來自數據庫的錯誤號/代碼
- *
- * @var字符串$ErrorCode
- */
- protected $ErrorNumber;
- /**
- *來自數據庫的錯誤消息
- *
- * @var字符串$ErrorMessage
- */
- protected $ErrorMessage;
- /**
- *類構造器
- *
- * @參數:DBQuery $db,是拋出異常的查詢對象
- */
- public function __construct(DBQuery $query)
- {
- /*得到調用棧*/
- $backtrace = $this->GetTrace();
- /*把行和文件設置到錯誤實際發生的位置*/
- if (count($backtrace) > 0) {
- $x = 1;
- /*如果查詢類被繼承,那么我們需要忽略由子類所進行的調用*/
- 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 ) {
- /*循環執行,只要沒有行號或調用的函數是DBQuery類的一個子類*/
- ++$x;
- /*如果我們到達棧底,那么我們使用***個調用者*/
- if (($x) >= count($backtrace)) {
- $x = count($backtrace);
- break;
- }
- }
- /*如果上面的循環至少執行一次,那么我們可以把它減1以查找實際的引起錯誤的代碼行
- */
- if ($x != 1) {
- $x -= 1;
- }
- /****,我們可以設置文件和行號,這應該可以反映出引起錯誤的SQL語句*/
- $this->line = $backtrace[$x]['line'];
- $this->file = $backtrace[$x]['file'];
- }
- $this->QueryText = $query->getCompiledQuery();
- $this->ErrorNumber = $query->getDB()->errno();
- $this->ErrorMessage = $query->getDB()->error();
- /*調用超類的異常構造器*/
- parent::__construct('Query Error', 0);
- }
- /**
- *得到查詢文本
- *
- * @返回字符串查詢文本
- */
- public function GetQueryText()
- {
- return $this->QueryText;
- }
- /**
- *得到錯誤號
- *
- * @返回字符串錯誤號
- */
- public function GetErrorNumber()
- {
- return $this->ErrorNumber;
- }
- /**
- *得到錯誤消息
- *
- * @返回字符串錯誤消息
- */
- public function GetErrorMessage()
- {
- return $this->ErrorMessage;
- }
- /**
- *當對象被轉換為一個字符串時調用。
- * @返回字符串
- */
- 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;
- }
- }
至此,在本節開始看到的代碼可以工作了。
五、 結論
在本文中,你看到了PHP代理是怎樣把與查詢相聯系的DB接口映射到針對一個特定的查詢結果上的操作。DBQuery對象暴露相同的函數,例如fetch_assoc(),作為DB對象。然而,這些都是針對單個查詢起作用。你還學習了如何使用定制異常來給出詳細信息—一個錯誤發生在何時何地,以及它們怎樣更好地控制錯誤的處理。
【編輯推薦】