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

1 什麼是MVC

MVC模式（Model-View-Controller）是軟件工程中的一種軟件架構模式。

MVC把軟件系統分爲三個基本部分：模型（Model）、視圖（View）和控制器（Controller）。

PHP中MVC模式也稱Web MVC，從上世紀70年代進化而來。

MVC的目的是實現一種動態的程序設計，便於後續對程序的修改和擴展簡化，並且使程序某一部分的重複利用成爲可能。

除此之外，此模式通過對複雜度的簡化，使程序結構更加直觀。

MVC各部分的職能：

模型Model – 管理大部分的業務邏輯和所有的數據庫邏輯。模型提供了連接和操作數據庫的抽象層。
控制器Controller - 負責響應用戶請求、準備數據，以及決定如何展示數據。
視圖View – 負責渲染數據，通過HTML方式呈現給用戶。

一個典型的Web MVC流程：

Controller截獲用戶發出的請求；
Controller調用Model完成狀態的讀寫操作；
Controller把數據傳遞給View；
View渲染最終結果並呈獻給用戶。

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

網絡上有大量優秀的MVC框架可供使用，本教程並不是爲了開發一個全面的、終極的MVC框架解決方案。

我們將它看作是一個很好的從內部學習PHP的機會。

在此過程中，你將學習面向對象編程和MVC設計模式，並學習到開發中的一些注意事項。

更重要的是，通過自制MVC框架，每個人都可以完全控制自己的框架，將你的想法融入到你開發的框架中。

雖然不一定是最好的，但是你可以按照自己的方式開發各種功能。

3 開始開發自己的MVC框架

3.1 目錄準備

在開始開發前，讓我們先來把項目建立好。

假設我們建立的項目爲 project，MVC的框架命名爲 fastphp，那麼接下來，第一步要把目錄結構設置好。

project  WEB部署目錄
├─application           應用目錄
│  ├─controllers        控制器目錄
│  ├─models             模塊目錄
│  ├─views              視圖目錄
├─config                配置文件目錄
├─fastphp               框架核心目錄
├─static                靜態文件目錄
├─index.php             入口文件

然後把Nginx或者Apache的站點根目錄配置到project目錄。

3.2 代碼規範

在目錄設置好以後，我們接下來規定代碼的規範：

MySQL的表名需小寫或小寫加下劃線，如：item，car_orders。
模塊名（Models）需用大駝峯命名法，即首字母大寫，並在名稱後添加Model，如：ItemModel，CarModel。
控制器（Controllers）需用大駝峯命名法，即首字母大寫，並在名稱後添加Controller，如：ItemController，CarController。
方法名（Action）需用小駝峯命名法，即首字母小寫，如：index，indexPost。
視圖（Views）部署結構爲控制器名/行爲名，如：item/view.php，car/buy.php。

上述規則是爲了程序能更好地相互調用。

接下來就開始真正的PHP MVC編程了。

3.3 重定向

重定向的目的有兩個：設置根目錄爲project所在位置，以及將所有請求都發送給 index.php 文件。

如果是Apache服務器，在 project 目錄下新建一個 .htaccess 文件，內容爲：

<IfModule mod_rewrite.c>
    # 打開Rerite功能
    RewriteEngine On

    # 如果請求的是真實存在的文件或目錄，直接訪問
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d

    # 如果訪問的文件或目錄不是真事存在，分發請求至 index.php
    RewriteRule . index.php
</IfModule>

如果是Nginx服務器，修改配置文件，在server塊中加入如下的重定向：

location / {
    # 重新向所有非真是存在的請求到index.php
    try_files $uri $uri/ /index.php$args;
}

這樣做的主要原因是：

（1）靜態文件能直接訪問。

如果文件或者目錄真實存在，則直接訪問存在的文件/目錄。

比如，靜態文件static/css/main.css真實存在，就可以直接訪問它。

（2）程序有單一的入口。

這種情況是請求地址不是真實存在的文件或目錄，這樣請求就會傳到 index.php 上。

例如，訪問地址：localhost/item/view/1，在文件系統中並不存在這樣的文件或目錄。

那麼，Apache或Nginx服務器會把請求發給index.php，並且把域名之後的字符串賦值給REQUEST_URI變量。

這樣在PHP中用$_SERVER['REQUEST_URI']就能拿到/item/view/1；

（3）可以用來生成美化的URL，利於SEO。

