1小时内打造你自己的PHP MVC框架

简介

MVC框架在现在的开发中相当流行，不论你使用的是JAVA,C#,PHP或者IOS，你肯定都会选择一款框架。虽然不能保证100%的开发语言都会使用框架，但是在PHP社区当中拥有最多数量的MVC框架。今天你或许还在使用Zend，明天你换了另一个项目也许就会转投Yii,Laravel或者CakePHP的怀抱。如果你刚开始使用一种框架，当你看它的源码的时候你会觉得一头雾水，是的，这些框架都很复杂。因为这些流行的框架并不是短时间之内就写出来就发行的，它们都是经过一遍又一遍的编写和测试加上不断的更新函数库才有了今天得模样。所以就我的经验来看，了解MVC框架的设计核心理念是很有必要的，不然你就会感觉在每一次使用一个新的框架的时候一遍又一遍的从头学习。

所以最好的理解MVC的方法就是写一个你自己的MVC框架。在这篇文章中，我将会向你展示如何构建一个自己的MVC框架。

MVC架构模式

M: Model-模型

V: View-视图

C: Controller-控制器

 

MVC的关键概念就是从视图层分发业务逻辑。首先解释以下HTTP的请求和相应是如何工作的。例如，我们有一个商城网站，然后我们想要添加一个商品，那么最简单的一个URL就会是像下面这个样子：

http://bestshop.com/index.php?p=admin&c=goods&a=add

 

http://bestshop.com就是主域名或者基础URL；

p=admin 意味着处在管理模块,，或者是系统的后台模块。同时我们肯定也拥有前台模块，前台模块供所有用户访问(本例中, 它是p=public)

c=goods&a=add 意思是URL请求的是goods控制器里的add方法。

前台控制器设计

在上面的例子中index.php中是什么？在PHP框架中它被称为入口文件。这个文件通常都被命名为index.php，当然你也可以给它别的命名。这个index.php的最主要的作用就是作为HTTP请求的唯一入口文件，这样无论你的URL请求什么资源，它都必须通过这个Index.php来请求。你可能要问为什么，它是如何做到的？PHP中的前端控制器用到了Apache服务器的分布式配置.htaccess实现的。在这个文件中，我们可以使用重写模块告诉Apache服务器重定向到我们的index.php入口文件，就像下面这样：

<IfModule mod_rewrite.c>

   

   Options +FollowSymLinks

   RewriteEngine on


   # Send request via index.php

   RewriteCond %{REQUEST_FILENAME} !-f

   RewriteCond %{REQUEST_FILENAME} !-d

   RewriteRule ^(.*)$ index.php/$1 [L]


</IfModule>

这个配置文件非常有用，还有当你重写这个配置文件的时候你不需要重启Apache。但是当你修改Apache的其他配置文件的时候你都需要重启Apache才能生效，因为Apache只有在启动的时候才会读取这些配置文件。

同时，index.php还会进行框架的初始化并且分发路由请求给对应的控制器和方法。

我们的MVC目录结构

现在让我们开始创建我们的框架目录结构。我们你可以随便先建立一个文件夹，命名为你项目的名称，比如:/bestshop。在这个文件夹下你需要建立下面的文件夹：

/application-存放web应用程序目录

/framework-存放框架文件目录

/public-存放所有的公共的静态资源，比如HTML文件，CSS文件和jJS文件。

index.php-唯一入口文件

然后在application文件夹下再建立下一级的目录

/config-存放应用的配置文件

/controllers-应用的控制器类

/model-应用的模型类

/view-应用的视图文件

 

现在在application/controllers文件夹下，我们还需要创建两个文件夹，一个frontend，一个backend：

同样的，在view下也建立frontend和backend文件夹：

就像你看到的，在application的controllers和view下面建立了backen和frontend文件夹，就像我们的用用有前台和后台功能一样。但是为什么不在model下也这样做呢？

Well, the reason here is, normally for a web app:是因为一般在我们的应用中，前台和后台其实是可以看做是两个“网站的”，但是CRUD操作的是同一个数据库，这就是问什么管理员更新了货物的价格的时候，前台用户可以马上看到价格的变化，因为前台和后台是共享一个数据库（表）的。所以在model中没必要再去建立两个文件夹。

  

