【什麼是MVC? 】
MVC是一個可以讓你把「三個部分(即MVC的全稱,Model、View、Controller)」調諧地組成一個複雜應用程式的概念。一輛車就是一個在現實生活中非常好的MVC例子。我們看車子都看兩個View(顯示)部分:內部和外部。而這兩個都離不開一個Controller(控制者):司機。煞車系統、方向盤和其他操控系統代表了Model(模型):他們從司機(Controller)取得控制方法然後應用到內部和外觀(View)。
【網路上的MVC】
MVC框架所涵蓋的概念相當簡單且極度靈活。基本的概念就是,你有一個單獨的控制器(如index.php)用來控制所有建立在參數請求基礎上的框架內應用程式。這個控制器通常包含了(最小程度上)一個定義模型的參數、一個事件和一個GET參數。這樣控制器就能確認所有的請求然後執行對應的事件。打個比方來說,一個像這樣/index.php?module=foo&event=bar的請求很有可能就是用來載入一個名叫foo的類,然後執行foo::bar()[就是其中的bar( )函數]。這樣做的好處有:
一個對應所有應用程式的介面
同時維護一個應用程式內無數的程式碼非常麻煩,因為每一段程式碼都有自己的相對路徑、資料庫連結、驗證等等。而這樣做就免除你在這方面的煩惱,允許你合併並重複使用代碼
【為什麼要創建作者自己的MVC框架? 】
到目前為止,我沒有見過太多用PHP寫的MVC框架。事實上我只是知道一個-Solar,是完全用PHP5寫的。另外一個是Cake,一個試圖成為PHP的RoR(Ruby on Rails-一個Ruby語言開源網路框架)。我自己對這兩個框架都有一些不滿意的地方:它們都沒有利用到PEAR,Smarty等所包含的現有代碼;現在的Cake還比較紊亂;最後,Solar是一個絕大部分由一個人寫的作品(我無意說其作者Paul不是一個好人或好程式設計師)。這些問題可能不會讓你否認它們,而且很有可能你根本不關心這些問題。但正因為如此,我請各位盡可能地審視它們。
【老方式】
如果回到2001看自己寫的程式碼,作者有可能找到一個叫template.txt的文件,它看起來像這樣: www.phpv.net轉載請註明出處
<?php
require_once('config.php'); // Other requires, DB info, etc.
$APP_DB = 'mydb';
$APP_REQUIRE_LOGIN = false; // Set to true if script requires login
$APP_TEMPLATE_FILE = 'foo.php'; // Smarty template
$APP_TITLE = 'My Application';
if ($APP_REQUIRE_LOGIN == true) {
if (!isset($_SESSION['userID'])) {
header("Location: /path/to/login.php");
exit();
}
}
$db = DB::connect('mysql://'.$DB_USER.':'.$DB_PASS.'@localhost/'.$APP_DB);
if (!PEAR::isError($db)) {
$db->setFetchMode(DB_FETCHMODE_ASSOC);
} else {
die($db->getMessage());
}
// Put your logic here
// Output the template
include_once(APP_TEMPLATE_PATH.'/header.php');
include_once(APP_TEMPLATE_PATH.'/'.$APP_TEMPLATE_FILE);
include_once(APP_TEMPLATE_PATH.'/footer.php');
?>
天哪,只是看這些代碼都會讓我有退縮的慾望。這段程式碼的概念就是確保每一個應用程式都能適用於這個處理方法,例如我可以簡單地將template.txt拷貝myapp.php,改變一些變量,瞧,它就能運行起來了。儘管如此,這個組織嚴密的處理方法存在一些嚴重的缺點:
如果我的老闆想讓作者用myapp.php在某些情況下輸出PDF、某些情況下輸出HTML、某些情況下(直接提交的XML請求)SOAP ,我該怎麼辦?
如果這個應用程式需要IMAP或LDAP驗證,我該怎麼辦?
我該如何處理各種不同的程式碼(包括編輯、升級和刪除)?
我該如何處理多層驗證(管理員vs. 非管理員)?
我該如何啟用輸出快取? www.phpv.net轉載請註明出處
【新方式】
將所有東西都丟進這個MVC框架,你會發現生活是如此簡單。請比較以下程式碼:
<?php
class myapp extends FR_Auth_User
{
public function __construct()
{
parent::__construct();
}
public function __default()
{
// Do something here
}
public function delete()
{ }
public function __destruct()
{
parent::__destruct();
}
}
?>
注意這段程式碼顯然不是用來連結到一個資料庫、判斷一個使用者是否已經登陸、或輸出任何其他資訊。控制器掌握了所有的一切。
如果我想驗證LDAP,我可以建立FR_Auth_LDAP。控制器可以辨識某些輸出方法(例如$_GET['output'])並且可以隨時轉換成PDF或SOAP。事件處理delete,只負責刪除,其他的它都不管。因為這個模組擁有一個FR_User類別的實例,它可以簡單地判斷一個使用者是否已經登陸等等。 Smarty,作為模板引擎控制快取是理所當然的,但是控制器同樣可以控制一部分快取。
從前面講的老方式到MVC方式對於很多人來講可能是一個全新、陌生的概念,但是一旦你轉換到了這樣一個概念,那麼要轉回去將是件相當困難的事情。
【建立底層】
我是一個PEAR尤其是PEAR_Error類別的愛好者。 PHP5引進了一個新的內建類別「Exception」?取代了PEAR_Error。但是PEAR_Error擁有一些比Exception還要實用的特性。所以,在此系列文章中的MVC框架實例將會用到它來做錯誤處理。無論如何,我還是要用到Exception獲得從建構器中的錯誤,因為它們本身不能傳回錯誤。
設計這些基礎類別的目的有以下幾點:
利用PEAR快速添加功能到基礎類別
建立小巧、可反覆實用的抽象類別以便讓用戶在此框架中快速開發出應用程式
用phpDocumentor給所有的基礎類別生成文檔
類別的層次看起來會像這樣:
-FR_Object將會提供基礎的功能以供其他所有物件使用(包括logging,一般的setFrom(),toArray())
-FR_Object_DB是一個小層面,給子類別提供資料庫鏈接等功能
-FR_Module是所有應用(又稱模組、模型等等)的底層類
-FR_Auth是所有驗證機制的底層類
·FR_Auth_User是一個驗證類,用來驗證所有需要驗證用戶是否登陸的模組
·FR_Auth_No是所有不需要驗證的模組的「假驗證類別」
-FR_Presenter是所有用來處理載入和顯示應用程式的底層類別
-FR_Presenter_Smarty是包含了載入不同磁碟機能力的顯示層。 Smarty是一個非常好的模板類,它擁有內建的快取機制以及一個活躍的開發團體(譯者註:這分明就是打廣告嘛~)
·FR_Presenter_debug是調試部分的顯示層。依靠它,開發者能夠調試應用程式並給他們調試
·FR_Presenter_rest是一個可以讓開發者能夠以XML方式輸出應用程式的REST顯示層
從以上的基礎類結構上,你應該可以看到這個MVC框架的不同部分。 FR_Module提供所有模組所需的東西,而FR_Presenter則提供不同的顯示方法。在此系列文章中的下一篇中,我將建立控制器將這上面所有的基礎類別結合在一塊。
【程式碼標準】
在你正式寫程式之前,應該先坐下來跟你的合夥人(或你自己)好好討論(或思考)一下程式碼標準。 MVC程式設計的整體想法圍繞著兩點:程式碼的可再利用性(減少偶聯)和程式碼的標準化。我推薦至少應該考慮到以下幾點:
首先要考慮的是變數命名和縮寫標準。不要因為這個跟你的合作夥伴大吵一通,但是一旦定下來的標準,就要自始至終地遵從,尤其是寫底層程式碼(基礎類別)的時候。
客製化一個標準前綴,用在所有的函數、類別和全域變數上。不走運的是,PHP不支援「namespace(命名空間)」。所以要避免混淆變數名和發生的衝突,用一個前綴是個明智的做法。我在整篇文章中將使用“FR_”作為這樣的前綴。
【編寫底層】
文件層次規劃很重要。基本的層級規劃很簡單且在某種程度上是嚴格定義的:
/
config.php
index.php
includes/
Auth.php
Auth/
No.php
User.php
Module.php
Object.php
Object/
DB.php
Presenter.php
Presenter/
common.php
debug.php
smarty.php
Smarty/
modules/
example/
config.php
example.php
tpl/
example.tpl
tpl/
default/
cache/
config/
templates/
templates_c/
你可能會想這樣的檔案層次肯定代表了很多的程式碼!沒錯,但是你能夠完成它的。在整個系列結束後,你會發現你的程式設計將會變得更簡單並且開發速度會得到很大的提升。
在檔案層級裡面,所有的基礎類別都在includes資料夾內。每一個功能模組,都用一個配置文件,至少一個模組文件和一個模板文件。所有的模組包含在modules資料夾內。我已經習慣了將模板檔案放在單獨的外部資料夾內,也就是tpl資料夾。
config.php-中樞設定文件,包含所有的全域設定變數。
index.php-控制器,在接下來的一篇文章中會詳細敘述。
object.php-所有基礎類的底層類,提供絕大部分類別所需的功能。 FR_Object_DB繼承這個類別並提供資料庫連結。
結構的基本概念就是,讓所有的子類別都繼承一個中樞類別以便它們都共享一些共同的特性。你完全可以把連結資料庫的功能放進FR_Object,但是並不是所有類別都需要這個功能的,所以FR_Object_DB就有了存在的理由,作者會稍後做出討論它。
<?php
require_once('Log.php');
/**
* FR_Object
*
* The base object class for most of the classes that we use in our framework.
* Provides basic logging and set/get functionality.
*
* @author Joe Stump < [email protected] >
* @package Framework
*/
abstract class FR_Object
{
/**
* $log
*
* @var mixed $log Instance of PEAR Log
*/
protected $log;
/**
* $me
*
* @var mixed $me Instance of ReflectionClass
*/
protected $me;
/**
* __construct
*
* @author Joe Stump < [email protected] >
* @access public
*/
public function __construct()
{
$this->log = Log::factory('file',FR_LOG_FILE);
$this->me = new ReflectionClass($this);
}
/**
* setFrom
*
* @author Joe Stump < [email protected] >
* @access public
* @param mixed $data Array of variables to assign to instance
* @return void
*/
public function setFrom($data)
{
if (is_array($data) && count($data)) {
$valid = get_class_vars(get_class($this));
foreach ($valid as $var => $val) {
if (isset($data[$var])) {
$this->$var = $data[$var];
}
}
}
}
/**
* toArray
*
* @author Joe Stump < [email protected] >
* @access public
* @return mixed Array of member variables keyed by variable name
*/
public function toArray()
{
$defaults = $this->me->getDefaultProperties();
$return = array();
foreach ($defaults as $var => $val) {
if ($this->$var instanceof FR_Object) {
$return[$var] = $this->$var->toArray();
} else {
$return[$var] = $this->$var;
}
}
return $return;
}
/**
* __destruct
*
* @author Joe Stump < [email protected] >
* @access public
* @return void
*/
public function __destruct()
{
if ($this->log instanceof Log) {
$this->log->close();
}
}
}
?>
auth.php-這是所有驗證功能的底層類別。它是從FR_Module裡面延伸出來的,主要功能是定義一個基本的驗證類別如何運作。
跟FR_Module的道理一樣,有些類別不需要連結到資料庫,那麼同理,FR_Auth_No就可以被創建應用到不需要驗證功能的類別上。
<?php
abstract class FR_Auth extends FR_Module
{
// {{{ __construct()
function __construct()
{
parent::__construct();
}
// }}}
// {{{ authenticate()
abstract function authenticate();
// }}}
// {{{ __destruct()
function __destruct()
{
parent::__destruct();
}
// }}}
}
?>
module.php-所有模組的心
<?php
abstract class FR_Module extends FR_Object_Web
{
// {{{ properties
/**
* $presenter
*
* Used in FR_Presenter::factory() to determine which presentation (view)
* class should be used for the module.
*
* @author Joe Stump < [email protected] >
* @var string $presenter
* @see FR_Presenter, FR_Presenter_common, FR_Presenter_smarty
*/
public $presenter = 'smarty';
/**
* $data
*
* Data set by the module that will eventually be passed to the view.
*
* @author Joe Stump < [email protected] >
* @var mixed $data Module data
* @see FR_Module::set(), FR_Module::getData()
*/
protected $data = array();
/**
* $name
*
* @author Joe Stump < [email protected] >
* @var string $name Name of module class
*/
public $name;
/**
* $tplFile
*
* @author Joe Stump < [email protected] >
* @var string $tplFile Name of template file
* @see FR_Presenter_smarty
*/
public $tplFile;
/**
* $moduleName
*
* @author Joe Stump < [email protected] >
* @var string $moduleName Name of requested module
* @see FR_Presenter_smarty
*/
public $moduleName = null;
/**
* $pageTemplateFile
*
* @author Joe Stump < [email protected] >
* @var string $pageTemplateFile Name of outer page template
*/
public $pageTemplateFile = null;
// }}}
// {{{ __construct()
/**
* __construct
*
* @author Joe Stump < [email protected] >
*/
public function __construct()
{
parent::__construct();
$this->name = $this->me->getName();
$this->tplFile = $this->name.'.tpl';
}
// }}}
// {{{ __default()
/**
* __default
*
* This function is ran by the controller if an event is not specified
* in the user's request.
*
* @author Joe Stump < [email protected] >
*/
abstract public function __default();
// }}}
// {{{ set($var,$val)
/**
* set
*
* Set data for your module. This will eventually be passed toe the
* presenter class via FR_Module::getData().
*
* @author Joe Stump < [email protected] >
* @param string $var Name of variable
* @param mixed $val Value of variable
* @return void
* @see FR_Module::getData()
*/
protected function set($var,$val) {
$this->data[$var] = $val;
}
// }}}
// {{{ getData()
/**
* getData
*
* Returns module's data.
*
* @author Joe Stump < [email protected] >
* @return mixed
* @see FR_Presenter_common
*/
public function getData()
{
return $this->data;
}
// }}}
// {{{ isValid($module)
/**
* isValid
*
* Determines if $module is a valid framework module. This is used by
* the controller to determine if the module fits into our framework's
* mold. If it extends from both FR_Module and FR_Auth then it should be
* good to run.
*
* @author Joe Stump < [email protected] >
* @static
* @param mixed $module
* @return bool
*/
public static function isValid($module)
{
return (is_object($module) &&
$module instanceof FR_Module &&
$module instanceof FR_Auth);
}
// }}}
// {{{ __destruct()
public function __destruct()
{
parent::__destruct();
}
// }}}
}
?>
presenter.php-表述層的核心。
<?php
class FR_Presenter
{
// {{{ factory($type,FR_Module $module)
/**
* factory
*
* @author Joe Stump < [email protected] >
* @access public
* @param string $type Presentation type (our view)
* @param mixed $module Our module, which the presenter will display
* @return mixed PEAR_Error on failure or a valid presenter
* @static
*/
static public function factory($type,FR_Module $module)
{
$file = FR_BASE_PATH.'/includes/Presenter/'.$type.'.php';
if (include($file)) {
$class = 'FR_Presenter_'.$type;
if (class_exists($class)) {
$presenter = new $class($module);
if ($presenter instanceof FR_Presenter_common) {
return $presenter;
}
return PEAR::raiseError('Invalid presentation class: '.$type);
}
return PEAR::raiseError('Presentation class not found: '.$type);
}
return PEAR::raiseError('Presenter file not found: '.$type);
}
// }}}
}
?>
下一篇裡,我將介紹控制器(MVC中的Controller,本文的index.php)的建構。第三篇裡,我將介紹表達層(MVC裡面的View)。第四篇裡,我將用具體模組為例建立一個應用程式(MVC裡面的Module或Model)。