3.4 入口文件

接下來，在 project 目錄下新建 index.php 入口文件，文件內容爲：

<?php
// 應用目錄爲當前目錄
define('APP_PATH', __DIR__ . '/');

// 開啓調試模式
define('APP_DEBUG', true);

// 加載框架文件
require(APP_PATH . 'fastphp/Fastphp.php');

// 加載配置文件
$config = require(APP_PATH . 'config/config.php');

// 實例化框架類
(new Fastphp($config))->run();

注意，上面的PHP代碼中，並沒有添加PHP結束符號?>。

這麼做的主要原因是：

對於只有 PHP 代碼的文件，最好沒有結束標誌?>，

PHP自身並不需要結束符號，不加結束符讓程序更加安全，很大程度防止了末尾被注入額外的內容。

3.5 配置文件

在入口文件中，我們加載了config.php文件的內容，那它有何作用呢？

從名稱不難看出，它的作用是保存一些常用配置。

config.php 文件內容如下，作用是定義數據庫連接參數參數，以及配置默認控制器名和操作名：

<?php

// 數據庫配置
define('DB_NAME', 'project');
define('DB_USER', 'root');
define('DB_PASSWORD', '123456');
define('DB_HOST', 'localhost');

// 默認控制器和操作名
$config['defaultController'] = 'Item';
$config['defaultAction'] = 'index';

return $config;

入口中的$config變量接收到配置參數後，再傳給框架的核心類，也就是Fastphp類。

3.6 框架核心類

入口文件對框架類做了兩步操作：實例化，調用run()方法。

實例化操作接受$config參數配置，並保存到類屬性中。

run()方法則調用用類自身方法，完成：自動加載類文件、監測開發環境、過濾敏感字符、移除全局變量的老用法、和處理路由。

<?php
/**
 * fastphp框架核心
 */
class Fastphp
{
    protected $_config = [];

    public function __construct($config)
    {
        $this->_config = $config;
    }

    // 運行程序
    public function run()
    {
        spl_autoload_register(array($this, 'loadClass'));
        $this->setReporting();
        $this->removeMagicQuotes();
        $this->unregisterGlobals();
        $this->setDbConfig();
        $this->route();
    }

    // 路由處理
    public function route()
    {
        $controllerName = $this->_config['defaultController'];
        $actionName = $this->_config['defaultAction'];
        $param = array();

        $url = $_SERVER['REQUEST_URI'];
        // 清除?之後的內容
        $position = strpos($url, '?');
        $url = $position === false ? $url : substr($url, 0, $position);
        // 刪除前後的“/”
        $url = trim($url, '/');

        if ($url) {
            // 使用“/”分割字符串，並保存在數組中
            $urlArray = explode('/', $url);
            // 刪除空的數組元素
            $urlArray = array_filter($urlArray);
            
            // 獲取控制器名
            $controllerName = ucfirst($urlArray[0]);
            
            // 獲取動作名
            array_shift($urlArray);
            $actionName = $urlArray ? $urlArray[0] : $actionName;
            
            // 獲取URL參數
            array_shift($urlArray);
            $param = $urlArray ? $urlArray : array();
        }

        // 判斷控制器和操作是否存在
        $controller = $controllerName . 'Controller';
        if (!class_exists($controller)) {
            exit($controller . '控制器不存在');
        }
        if (!method_exists($controller, $actionName)) {
            exit($actionName . '方法不存在');
        }

        // 如果控制器和操作名存在，則實例化控制器，因爲控制器對象裏面
        // 還會用到控制器名和操作名，所以實例化的時候把他們倆的名稱也
        // 傳進去。結合Controller基類一起看
        $dispatch = new $controller($controllerName, $actionName);

        // $dispatch保存控制器實例化後的對象，我們就可以調用它的方法，
        // 也可以像方法中傳入參數，以下等同於：$dispatch->$actionName($param)
        call_user_func_array(array($dispatch, $actionName), $param);
    }