:现在让我们回到framework文件夹中，一些框架的文件夹命名会用框架的名字命名，比如"symfony"。在framework中让我们快速建立下面的子目录：

/core-框架核心文件目录

/database-数据库目录（比如数据库启动类）

/helpers-辅助函数目录

/libraries-类库目录

现在进入public文件夹，建立下面的目录：

/css-存放css文件

/images-存放图片文件

/js-存放js文件

/uploads-存放上传的文件

OK。到目前为止这就是我们这个迷你的MVC框架的目录结构了！

框架核心类

现在在framework/core下建立一个Framework.class.php的文件。写入以下代码：

// framework/core/Framework.class.php

class Framework {


   public static function run() {

       echo "run()";

   }

我们创建了一个静态方法run()，现在让我们通过入口文件index.php测试一下：

<?php


require "framework/core/Framework.class.php";


Framework::run();

你可以在你的浏览器里访问index.php看到结果。通常这个静态方法被命名为run()或者bootstrap()。在这个方法中，我们要做3件最主要的事情：

class Framework {


   public static function run() {

//        echo "run()";

       self::init();

       self::autoload();

       self::dispatch();

   }


   private static function init() {

   }


   private static function autoload() {


   }


   private static function dispatch() {


   }

}

初始化

init()方法：

// Initialization

private static function init() {

    // Define path constants

    define("DS", DIRECTORY_SEPARATOR);

    define("ROOT", getcwd() . DS);

    define("APP_PATH", ROOT . 'application' . DS);

    define("FRAMEWORK_PATH", ROOT . "framework" . DS);

    define("PUBLIC_PATH", ROOT . "public" . DS);


    define("CONFIG_PATH", APP_PATH . "config" . DS);

    define("CONTROLLER_PATH", APP_PATH . "controllers" . DS);

    define("MODEL_PATH", APP_PATH . "models" . DS);

    define("VIEW_PATH", APP_PATH . "views" . DS);


    define("CORE_PATH", FRAMEWORK_PATH . "core" . DS);

    define('DB_PATH', FRAMEWORK_PATH . "database" . DS);

    define("LIB_PATH", FRAMEWORK_PATH . "libraries" . DS);

    define("HELPER_PATH", FRAMEWORK_PATH . "helpers" . DS);

    define("UPLOAD_PATH", PUBLIC_PATH . "uploads" . DS);


    // Define platform, controller, action, for example:

    // index.php?p=admin&c=Goods&a=add

    define("PLATFORM", isset($_REQUEST['p']) ? $_REQUEST['p'] : 'home');

    define("CONTROLLER", isset($_REQUEST['c']) ? $_REQUEST['c'] : 'Index');

    define("ACTION", isset($_REQUEST['a']) ? $_REQUEST['a'] : 'index');


    define("CURR_CONTROLLER_PATH", CONTROLLER_PATH . PLATFORM . DS);

    define("CURR_VIEW_PATH", VIEW_PATH . PLATFORM . DS);


    // Load core classes

    require CORE_PATH . "Controller.class.php";

    require CORE_PATH . "Loader.class.php";

    require DB_PATH . "Mysql.class.php";

    require CORE_PATH . "Model.class.php";


    // Load configuration file

    $GLOBALS['config'] = include CONFIG_PATH . "config.php";


    // Start session

    session_start();

}

在注释中你可以看到每一步的目的。

自动加载

在项目中，我们不想在脚本中想使用一个类的时候手动的去include或者require加载，这就是为什么PHP MVC框架都有自动加载的功能。例如，在symfony中，如果你想要加载lib下的类，它将会被自动引入。很神奇是吧？现在让我们在自己的框架中加入自动加载的功能。

 

这里我们要用的PHP中的自带函数spl_autoload_register：

// Autoloading

private static function autoload(){

    spl_autoload_register(array(__CLASS__,'load'));

}


// Define a custom load method

private static function load($classname){


    // Here simply autoload app’s controller and model classes

    if (substr($classname, -10) == "Controller"){

        // Controller

        require_once CURR_CONTROLLER_PATH . "$classname.class.php";

    } elseif (substr($classname, -5) == "Model"){

        // Model

        require_once  MODEL_PATH . "$classname.class.php";

    }

}

每一个框架都有自己的命名规则，我们的也不例外。对于一个控制器类，它需要被命名成类似xxxController.class.php，对于一个模型类，需要被命名成xxModel.class.php。为什么在使用一个框架的时候你需要遵守它的命名规则呢？自动加载就是一条原因。

路由/分发

// Routing and dispatching

private static function dispatch(){

    // Instantiate the controller class and call its action method

    $controller_name = CONTROLLER . "Controller";

    $action_name = ACTION . "Action";

    $controller = new $controller_name;

    $controller->$action_name();

}

在这步中，index.php将会分发请求到对应的Controller::Aciton()方法中。

基础Controller类

通常在框架的核心类中都有一个基础的控制器。在symfony中，被称为sfAction;在iOS中，被称为UIViewController。在这里我们命名为Controller，在framework/core下建立Controller.class.php

<?php

// Base Controller

class Controller{

