1 什麼是MVC
MVC模式 (Model-View-Controller)是軟體工程中的一種軟體架構模式,把軟體系統分為三個基本部分:模型(Model)、視圖(View)和控制器(Controller)。
MVC模式的目的是實現一種動態程式設計,使後續對程式的修改和擴充簡化,並且使程式某一部分的重複利用成為可能。除此之外,此模式通過對複雜度的簡化,使程式結構更加直觀。軟體系統通過對自身基本部份分離的同時也賦予了各個基本部分應有的功能。
簡而言之,
- 模型Model – 管理所有 資料庫 相關的邏輯。模型提供了串連和操作資料庫的抽象層。
- 控制器Controller - 負責所有的 商務邏輯 ,比如 if/else 邏輯。
- 視圖View – 負責介面顯示,如HMTL/XML/JSON顯示。
2 為什麼要自己開發MVC架構
網路上有大量優秀的MVC架構可供使用,本教程並不是為了開發一個全面的、終極的MVC架構解決方案,而是將它看作是一個很好的從內部學習PHP的機會,在此過程中,你將學習 物件導向編程 和 MVC設計模式 ,並學習到開發中的一些注意事項。
更重要的是,你可以完全控制你的架構,並將你的想法融入到你開發的架構中。雖然不一定是做好的,但是你可以按照你的方式去開發功能和模組。
3 開始開發自己的MVC架構
3.1 目錄準備
在開始開發前,讓我們先來把項目建立好,假設我們建立的項目為 todo,MVC的架構可以命名為 FastPHP,那麼接下來的第一步就是把目錄結構先設定好。
雖然在這個教程中不會使用到上面的所有的目錄,但是為了以後程式的可拓展性,在一開始就把程式目錄設定好使非常必要的。下面就具體說說每個目錄的作用:
- application – 應用代碼
- config – 程式配置或資料庫配置
- fastphp - 架構核心目錄
- public – 靜態檔案
- runtime - 臨時資料目錄
- scripts – 命令列工具
3.2 代碼規範
在目錄設定好以後,我們接下來就要來規定一下代碼的規範:
- MySQL的表名需 小寫 ,如:item,car
- 模組名(Models)需 首字母大寫 ,,並在名稱後添加“Model”,如:ItemModel,CarModel
- 控制器(Controllers)需 首字母大寫 ,,並在名稱中添加“Controller”,如:ItemsController,CarsController
- 視圖(Views)部署結構為“控制器名/行為名”,如:item/view.php,car/buy.php
上述的一些規則是為了能在程式中更好的進行互相的調用。接下來就開始真正的PHP MVC編程了。
3.3 重新導向
將所有的資料請求都重新導向 index.php 檔案,在 todo 目錄下建立一個 .htaccess 檔案,檔案內容為:
RewriteEngine On # 確保請求路徑不是一個檔案名稱或目錄 RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d # 重新導向所有請求到 index.php?url=PATHNAME RewriteRule ^(.*)$ index.php?url=$1 [PT,L]
這樣做的主要原因有:
- 程式有一個單一的入口;
- 除靜態程式,其他所有程式都重新導向到 index.php 上;
- 可以用來產生利於SEO的URL,想要更好的配置URL,後期可能會需要URL路由,這裡先不做介紹了。
3.4 入口檔案
做完上面的操作,就應該知道我們需要做什麼了,沒錯!在 public 目錄下添加 index.php 檔案,檔案內容為:
注意,上面的PHP代碼中,並沒有添加PHP結束符號”?>”,這麼做的主要原因是, 對於只有 PHP 代碼的檔案,結束標誌(“?>”)最好不存在,PHP自身並不需要結束符號,不添加結束符號可以很大程度上防止末尾被添加額外的注入內容,讓程式更加安全。
3.5 設定檔和主請求
在 index.php 中,我們對 fastphp 檔案夾下的 FastPHP.php 發起了請求,那麼 FastPHP.php 這個開機檔案中到底會包含哪些內容呢?
run();
以上檔案都其實可以直接在 index.php 檔案中包含,常量也可以直接在 index.php 中定義,我們這麼做的原因是為了在後期管理和拓展中更加的方便,所以把需要在一開始的時候就載入啟動並執行程式統一放到一個單獨的檔案中引用。
先來看看config檔案下的 config .php 檔案,該檔案的主要作用是設定一些程式的配置項及資料庫連接等,主要內容為:
應該說 config.php 涉及到的內容並不多,不過是一些 基礎資料庫 的設定,再來看看 fastphp下的共用架構入口檔案 Core.php 應該怎麼寫。
setReporting(); $this->removeMagicQuotes(); $this->unregisterGlobals(); $this->callHook(); } // 主要求方法,主要目的是拆分URL請求 function callHook() { if (!empty($_GET['url'])){ $url = $_GET['url']; $urlArray = explode("/",$url); // 擷取控制器名 $controllerName = ucfirst(empty($urlArray[0]) ? 'Index' : $urlArray[0]); $controller = $controllerName . 'Controller'; // 擷取動作名 array_shift($urlArray); $action = empty($urlArray[0]) ? 'index' : $urlArray[0]; //擷取URL參數 array_shift($urlArray); $queryString = empty($urlArray) ? array() : $urlArray; } // 資料為空白的處理 $action = empty($action) ? 'index' : $action; $queryString = empty($queryString) ? array() : $queryString; // 執行個體化控制器 $int = new $controller($controllerName, $action); // 如果控制器存和動作存在,這調用並傳入URL參數 if ((int)method_exists($controller, $action)) { call_user_func_array(array($int, $action), $queryString); } else { exit($controller . "控制器不存在"); } } // 檢測開發環境 function setReporting() { if (APP_DEBUG == true) { error_reporting(E_ALL); ini_set('display_errors','On'); } else { error_reporting(E_ALL); ini_set('display_errors','Off'); ini_set('log_errors', 'On'); ini_set('error_log', RUNTIME_PATH. 'logs/error.log'); } } // 刪除敏感字元 function stripSlashesDeep($value) { $value = is_array($value) ? array_map('stripSlashesDeep', $value) : stripslashes($value); return $value; } // 檢測敏感字元並刪除 function removeMagicQuotes() { if ( get_magic_quotes_gpc() ) { $_GET = stripSlashesDeep($_GET ); $_POST = stripSlashesDeep($_POST ); $_COOKIE = stripSlashesDeep($_COOKIE); $_SESSION = stripSlashesDeep($_SESSION); } } // 檢測自訂全域變數(register globals)並移除 function unregisterGlobals() { if (ini_get('register_globals')) { $array = array('_SESSION', '_POST', '_GET', '_COOKIE', '_REQUEST', '_SERVER', '_ENV', '_FILES'); foreach ($array as $value) { foreach ($GLOBALS[$value] as $key => $var) { if ($var === $GLOBALS[$key]) { unset($GLOBALS[$key]); } } } } } //自動載入控制器和模型類 static function loadClass($class) { $frameworks = ROOT . $class . EXT; $controllers = APP_PATH . 'application/controllers/' . $class . EXT; $models = APP_PATH . 'application/models/' . $class . EXT; if (file_exists($frameworks)) { // 載入架構核心類 include $frameworks; } elseif (file_exists($controllers)) { // 載入應用控制器類 include $controllers; } elseif (file_exists($models)) { //載入應用程式模型類 include $models; } else { /* 錯誤碼 */ } }}
下面重點講解主要求方法 callHook(),首先我們想看看我們的 URL 會這樣:
yoursite.com/controllerName/actionName/queryString
callHook()的作用就是,從全域變數 $_GET['url']變數中擷取 URL,並將其分割成三部分:$controller、$action 和 $queryString。
例如,URL連結為: todo.com/item/view/1/first-item ,那麼
- $controller 就是: items
- $action 就是: view
- 查詢字串Query String就是: array(1, first-item)
分割完成後,會執行個體化一個新的控制器: $controller.'Controller' (其中“.”是連字號),並調用其方法 $action。
3.6 控制器/Controller基類
接下來的操作就是在 fastphp 中建立程式所需的基類,包括 控制器 、 模型 和 視圖 的基類。
建立控制器基類為 Controller.class.php ,控制器的主要功能就是總調度,具體具體內容如下:
_controller = $controller; $this->_action = $action; $this->_view = new View($controller, $action); } function set($name, $value) { $this->_view->set($name, $value); } function __destruct() { $this->_view->render(); } }
Controller 類實現所有控制器、模型和視圖(View類)的通訊。在執行解構函式時,我們可以調用 render() 來顯示視圖(view)檔案。
3.7 模型Model基類
建立模型基類為 Model.class.php ,模型基類 Model.class.php 代碼如下:
connect(DB_HOST,DB_USER,DB_PASSWORD,DB_NAME); // 轉換模型+Model為模型名稱 // 擷取對象所屬類的名稱 $this->_model = get_class($this); $this->_model = rtrim($this->_model, 'Model'); // 資料庫表名與類名一致 $this->_table = strtolower($this->_model); } function __destruct() { }}
考慮到模型需要對 資料庫 進行處理,所以單獨建立一個資料庫基類 Sql.class.php ,模型基類繼承 Sql.class.php,代碼如下:
_dbHandle = @mysql_connect($address, $account, $pwd); if ($this->_dbHandle != 0) { if (mysql_select_db($name, $this->_dbHandle)) { return 1; } else { return 0; } } else { return 0; } } /** 從資料庫斷開 **/ function disconnect() { if (@mysql_close($this->_dbHandle) != 0) { return 1; } else { return 0; } } /** 查詢所有 **/ function selectAll() { $query = 'select * from `'.$this->_table.'`'; return $this->query($query); } /** 根據條件 (id) 查詢 **/ function select($id) { $query = 'select * from `'.$this->_table.'` where `id` = \''.mysql_real_escape_string($id).'\''; return $this->query($query, 1); } /** 根據條件 (id) 刪除 **/ function delete($id) { $query = 'delete from `'.$this->_table.'` where `id` = \''.mysql_real_escape_string($id).'\''; return $this->query($query); } /** 自訂SQL查詢 **/ function query($query, $singleResult = 0) { $this->_result = mysql_query($query, $this->_dbHandle); if (preg_match("/select/i",$query)) { $result = array(); $table = array(); $field = array(); $tempResults = array(); $numOfFields = mysql_num_fields($this->_result); for ($i = 0; $i < $numOfFields; ++$i) { array_push($table,mysql_field_table($this->_result, $i)); array_push($field,mysql_field_name($this->_result, $i)); } while ($row = mysql_fetch_row($this->_result)) { for ($i = 0;$i < $numOfFields; ++$i) { $table[$i] = ucfirst($table[$i]); $tempResults[$table[$i]][$field[$i]] = $row[$i]; } if ($singleResult == 1) { mysql_free_result($this->_result); return $tempResults; } array_push($result,$tempResults); } mysql_free_result($this->_result); return($result); } } /** 擷取記錄數 **/ function getNumRows() { return mysql_num_rows($this->_result); } /** 釋放查詢資源 **/ function freeResult() { mysql_free_result($this->_result); } /** 擷取錯誤資訊 **/ function getError() { return mysql_error($this->_dbHandle); } }
應該說, Sql.class.php 是架構的核心部分 。為什嗎?因為通過它,我們建立了一個 SQL 抽象層,可以大大減少了資料庫的編程工作。connect() 和 disconnect() 方法比較簡單,不多做說明,重點講講 Query查詢。假設我們有如下的一段 SQL 查詢語句:
SELECT table1.field1, table1.field2, table2.field3, table2.field4 FROM table1,table2 WHERE …
如果使用上面的 SQL 基類,首先要做的工作是選出要輸出的欄位以及相對應的資料表,然後把它們放到數組中,其中,$field 和 $table 使用相同的索引值。在上面的例子中,它們是這樣的:
$field = array(field1,field2,field3,field4);$table = array(table1,table1,table2,table2);
指令碼會展開所有的資料行,並將資料錶轉換成一個模型名(如去除複數和首字母大寫)。查詢結果最終儲存在一個多維陣列中,然後返回,格式類似於: $var['modelName']['fieldName'] 。這樣輸出方式可以非常便於在視圖中使用這些元素。
3.8 視圖View類
視圖類 View.class.php 內容如下:
_controller = $controller; $this->_action = $action; } /** 設定變數方法 **/ function set($name, $value) { $this->variables[$name] = $value; } /** 顯示 **/ function render() { extract($this->variables); $defaultHeader = APP_PATH . 'application/views/header.php'; $defaultFooter = APP_PATH . 'application/views/footer.php'; $controllerHeader = APP_PATH . 'application/views/' . $this->_controller . '/header.php'; $controllerFooter = APP_PATH . 'application/views/' . $this->_controller . '/footer.php'; // 頁標頭檔 if (file_exists($controllerHeader)) { include ($controllerHeader); } else { include ($defaultHeader); } // 頁內容檔案 include (APP_PATH . 'application/views/' . $this->_controller . '/' . $this->_action . '.php'); // 頁尾檔案 if (file_exists($controllerFooter)) { include ($controllerFooter); } else { include ($defaultFooter); } } }
這樣我們的核心的PHP MVC架構就編寫完成了,下面我們開始編寫應用來測試架構功能。
4 應用
4.1 資料庫部署
在 SQL 中建立一個 todo 資料庫,使用下面的語句增加 item 資料表並插入2條記錄:
CREATE TABLE `items` ( `id` int(11) NOT NULL auto_increment, `item_name` varchar(255) NOT NULL, PRIMARY KEY (`id`)); INSERT INTO `items` VALUES(1, 'Hello World.');INSERT INTO `items` VALUES(2, 'Lets go!');
4.2 部署模型
然後,我們還需要在 models 目錄中建立一個 ItemModel.php 模型,內容如下:
_table.'` (item_name) values (\''.mysql_real_escape_string($value).'\')'; return $this->query($query); } /** 新增資料 **/ function update($id, $value){ $query = 'update `'.$this->_table.'` set item_name = \''.mysql_real_escape_string($value).'\' where `id` = \''.mysql_real_escape_string($id).'\''; return $this->query($query); } }
模型內容為空白。因為 Item 模型繼承了 Model,所以它擁有 Model 的所有功能。
4.3 部署控制器
在 controllers 目錄下建立一個 ItemsController.php 控制器,內容如下:
set('title', '全部條目'); $this->set('todo', $item->query('select * from item')); } // 添加記錄,測試架構DB記錄建立(Create) function add() { $value = $_POST['value']; $item = new ItemModel; $this->set('title', '添加成功'); $this->set('todo', $item->add($value)); } // 查看記錄,測試架構DB記錄讀取(Read) function view($id = null,$name = null) { $item = new ItemModel; $this->set('title', '正在查看'. $name); $this->set('todo', $item->select($id)); } // 更新記錄,測試架構DB記錄更新(Update) function update() { $id = $_POST['id']; $value = $_POST['value']; $item = new ItemModel; $this->set('title', '修改成功'); $this->set('todo', $item->update($id, $value)); } // 刪除記錄,測試架構DB記錄刪除(Delete) function delete($id = null) { $item = new ItemModel; $this->set('title','刪除成功'); $this->set('todo',$item->delete($id)); } }
4.4 部署視圖
在 views 目錄下建立 header.php 和 footer.php 兩個頁頭頁尾模板,內容如下。
header.php ,內容:
<?php echo $title?>
footer.php ,內容:
然後,在 views/item 建立以下幾個視圖檔案。
index.php ,瀏覽資料庫內 item 表的所有記錄,內容:
/"> ---- ">刪除
add.php ,添加記錄,內容:
添加成功,點擊返回
view.php ,查看單條記錄,內容:
返回
update.php ,更改記錄,內容:
修改成功,點擊返回
delete.php ,刪除記錄,內容:
刪除成功,點擊返回
4.5 應用測試
這樣,在瀏覽器中訪問 todo 程式: http://localhost/todo/item/index/ ,就可以看到效果了。
以上代碼全部發布到了我的 github 上,代碼倉地址: https://github.com/yeszao/FastPHP ,歡迎複製、提交。
本文參考:
- http://anantgarg.com/2009/03/13/write-your-own-php-mvc-framework-part-1/