    // 檢測開發環境
    public 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');
        }
    }

    // 刪除敏感字符
    public function stripSlashesDeep($value)
    {
        $value = is_array($value) ? array_map(array($this, 'stripSlashesDeep'), $value) : stripslashes($value);
        return $value;
    }

    // 檢測敏感字符並刪除
    public function removeMagicQuotes()
    {
        if (get_magic_quotes_gpc()) {
            $_GET = isset($_GET) ? $this->stripSlashesDeep($_GET ) : '';
            $_POST = isset($_POST) ? $this->stripSlashesDeep($_POST ) : '';
            $_COOKIE = isset($_COOKIE) ? $this->stripSlashesDeep($_COOKIE) : '';
            $_SESSION = isset($_SESSION) ? $this->stripSlashesDeep($_SESSION) : '';
        }
    }

    // 檢測自定義全局變量並移除。因爲 register_globals 已經棄用，如果
    // 已經棄用的 register_globals 指令被設置爲 on，那麼局部變量也將
    // 在腳本的全局作用域中可用。 例如， $_POST['foo'] 也將以 $foo 的
    // 形式存在，這樣寫是不好的實現，會影響代碼中的其他變量。 相關信息，
    // 參考: http://php.net/manual/zh/faq.using.php#faq.register-globals
    public 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]);
                    }
                }
            }
        }
    }

    // 配置數據庫信息
    public function setDbConfig()
    {
        if ($this->_config['db']) {
            Model::$dbConfig = $this->_config['db'];
        }
    }

    // 自動加載控制器和模型類 
    public static function loadClass($class)
    {
        $frameworks = __DIR__ . '/' . $class . '.php';
        $controllers = APP_PATH . 'application/controllers/' . $class . '.php';
        $models = APP_PATH . 'application/models/' . $class . '.php';

        if (file_exists($frameworks)) {
            // 加載框架核心類
            include $frameworks;
        } elseif (file_exists($controllers)) {
            // 加載應用控制器類
            include $controllers;
        } elseif (file_exists($models)) {
            //加載應用模型類
            include $models;
        } else {
            // 錯誤代碼
        }
    }
}

下面重點講解主請求方法route()，它也稱路由方法，作用是：截取URL，並解析出控制器名、方法名和URL參數。

假設我們的 URL 是這樣：

yoursite.com/controllerName/actionName/queryString

當瀏覽器訪問上面的URL，route()從全局變量 $_SERVER['REQUEST_URI']中獲取到字符串/controllerName/actionName/queryString。

然後，會將這個字符串分割成三部分：controller、action 和 queryString。

例如，URL鏈接爲：yoursite.com/item/view/1/hello，那麼route()分割之後，

Controller名就是：item
action名就是：view
URL參數就是：array(1, hello)

分割完成後，再實例化控制器：itemController，並調用其中的view方法。

3.7 Controller基類

接下來，就是在 fastphp 中創建MVC基類，包括控制器、模型和視圖三個基類。

新建控制器基類，文件名 Controller.class.php，功能就是總調度，內容如下：

<?php 
/**
 * 控制器基類
 */
class Controller
{
    protected $_controller;
    protected $_action;
    protected $_view;
 
    // 構造函數，初始化屬性，並實例化對應模型
    public function __construct($controller, $action)
    {
        $this->_controller = $controller;
        $this->_action = $action;
        $this->_view = new View($controller, $action);
    }

    // 分配變量
    public function assign($name, $value)
    {
        $this->_view->assign($name, $value);
    }

    // 渲染視圖
    public function render()
    {
        $this->_view->render();
    }
}

Controller 類用assign()方法實現把變量保存到View對象中。

這樣，在調用$this-> render() 後視圖文件就能顯示這些變量。

3.8 Model基類

新建模型基類，繼承自數據庫操作類Sql類（因爲數據庫操作比較複雜）。

模型基類文件名爲 Model.class.php，代碼如下：

<?php

class Model extends Sql
{
    protected $_model;
    protected $_table;
    public static $dbConfig = [];

    public function __construct()
    {
        // 連接數據庫
        $this->connect(self::$dbConfig['host'], self::$dbConfig['username'], self::$dbConfig['password'],
            self::$dbConfig['dbname']);

        // 獲取數據庫表名
        if (!$this->_table) {
            // 獲取模型類名稱
            $this->_model = get_class($this);
            // 刪除類名最後的 Model 字符
            $this->_model = substr($this->_model, 0, -5);

            // 數據庫表名與類名一致
            $this->_table = strtolower($this->_model);
        }
    }
}

建立一個數據庫基類 Sql.class.php，代碼如下：

<?php 

class Sql
{
    protected $_dbHandle;
    protected $_result;
    private $filter = '';

