PHP入門教程之編寫自己的PHP框架

weixin_34321977發表於2017-06-04

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 檔案,內容為:

mod_rewrite.c> # 開啟Rerite功能 RewriteEngine On # 如果請求的是真實存在的檔案或目錄,直接訪問

RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d

# 如果訪問的檔案或目錄不是真事存在,分發請求至 index.php RewriteRule .

index.php

如果是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 入口檔案,檔案內容為:


應用目錄為當前目錄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 檔案內容如下,作用是定義資料庫連線引數引數,以及配置預設控制器名和操作名:


資料庫配置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()方法則呼叫用類自身方法,完成:自動載入類檔案、監測開發環境、過濾敏感字元、移除全域性變數的老用法、和處理路由。


* 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名就是:itemaction名就是:viewURL引數就是:array(1, hello)

分割完成後,再例項化控制器:itemController,並呼叫其中的view方法 。

3.7 Controller基類

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

新建控制器基類,檔名 Controller.class.php,功能就是總排程,內容如下:

_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,程式碼如下:


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,程式碼如下:

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 內容如下:

_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 模型,內容如下:


* 使用者模組,一般與資料庫表名對應 * 例如表名為:item,那麼Model類名應該為:ItemModel *

也可以新增一個$_table屬性指定表名 */class ItemModel extends Model{ public $_table =

'item'; }

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

4.3 部署控制器

在 controllers 目錄下建立一個 ItemController.php 控制器,內容如下:

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 內容:

/> <?php echo $title ?>

rel="stylesheet" href="/static/css/main.css" type="text/css"

/>

?>

footer.php 內容:

頁標頭檔案用到了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 表的所有記錄,內容:


---- 刪除

add.php,新增記錄,內容:

成功新增條記錄,點選返回

view.php,檢視單條記錄,內容:

" type="text"> " type="hidden"> 返回

update.php,更改記錄,內容:

成功修改項,點選返回

delete.php,刪除記錄,內容:

成功刪除項,點選返回

4.5 應用測試

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

以上程式碼已經全部發布到 github 上,關鍵部分加了註釋:

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

著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。網際網路+時代,時刻要保持學習,攜手千鋒PHP,Dream It Possible。

相關文章