    // Base Controller has a property called $loader, it is an instance of Loader class(introduced later)

    protected $loader;


    public function __construct(){

        $this->loader = new Loader();

    }


    public function redirect($url,$message,$wait = 0){

        if ($wait == 0){

            header("Location:$url");

        } else {

            include CURR_VIEW_PATH . "message.html";

        }


        exit;

    }

}

基础控制器有一个变量$loader，它是Loader类的实例化（后面介绍）。准确的说，$this->loader是一个变量指向了被实例化的Load类。在这里我不过多的讨论，但是这的确是一个非常关键的概念。我遇到过一些PHP开发者相信在这个语句之后：

$this->loader = new Loader();

$this->load是一个对象。不，它只是一个引用。这是从Java中开始使用的，在Java之前，在C++和Objective C中被称为指针。引用是个封装的指针类型。比如，在iOS(O-C)中，我们创建了一个对象：

UIButton *btn = [UIButton alloc] init];

加载类

在framework.class.php中，我们已经封装好了应用的控制器和模型的自动加载。但是如何自动加载在framework目录中的类呢？现在我们可以新建一个Loader类，它会加载framework目录中的类和函数。当我们加载framework类时，只需要调用这个Loader类中的方法即可。

class Loader{

    // Load library classes

    public function library($lib){

        include LIB_PATH . "$lib.class.php";

    }


    // loader helper functions. Naming conversion is xxx_helper.php;

    public function helper($helper){

        include HELPER_PATH . "{$helper}_helper.php";

    }

}

封装模型

我们需要下面两个类来封装基础Model类：

Mysql.class.php - 在framework/database下建立，它封装了数据库的链接和一些基本查询方法。

 

Model.class.php - framework/core下建立，基础模型类，封装所有的CRUD方法。

Mysql.class.php ：

<?php

/**

*================================================================

*framework/database/Mysql.class.php

*Database operation class

*================================================================

*/

class Mysql{

    protected $conn = false;  //DB connection resources

    protected $sql;           //sql statement

   

    /**

     * Constructor, to connect to database, select database and set charset

     * @param $config string configuration array

     */

    public function __construct($config = array()){

        $host = isset($config['host'])? $config['host'] : 'localhost';

        $user = isset($config['user'])? $config['user'] : 'root';

        $password = isset($config['password'])? $config['password'] : '';

        $dbname = isset($config['dbname'])? $config['dbname'] : '';

        $port = isset($config['port'])? $config['port'] : '3306';

        $charset = isset($config['charset'])? $config['charset'] : '3306';

       

        $this->conn = mysql_connect("$host:$port",$user,$password) or die('Database connection error');

        mysql_select_db($dbname) or die('Database selection error');

        $this->setChar($charset);

    }

    /**

     * Set charset

     * @access private

     * @param $charset string charset

     */

    private function setChar($charest){

        $sql = 'set names '.$charest;

        $this->query($sql);

    }

    /**

     * Execute SQL statement

     * @access public

     * @param $sql string SQL query statement

     * @return $result，if succeed, return resrouces; if fail return error message and exit

     */