    // 連接數據庫
    public function connect($host, $username, $password, $dbname)
    {
        try {
            $dsn = sprintf("mysql:host=%s;dbname=%s;charset=utf8", $host, $dbname);
            $option = array(PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC);
            $this->_dbHandle = new PDO($dsn, $username, $password, $option);
        } catch (PDOException $e) {
            exit('錯誤: ' . $e->getMessage());
        }
    }

    // 查詢條件
    public function where($where = array())
    {
        if (isset($where)) {
            $this->filter .= ' WHERE ';
            $this->filter .= implode(' ', $where);
        }

        return $this;
    }

    // 排序條件
    public function order($order = array())
    {
        if(isset($order)) {
            $this->filter .= ' ORDER BY ';
            $this->filter .= implode(',', $order);
        }

        return $this;
    }

    // 查詢所有
    public function selectAll()
    {
        $sql = sprintf("select * from `%s` %s", $this->_table, $this->filter);
        $sth = $this->_dbHandle->prepare($sql);
        $sth->execute();

        return $sth->fetchAll();
    }

    // 根據條件 (id) 查詢
    public function select($id)
    {
        $sql = sprintf("select * from `%s` where `id` = '%s'", $this->_table, $id);
        $sth = $this->_dbHandle->prepare($sql);
        $sth->execute();

        return $sth->fetch();
    }

    // 根據條件 (id) 刪除
    public function delete($id)
    {
        $sql = sprintf("delete from `%s` where `id` = '%s'", $this->_table, $id);
        $sth = $this->_dbHandle->prepare($sql);
        $sth->execute();

        return $sth->rowCount();
    }

    // 自定義SQL查詢，返回影響的行數
    public function query($sql)
    {
        $sth = $this->_dbHandle->prepare($sql);
        $sth->execute();

        return $sth->rowCount();
    }

    // 新增數據
    public function add($data)
    {
        $sql = sprintf("insert into `%s` %s", $this->_table, $this->formatInsert($data));

        return $this->query($sql);
    }

    // 修改數據
    public function update($id, $data)
    {
        $sql = sprintf("update `%s` set %s where `id` = '%s'", $this->_table, $this->formatUpdate($data), $id);

        return $this->query($sql);
    }

    // 將數組轉換成插入格式的sql語句
    private function formatInsert($data)
    {
        $fields = array();
        $values = array();
        foreach ($data as $key => $value) {
            $fields[] = sprintf("`%s`", $key);
            $values[] = sprintf("'%s'", $value);
        }

        $field = implode(',', $fields);
        $value = implode(',', $values);

        return sprintf("(%s) values (%s)", $field, $value);
    }

    // 將數組轉換成更新格式的sql語句
    private function formatUpdate($data)
    {
        $fields = array();
        foreach ($data as $key => $value) {
            $fields[] = sprintf("`%s` = '%s'", $key, $value);
        }

        return implode(',', $fields);
    }
}

應該說，Sql.class.php 是框架的核心部分。爲什麼？

因爲通過它，我們創建了一個 SQL 抽象層，可以大大減少了數據庫的編程工作。

雖然 PDO 接口本來已經很簡潔，但是抽象之後框架的可靈活性更高。

這裏的數據庫句柄$this->_dbHandle還能用單例模式返回，讓數據讀寫更高效，這部分可自行實現。

3.9 View基類

視圖基類 View.class.php 內容如下：

<?php
/**
 * 視圖基類
 */
class View
{
    protected $variables = array();
    protected $_controller;
    protected $_action;

    function __construct($controller, $action)
    {
        $this->_controller = $controller;
        $this->_action = $action;
    }
 
    // 分配變量
    public function assign($name, $value)
    {
        $this->variables[$name] = $value;
    }
 
    // 渲染顯示
    public 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';
        $controllerLayout = APP_PATH . 'application/views/' . $this->_controller . '/' . $this->_action . '.php';

        // 頁頭文件
        if (file_exists($controllerHeader)) {
            include ($controllerHeader);
        } else {
            include ($defaultHeader);
        }

        include ($controllerLayout);
        
        // 頁腳文件
        if (file_exists($controllerFooter)) {
            include ($controllerFooter);
        } else {
            include ($defaultFooter);
        }
    }
}

這樣，核心的PHP MVC框架核心就完成了。

下面我們編寫應用來測試框架功能。

4 應用

4.1 數據庫部署

在 SQL 中新建一個 project 數據庫，增加一個item 表、並插入兩條記錄，命令如下：

