【什麼是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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @access public
*/
public function __construct()
{
$this->log = Log::factory('file',FR_LOG_FILE);
$this->me = new ReflectionClass($this);
}
/**
* setFrom
*
* @author Joe Stump <joe@joestump.net>
* @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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @var mixed $data Module data
* @see FR_Module::set(), FR_Module::getData()
*/
protected $data = array();
/**
* $name
*
* @author Joe Stump <joe@joestump.net>
* @var string $name Name of module class
*/
public $name;
/**
* $tplFile
*
* @author Joe Stump <joe@joestump.net>
* @var string $tplFile Name of template file
* @see FR_Presenter_smarty
*/
public $tplFile;
/**
* $moduleName
*
* @author Joe Stump <joe@joestump.net>
* @var string $moduleName Name of requested module
* @see FR_Presenter_smarty
*/
public $moduleName = null;
/**
* $pageTemplateFile
*
* @author Joe Stump <joe@joestump.net>
* @var string $pageTemplateFile Name of outer page template
*/
public $pageTemplateFile = null;
// }}}
// {{{ __construct()
/**
* __construct
*
* @author Joe Stump <joe@joestump.net>
*/
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 <joe@joestump.net>
*/
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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @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 <joe@joestump.net>
* @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)。