    public function query($sql){        

        $this->sql = $sql;

        // Write SQL statement into log

        $str = $sql . "  [". date("Y-m-d H:i:s") ."]" . PHP_EOL;

        file_put_contents("log.txt", $str,FILE_APPEND);

        $result = mysql_query($this->sql,$this->conn);

       

        if (! $result) {

            die($this->errno().':'.$this->error().'<br />Error SQL statement is '.$this->sql.'<br />');

        }

        return $result;

    }

    /**

     * Get the first column of the first record

     * @access public

     * @param $sql string SQL query statement

     * @return return the value of this column

     */

    public function getOne($sql){

        $result = $this->query($sql);

        $row = mysql_fetch_row($result);

        if ($row) {

            return $row[0];

        } else {

            return false;

        }

    }

    /**

     * Get one record

     * @access public

     * @param $sql SQL query statement

     * @return array associative array

     */

    public function getRow($sql){

        if ($result = $this->query($sql)) {

            $row = mysql_fetch_assoc($result);

            return $row;

        } else {

            return false;

        }

    }

    /**

     * Get all records

     * @access public

     * @param $sql SQL query statement

     * @return $list an 2D array containing all result records

     */

    public function getAll($sql){

        $result = $this->query($sql);

        $list = array();

        while ($row = mysql_fetch_assoc($result)){

            $list[] = $row;

        }

        return $list;

    }

    /**

     * Get the value of a column

     * @access public

     * @param $sql string SQL query statement

     * @return $list array an array of the value of this column

     */

    public function getCol($sql){

        $result = $this->query($sql);

        $list = array();

        while ($row = mysql_fetch_row($result)) {

            $list[] = $row[0];

        }

        return $list;

    }


   

    /**

     * Get last insert id

     */

    public function getInsertId(){

        return mysql_insert_id($this->conn);

    }

    /**

     * Get error number

     * @access private

     * @return error number

     */

    public function errno(){

        return mysql_errno($this->conn);

    }

    /**

     * Get error message

     * @access private

     * @return error message

     */

    public function error(){

        return mysql_error($this->conn);

    }

}

Model.class.php：

<?php

// framework/core/Model.class.php

// Base Model Class

class Model{

    protected $db; //database connection object

    protected $table; //table name

    protected $fields = array();  //fields list

    public function __construct($table){

        $dbconfig['host'] = $GLOBALS['config']['host'];

        $dbconfig['user'] = $GLOBALS['config']['user'];

        $dbconfig['password'] = $GLOBALS['config']['password'];

        $dbconfig['dbname'] = $GLOBALS['config']['dbname'];

        $dbconfig['port'] = $GLOBALS['config']['port'];

        $dbconfig['charset'] = $GLOBALS['config']['charset'];

       

        $this->db = new Mysql($dbconfig);

        $this->table = $GLOBALS['config']['prefix'] . $table;

        $this->getFields();

    }

    /**

     * Get the list of table fields

     *

     */

    private function getFields(){

        $sql = "DESC ". $this->table;

        $result = $this->db->getAll($sql);

        foreach ($result as $v) {

            $this->fields[] = $v['Field'];

            if ($v['Key'] == 'PRI') {

                // If there is PK, save it in $pk

                $pk = $v['Field'];

            }

        }

        // If there is PK, add it into fields list

        if (isset($pk)) {

            $this->fields['pk'] = $pk;

        }

    }

    /**

     * Insert records

     * @access public

     * @param $list array associative array

     * @return mixed If succeed return inserted record id, else return false

     */

    public function insert($list){

        $field_list = '';  //field list string

        $value_list = '';  //value list string

        foreach ($list as $k => $v) {

            if (in_array($k, $this->fields)) {

                $field_list .= "`".$k."`" . ',';

                $value_list .= "'".$v."'" . ',';

            }

        }

        // Trim the comma on the right

        $field_list = rtrim($field_list,',');

        $value_list = rtrim($value_list,',');

        // Construct sql statement

        $sql = "INSERT INTO `{$this->table}` ({$field_list}) VALUES ($value_list)";

        if ($this->db->query($sql)) {

            // Insert succeed, return the last record&rsquo;s id

            return $this->db->getInsertId();

            //return true;

        } else {

            // Insert fail, return false

            return false;

        }

       

    }

    /**

     * Update records

     * @access public

     * @param $list array associative array needs to be updated

     * @return mixed If succeed return the count of affected rows, else return false

     */