CREATE DATABASE `project` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
USE `project`;

CREATE TABLE `item` (
    `id` int(11) NOT NULL auto_increment,
    `item_name` varchar(255) NOT NULL,
    PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
 
INSERT INTO `item` VALUES(1, 'Hello World.');
INSERT INTO `item` VALUES(2, 'Lets go!');

4.2 部署模型

然後，我們還需要在 models 目錄中創建一個 ItemModel.php 模型，內容如下：

<?php

/**
 * 用戶模塊，一般與數據庫表名對應
 * 例如表名爲：item，那麼Model類名應該爲：ItemModel
 * 也可以添加一個$_table屬性指定表名
 */
class ItemModel extends Model
{
    public $_table = 'item';
}

因爲 Item 模型繼承了 Model基類，所以它擁有 Model 類的所有功能。

4.3 部署控制器

在 controllers 目錄下創建一個 ItemController.php 控制器，內容如下：

<?php
 
class ItemController extends Controller
{
    // 首頁方法，測試框架自定義DB查詢
    public function index()
    {
        $items = (new ItemModel)->selectAll();

        $this->assign('title', '全部條目');
        $this->assign('items', $items);
        $this->render();
    }
    
    // 添加記錄，測試框架DB記錄創建（Create）
    public function add()
    {
        $data['item_name'] = $_POST['value'];
        $count = (new ItemModel)->add($data);

        $this->assign('title', '添加成功');
        $this->assign('count', $count);
        $this->render();
    }
    
    // 查看記錄，測試框架DB記錄讀取（Read）
    public function view($id = null)
    {
        $item = (new ItemModel)->select($id);

        $this->assign('title', '正在查看' . $item['item_name']);
        $this->assign('item', $item);
        $this->render();
    }
    
    // 更新記錄，測試框架DB記錄更新（Update）
    public function update()
    {
        $data = array('id' => $_POST['id'], 'item_name' => $_POST['value']);
        $count = (new ItemModel)->update($data['id'], $data);

        $this->assign('title', '修改成功');
        $this->assign('count', $count);
        $this->render();
    }
    
    // 刪除記錄，測試框架DB記錄刪除（Delete）
    public function delete($id = null)
    {
        $count = (new ItemModel)->delete($id);

        $this->assign('title', '刪除成功');
        $this->assign('count', $count);
        $this->render();
    }
}

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>
    <link rel="stylesheet" href="/static/css/main.css" type="text/css" />
</head>
<body>
    <h1><?php echo $title ?></h1>

footer.php 內容：

</body>
</html>

頁頭文件用到了main.css樣式文件，內容：

input {
    font-family:georgia,times;
    font-size:24px;
    line-height:1.2em;
}

a {
    color:blue;
    font-family:georgia,times;
    font-size:20px;
    line-height:1.2em;
    text-decoration:none;
}

a:hover {
    text-decoration:underline;
}

h1 {
    color:#000000;
    font-size:41px;
    border-bottom:1px dotted #cccccc;
}

然後，在 views/item 創建以下幾個視圖文件。

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

<form action="/item/add" method="post">
    <input type="text" value="點擊添加" onclick="this.value=''" name="value">
    <input type="submit" value="添加">
</form>
<br/>
<?php foreach ($items as $item): ?>
    <a class="big" href="/item/view/<?php echo $item['id'] ?>" title="點擊修改">
        <span class="item">
            <?php echo $item['id'] ?>
            <?php echo $item['item_name'] ?>
        </span>
    </a>
    ----
    <a class="big" href="/item/delete/<?php echo $item['id']?>">刪除</a>
<br/>
<?php endforeach ?>

add.php，添加記錄，內容：

<a class="big" href="/item/index">成功添加<?php echo $count ?>條記錄，點擊返回</a>

view.php，查看單條記錄，內容：

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

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

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

<a class="big" href="/item/index">成功修改<?php echo $count ?>項，點擊返回</a>

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

<a href="/item/index">成功刪除<?php echo $count ?>項，點擊返回</a>

4.5 應用測試

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

以上代碼已經全部發布到 github 上，關鍵部分加了註釋：

倉庫地址：https://github.com/yeszao/fastphp
源碼打包：https://github.com/yeszao/fastphp/archive/master.zip

要設計更好的MVC，或使用得更加規範，請看《MVC架構的職責劃分原則》。

原帖地址：http://www.awaimai.com/128.html#1MVC