一、 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類型的例外。當被轉換成一個字串時,它將傳回發生的錯誤的細節訊息。
為此,你需要使用代理。事實上,你在我們的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對象,返回它的結果好像它是查詢對象本身(稱作是基本資料庫函數)一樣。
二、 類型提示(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中的另一個新特徵,當與OOP聯用時,它能夠實現良好地控制錯誤處理和報告。一個try..catch區塊是一種處理異常的重要機制。一旦被捕獲,腳本將會從異常被捕獲和處理的程式碼的下一行繼續執行。
如果查詢失敗,你需要改變你的execute函數以拋出一個例外。你將拋出一個稱為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的內建異常類別。透過創建你自己的定制異常,你可以記錄其它有關於該錯誤的信息,例如在一個日誌文件中創建一個入口,或做你喜歡做的任何事情。你的自訂異常將要做如下幾件事:
· 記錄由查詢產生的來自DB物件的錯誤訊息。
· 給予查詢錯誤發生所在行程式碼的準確細節—透過檢查呼叫堆疊。
· 顯示錯誤訊息和查詢文字—當轉換成一個字串時。
為了得到錯誤訊息和查詢文本,需要對DBQuery物件作多處更改。
1. 一個新的protected屬性—compiledQuery—需要被加入到類別中。
2. compile()函數使用查詢文字更新查詢compiledQuery屬性。
3. 應該加入一個檢索編譯的查詢文字的函數。
4. 也應該加入一個函數—它會得到目前的與DBQuery物件相關聯的DB物件。
列表4.拋出一個異常。
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;
}
}
至此,在本節開始看到的程式碼可以運作了。
五、 結論
在本文中,你看到了代理程式是怎樣把與查詢相聯繫的DB介面映射到針對一個特定的查詢結果上的操作。 DBQuery物件暴露相同的函數,例如fetch_assoc(),作為DB物件。然而,這些都是針對單一查詢起作用。你也學習如何使用客製化異常來給予詳細資訊—一個錯誤發生在何時何地,以及它們如何更好地控制錯誤的處理。