    public function update($list){

        $uplist = ''; //update fields

        $where = 0;   //update condition, default is 0

        foreach ($list as $k => $v) {

            if (in_array($k, $this->fields)) {

                if ($k == $this->fields['pk']) {

                    // If it&rsquo;s PK, construct where condition

                    $where = "`$k`=$v";

                } else {

                    // If not PK, construct update list

                    $uplist .= "`$k`='$v'".",";

                }

            }

        }

        // Trim comma on the right of update list

        $uplist = rtrim($uplist,',');

        // Construct SQL statement

        $sql = "UPDATE `{$this->table}` SET {$uplist} WHERE {$where}";

       

        if ($this->db->query($sql)) {

            // If succeed, return the count of affected rows

            if ($rows = mysql_affected_rows()) {

                // Has count of affected rows  

                return $rows;

            } else {

                // No count of affected rows, hence no update operation

                return false;

            }    

        } else {

            // If fail, return false

            return false;

        }

       

    }

    /**

     * Delete records

     * @access public

     * @param $pk mixed could be an int or an array

     * @return mixed If succeed, return the count of deleted records, if fail, return false

     */

    public function delete($pk){

        $where = 0; //condition string

        //Check if $pk is a single value or array, and construct where condition accordingly

        if (is_array($pk)) {

            // array

            $where = "`{$this->fields['pk']}` in (".implode(',', $pk).")";

        } else {

            // single value

            $where = "`{$this->fields['pk']}`=$pk";

        }

        // Construct SQL statement

        $sql = "DELETE FROM `{$this->table}` WHERE $where";

        if ($this->db->query($sql)) {

            // If succeed, return the count of affected rows

            if ($rows = mysql_affected_rows()) {

                // Has count of affected rows

                return $rows;

            } else {

                // No count of affected rows, hence no delete operation

                return false;

            }        

        } else {

            // If fail, return false

            return false;

        }

    }

    /**

     * Get info based on PK

     * @param $pk int Primary Key

     * @return array an array of single record

     */

    public function selectByPk($pk){

        $sql = "select * from `{$this->table}` where `{$this->fields['pk']}`=$pk";

        return $this->db->getRow($sql);

    }

    /**

     * Get the count of all records

     *

     */

    public function total(){

        $sql = "select count(*) from {$this->table}";

        return $this->db->getOne($sql);

    }

    /**

     * Get info of pagination

     * @param $offset int offset value

     * @param $limit int number of records of each fetch

     * @param $where string where condition,default is empty

     */

    public function pageRows($offset, $limit,$where = ''){

        if (empty($where)){

            $sql = "select * from {$this->table} limit $offset, $limit";

        } else {

            $sql = "select * from {$this->table}  where $where limit $offset, $limit";

        }

       

        return $this->db->getAll($sql);

    }

}

现在我们可以在application下创建一个User模型，对应数据库里的user表：

<?php

// application/models/UserModel.class.php

class UserModel extends Model{


    public function getUsers(){

        $sql = "select * from $this->table";

        $users = $this->db->getAll($sql);

        return $users;

    }

}

后台的indexController：

<?php

// application/controllers/admin/IndexController.class.php


class IndexController extends BaseController{

    public function mainAction(){

        include CURR_VIEW_PATH . "main.html";

        // Load Captcha class

        $this->loader->library("Captcha");

        $captcha = new Captcha;

        $captcha->hello();

        $userModel = new UserModel("user");

        $users = $userModel->getUsers();

    }

    public function indexAction(){

                       $userModel = new UserModel("user");

        $users = $userModel->getUsers();

        // Load View template

        include  CURR_VIEW_PATH . "index.html";

    }

    public function menuAction(){

        include CURR_VIEW_PATH . "menu.html";

    }

    public function dragAction(){

        include CURR_VIEW_PATH . "drag.html";

    }

    public function topAction(){

        include CURR_VIEW_PATH . "top.html";

    }

}

到目前为止，我们后台的index控制器就正常执行了，控制器中实例化了模型类，并且将得到的数据传给了视图中的模板，这样在浏览器中就能看到数据了。

 

这是一篇非常精简的文章去介绍如何去建立一个微型PHP MVC框架，希望可以阐释清楚MVC框架中的一些关键概念。