手把手編寫自己的 PHP MVC 框架例項教程

歪麥部落格發表於2016-04-26

PHPMVC框架

1 什麼是MVC

MVC模式（Model-View-Controller）是軟體工程中的一種軟體架構模式，把軟體系統分為三個基本部分：模型（Model）、檢視（View）和控制器（Controller）。

MVC模式的目的是實現一種動態的程式設計，使後續對程式的修改和擴充套件簡化，並且使程式某一部分的重複利用成為可能。除此之外，此模式通過對複雜度的簡化，使程式結構更加直觀。軟體系統通過對自身基本部份分離的同時也賦予了各個基本部分應有的功能。

簡而言之，

模型Model – 管理所有資料庫相關的邏輯。模型提供了連線和運算元據庫的抽象層。
控制器Controller - 負責所有的業務邏輯，比如 if/else 邏輯。
檢視View – 負責介面顯示，如HMTL/XML/JSON顯示。

PHP MVC教程

2 為什麼要自己開發MVC框架

網路上有大量優秀的MVC框架可供使用，本教程並不是為了開發一個全面的、終極的MVC框架解決方案，而是將它看作是一個很好的從內部學習PHP的機會，在此過程中，你將學習物件導向程式設計和MVC設計模式，並學習到開發中的一些注意事項。

更重要的是，你可以完全控制你的框架，並將你的想法融入到你開發的框架中。雖然不一定是做好的，但是你可以按照你的方式去開發功能和模組。

3 開始開發自己的MVC框架

3.1 目錄準備

在開始開發前，讓我們先來把專案建立好，假設我們建立的專案為 todo，MVC的框架可以命名為 FastPHP，那麼接下來的第一步就是把目錄結構先設定好。

PHP MVC簡單目錄

雖然在這個教程中不會使用到上面的所有的目錄，但是為了以後程式的可擴充性，在一開始就把程式目錄設定好使非常必要的。下面就具體說說每個目錄的作用：

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 檔案，檔案內容為：

<IfModule mod_rewrite.c>
    RewriteEngine On

    # 確保請求路徑不是一個檔名或目錄
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d

    # 重定向所有請求到 index.php?url=PATHNAME
    RewriteRule ^(.*)$ index.php?url=$1 [PT,L]
</IfModule>

這樣做的主要原因有：

程式有一個單一的入口；
除靜態程式，其他所有程式都重定向到 index.php 上；
可以用來生成利於SEO的URL，想要更好的配置URL，後期可能會需要URL路由，這裡先不做介紹了。

3.4 入口檔案

做完上面的操作，就應該知道我們需要做什麼了，沒錯！在 public 目錄下新增 index.php 檔案，檔案內容為：

<?php 

// 應用目錄為當前目錄
define('APP_PATH', __DIR__.'/');

// 開啟除錯模式
define('APP_DEBUG', true);

// 載入框架
require './fastphp/FastPHP.php';

注意，上面的PHP程式碼中，並沒有新增PHP結束符號”?>”，這麼做的主要原因是，對於只有 PHP 程式碼的檔案，結束標誌(“?>”)最好不存在，PHP自身並不需要結束符號，不新增結束符號可以很大程度上防止末尾被新增額外的注入內容，讓程式更加安全。

3.5 配置檔案和主請求

在 index.php 中，我們對 fastphp 資料夾下的 FastPHP.php 發起了請求，那麼 FastPHP.php 這個啟動檔案中到底會包含哪些內容呢？

<?php

// 初始化常量
defined('ROOT') or define('ROOT', __DIR__.'/');
defined('APP_PATH') or define('APP_PATH', dirname($_SERVER['SCRIPT_FILENAME']).'/');
defined('APP_DEBUG') or define('APP_DEBUG', false);
defined('CONFIG_PATH') or define('CONFIG_PATH', APP_PATH.'config/');
defined('RUNTIME_PATH') or define('RUNTIME_PATH', APP_PATH.'runtime/');

// 類副檔名
const EXT = '.class.php';

// 包含配置檔案
require APP_PATH . 'config/config.php';

// 包含核心框架類
require ROOT . 'Core.php';

// 例項化核心類
$fast = new Fast;
$fast->run();

以上檔案都其實可以直接在 index.php 檔案中包含，常量也可以直接在 index.php 中定義，我們這麼做的原因是為了在後期管理和擴充中更加的方便，所以把需要在一開始的時候就載入執行的程式統一放到一個單獨的檔案中引用。

先來看看config檔案下的 config .php 檔案，該檔案的主要作用是設定一些程式的配置項及資料庫連線等，主要內容為：

<?php

/** 變數配置 **/
define('DB_NAME', 'todo');
define('DB_USER', 'root');
define('DB_PASSWORD', 'root');
define('DB_HOST', 'localhost');

應該說 config.php 涉及到的內容並不多，不過是一些基礎資料庫的設定，再來看看 fastphp下的共用框架入口檔案 Core.php 應該怎麼寫。

<?php
/**
 * FastPHP核心框架
 */
class Fast {

    // 執行程式
    function run() {
        spl_autoload_register(array($this, 'loadClass'));
        $this->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，控制器的主要功能就是總排程，具體具體內容如下：

<?php 

/**
 * 控制器基類
 */
class Controller {

    protected $_controller;
    protected $_action;
    protected $_view;

    // 建構函式，初始化屬性，並例項化對應模型
    function __construct($controller, $action) {
        $this->_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 程式碼如下：

<?php
class Model extends Sql {
    protected $_model;
    protected $_table;

    function __construct() {

        // 連線資料庫
        $this->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，程式碼如下：

<?php 

class Sql {
    protected $_dbHandle;
    protected $_result;

    /** 連線資料庫 **/
    function connect($address, $account, $pwd, $name) {
        $this->_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 內容如下：

<?php
/**
 * 檢視基類
 */
class View {

    protected $variables = array();
    protected $_controller;
    protected $_action;

    function __construct($controller, $action) {
        $this->_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 模型，內容如下：

<?php

class ItemModel extends Model {  

    /** 新增資料 **/
    function add($value){ 
        $query = 'insert into `'.$this->_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 控制器，內容如下：

<?php

class ItemController extends Controller {

    // 首頁方法，測試框架自定義DB查詢
    function index() {
        $item = new ItemModel;
        $this->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，內容：

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php echo $title?></title>
    <style>
        .item {
            width:400px;
        }

        input {
            color:#222222;
            font-family:georgia,times;
            font-size:24px;
            font-weight:normal;
            line-height:1.2em;
            color:black;
        }

        a {
            color:#222222;
            font-family:georgia,times;
            font-size:24px;
            font-weight:normal;
            line-height:1.2em;
            color:black;
            text-decoration:none;
         }

        a:hover {
            background-color:#BCFC3D;
        }

        h1 {
            color:#000000;
            font-size:41px;
            letter-spacing:-2px;
            line-height:1em;
            font-family:helvetica,arial,sans-serif;
            border-bottom:1px dotted #cccccc;
        }

        h2 {
            color:#000000;
            font-size:34px;
            letter-spacing:-2px;
            line-height:1em;
            font-family:helvetica,arial,sans-serif;
        }
    </style>
</head>
<body>
    <h1><?php echo $title?></h1>

footer.php，內容：

</body>
</html>

然後，在 views/item 建立以下幾個檢視檔案。

index.php，瀏覽資料庫內 item 表的所有記錄，內容：

<form action="../item/add" method="post">
    <input type="text" value="I have to..." onclick="this.value=''" name="value">
    <input type="submit" value="新增">
</form>
<br/><br/>

<?php $number = 0?>

<?php foreach ($todo as $todoitem):?>
    <a class="big" href="../../item/view/<?php echo $todoitem['Item']['id']?>/<?php echo strtolower(str_replace(" ","-",$todoitem['Item']['item_name']))?>">
        <span class="item">
            <?php echo ++$number?>
            <?php echo $todoitem['Item']['item_name']?>
        </span>
    </a>
    ----
    <a class="big" href="../item/delete/<?php echo $todoitem['Item']['id']?>">刪除</a>
<br/>
<?php endforeach?>

add.php，新增記錄，內容：

<a class="big" href="../item/">新增成功，點選返回</a>

view.php，檢視單條記錄，內容：

<form action="../../../item/update" method="post">
    <input type="text" value="<?php echo $todo['Item']['item_name'] ?>" name="value">
    <input type="hidden" value="<?php echo $todo['Item']['id'] ?>" name="id">
    <input type="submit" value="修改">
</form>

<a class="big" href="../../../item/">返回</a>

update.php，更改記錄，內容：

<a class="big" href="../item/index/">修改成功，點選返回</a>

delete.php，刪除記錄，內容：

<a href="../../item/">刪除成功，點選返回</a>

4.5 應用測試

這樣，在瀏覽器中訪問 todo 程式：http://localhost/todo/item/index/，就可以看到效果了。

result

以上程式碼全部發布到了我的 github 上，程式碼倉地址：https://github.com/yeszao/FastPHP，歡迎克隆、提交。

PHP入門教程之編寫自己的PHP框架
2017-06-04
PHP框架
PHP框架Yii系列教程（一）：入門例項
2015-07-23
PHP框架
自己寫一個mvc框架吧（四）
2019-02-11
MVC框架
自己寫一個mvc框架吧（五）
2019-02-13
MVC框架
自己寫一個mvc框架吧（二）
2019-02-01
MVC框架
自己寫一個mvc框架吧（一）
2019-02-01
MVC框架
自己寫一個mvc框架吧（三）
2019-02-01
MVC框架
自己動手寫一個簡單的MVC框架
2016-03-18
MVC框架
自己動手寫 PHP 框架（一）
2017-04-20
PHP框架
編寫自己的程式碼庫（javascript常用例項的實現與封裝）
2017-07-20
JavaScript封裝
測試框架 Mocha 例項教程
2015-12-03
框架
編寫自己的程式碼庫（javascript常用例項的實現與封裝–續）
2017-08-08
JavaScript封裝
自己編寫Java Web框架：Takes框架的Web App架構
2015-05-30
JavaWeb框架APP架構
如何寫一個自己的渣渣PHP框架（4）
2017-03-28
PHP框架
編寫自己的php擴充套件函式 (轉)
2007-12-12
PHP套件函式
從零開始編寫自己的JavaScript框架（一）
2013-07-10
JavaScript框架
從零開始編寫自己的JavaScript框架（二）
2013-07-10
JavaScript框架
編寫自己的php擴充套件函式（一） (轉)
2007-12-12
PHP套件函式
構建自己的 PHP 框架
2017-08-01
PHP框架
php例項化物件的例項方法
2021-10-24
PHP物件
淺談MVC框架中View層的優雅設計及例項
2006-04-06
MVC框架View
編寫自己的 TypeScript CLI
2022-02-09
TypeScript
手寫mini版MVC框架
2020-12-07
MVC框架
我讓chatGPT用PHP寫一個MVC框架，不僅寫出來，還能跑！
2023-03-29
ChatGPTPHPMVC框架
如果你想寫自己的Benchmark框架
2020-07-11
框架
手寫自己的MyBatis框架-SqlSession
2020-12-14
MyBatis框架SQLSession
【編測編學】分享一套好用的功能測試用例編寫框架
2020-12-01
框架
【轉】測試用例編寫(功能測試框架)
2017-07-25
框架
asyncio非同步模組的21個協程編寫例項
2020-08-25
非同步
手寫Spring MVC框架（一）實現簡易版mvc框架
2021-05-15
SpringMVC框架
編寫自己的Webpack Loader
2017-10-12
Web
spring mvc即mvc攔截器例項（1）
2011-02-15
SpringMVC
Vue.js編輯文字--菜鳥教程例項
2020-11-18
Vue.js
MVC框架的程式碼審計小教程
2020-10-29
MVC框架
自己寫的和收藏的一寫php函式
2017-11-12
PHP函式
ORM 例項教程
2019-02-18
ORM
Java例項教程
2020-10-26
Java
通過例項，學習編寫 React 元件的“最佳實踐”
2017-07-11
React元件