今天下午，我在讀下面這篇文章。

　　雖然名字叫 《PHP最佳實(shí)踐》 ，但是它主要談的不是編程規(guī)則，而是PHP應(yīng)用程序的合理架構(gòu)。

　　它提供了一種邏輯和數(shù)據(jù)分離的架構(gòu)模式，屬于 MVC模式 的一種實(shí)踐。我覺(jué)得，這是很有參考價(jià)值的學(xué)習(xí)資料，類(lèi)似的文章網(wǎng)上并不多，所以一邊學(xué)習(xí)，一邊就把它翻譯了出來(lái)。

　　根據(jù)自己的理解，我總結(jié)了它的MVC模式的實(shí)現(xiàn)方式（詳細(xì)解釋見(jiàn)譯文）：

*? 視圖層（View） ：前端網(wǎng)頁(yè)；

*? 邏輯層（Controller） ：先是頁(yè)邏輯（Page Controller），負(fù)責(zé)處理頁(yè)面請(qǐng)求；然后，調(diào)用業(yè)務(wù)邏輯（Business Controller），實(shí)現(xiàn)具體功能；

*? 數(shù)據(jù)層（Model） ：數(shù)據(jù)保存在數(shù)據(jù)庫(kù)之中，上面有一個(gè)數(shù)據(jù)庫(kù)抽象層，再上面則是一個(gè)"數(shù)據(jù)訪(fǎng)問(wèn)對(duì)象"（DAO），它生成"值對(duì)象"（Value Object）。業(yè)務(wù)邏輯通過(guò)DAO，操作值對(duì)象。

PHP最佳實(shí)踐

　　原載： http://www.odi.ch/prog/design/php/guide.php

　　譯者：阮一峰

　　本文給出了PHP程序設(shè)計(jì)常見(jiàn)問(wèn)題的解決方法，同時(shí)簡(jiǎn)單描述了PHP應(yīng)用程序的架構(gòu)。

1. php.ini設(shè)置

　　php.ini控制了解釋器的行為，下面的一些設(shè)置保證了你的程序有最大的可移植性。

　　i. short_open_tag

　　設(shè)為0，即永遠(yuǎn)使用PHP的長(zhǎng)標(biāo)簽形式：<?php echo "hello world"; ?>，不用短標(biāo)簽形式<?= "hello world" ?>。

　　ii. asp_tags

　　設(shè)為0，不使用ASP標(biāo)簽<% echo "hello world"; %>。

　　iii. magic_quotes_gpc

　　建議在腳本中包含一個(gè)全局文件，負(fù)責(zé)在讀取$_GET、$_POST、$_COOKIE變量之前，首先檢查這個(gè)設(shè)置是否打開(kāi)，如果打開(kāi)了，這對(duì)這些變量應(yīng)用stripslashes函數(shù)。（注：該設(shè)置已經(jīng)在PHP 5.3中被廢除。）

　　iv. register_globals

　　不要依賴(lài)這個(gè)設(shè)置，永遠(yuǎn)通過(guò)全局變量$_GET、$_POST、$_COOKIE去讀取GET、POST和COOKIE的值。為了方便起見(jiàn)，建議聲明$PHP_SELF = $_SERVER['PHP_SELF']。

　　v. file_uploads

　　上傳文件的最大大小，由下面的設(shè)置決定：

* file_uploads必須設(shè)為1（默認(rèn)值），表示允許上傳。

* memory_limit必須略大于post_max_size和upload_max_filesize。

* post_max_size和upload_max_filesize要足夠大，能滿(mǎn)足上傳的需要。

2. 配置文件（configuration file）

　　你應(yīng)該把與應(yīng)用程序相關(guān)的所有配置，寫(xiě)在一個(gè)文件里。這樣你就能很方便地適應(yīng)開(kāi)發(fā)環(huán)境的變化。配置文件通常包含以下信息：數(shù)據(jù)庫(kù)參數(shù)、email地址、各類(lèi)選項(xiàng)、debug和logging輸出開(kāi)關(guān)、應(yīng)用程序常數(shù)。

3. 名稱(chēng)空間（namespace）

　　選擇類(lèi)和函數(shù)名的時(shí)候，必須很小心，避免出現(xiàn)重名。盡可能不要在類(lèi)以外，放置全局性函數(shù)，類(lèi)對(duì)內(nèi)部的屬性和方法，相當(dāng)于有一層名稱(chēng)空間保護(hù)。如果你確實(shí)有必要聲明全局性函數(shù)，那么使用一個(gè)前綴，比如dao_factory()、 db_getConnection()、text_parseDate()等等。

4. 數(shù)據(jù)庫(kù)抽象層

　　PHP不提供數(shù)據(jù)庫(kù)操作的通用函數(shù)，每種數(shù)據(jù)庫(kù)都有一套自己的函數(shù)。你不應(yīng)該直接使用這些函數(shù)，否則一旦改用其他數(shù)據(jù)庫(kù)（比如從MySQL 轉(zhuǎn)為Oracle），你就有大麻煩了。而且，數(shù)據(jù)庫(kù)抽象層通常比系統(tǒng)本身的數(shù)據(jù)庫(kù)函數(shù)，更易用一些。

5. "值對(duì)象"（Value Object, VO）

　　值對(duì)象（VO）在形式上，就像C語(yǔ)言的struct結(jié)構(gòu)。它是一個(gè)只包含屬性、不包含任何方法（或只包含很少方法）的類(lèi)。一個(gè)值對(duì)象，就對(duì)應(yīng)一個(gè)實(shí)體。它的屬性，通常應(yīng)該與數(shù)據(jù)庫(kù)的字段名保持相同。此外，還應(yīng)該有一個(gè)ID屬性。

class Person {

var $id, $first_name, $last_name, $email;

}

6. 數(shù)據(jù)訪(fǎng)問(wèn)對(duì)象（Data Access Object, DAO）

　　數(shù)據(jù)訪(fǎng)問(wèn)對(duì)象（DAO）的作用，主要是將數(shù)據(jù)庫(kù)訪(fǎng)問(wèn)與其他代碼相隔離。DAO應(yīng)該是可以疊加（stacked）的，這樣就有利于將來(lái)你再添加數(shù)據(jù)庫(kù)緩存。每一個(gè)值對(duì)象的類(lèi)，都應(yīng)該有自己的DAO。

class PersonDAO {
　　　　var $conn;

function PersonDAO(&$conn) {
　　　　　　$this->conn =& $conn;
　　　　}

function save(&$vo) {
　　　　　　if ($v->id == 0) {
　　　　　　　　$this->insert($vo);
　　　　　　} else {
　　　　　　　　$this->update($vo);
　　　　　　}
　　　　}

function get($id) {
　　　　　　#execute select statement
　　　　　　#create new vo and call getFromResult
　　　　　　#return vo
　　　　}

function delete(&$vo) {
　　　　　　#execute delete statement
　　　　　　#set id on vo to 0
　　　　}

#-- private functions

function getFromResult(&vo, $result) {
　　　　　　#fill vo from the database result set
　　　　}

function update(&$vo) {
　　　　　　#execute update statement here
　　　　}

function insert(&$vo) {
　　　　　　#generate id (from Oracle sequence or automatically)
　　　　　　#insert record into db
　　　　　　#set id on vo
　　　　}
　　}

　　DAO通常應(yīng)該部署以下方法：

* save：插入或更新一條記錄
　　* get：取出一條記錄
　　* delete：刪除一條記錄

　　你可以根據(jù)自己的需要，添加其他DAO方法，常見(jiàn)的例子有isUsed()、getTop($n)、find($criteria)。

　　但是，所有的DAO方法都應(yīng)該與數(shù)據(jù)庫(kù)操作有關(guān)，不應(yīng)該執(zhí)行其他操作。DAO只應(yīng)該對(duì)一張表進(jìn)行基本的select / insert / update，不應(yīng)該包含業(yè)務(wù)邏輯。舉例來(lái)說(shuō)，PersonDAO就不應(yīng)該包含向某人發(fā)送Email的代碼。

　　你可以寫(xiě)一個(gè)工廠(chǎng)函數(shù)，根據(jù)不同的類(lèi)名，返回相應(yīng)的DAO。

function dao_getDAO($vo_class) {

$conn = db_conn('default'); #get a connection from the pool

switch ($vo_class) {

case "person": return new PersonDAO($conn);

case "newsletter": return new NewsletterDAO($conn);

...

}

}

7. 自動(dòng)生成代碼

　　99%的值對(duì)象和DAO代碼，可以根據(jù)數(shù)據(jù)庫(kù)模式（schema）自動(dòng)生成，前提是你的表和列使用約定的方式進(jìn)行命名。如果你修改數(shù)據(jù)庫(kù)模式，一個(gè)自動(dòng)生成代碼的腳本將大大節(jié)省你的時(shí)間。

8. 業(yè)務(wù)邏輯

　　業(yè)務(wù)邏輯直接反映使用者的需要。它們處理值對(duì)象，根據(jù)業(yè)務(wù)需要修改值對(duì)象的屬性，使用DAO與數(shù)據(jù)庫(kù)層交互。

class NewsletterLogic {
　　　　function NewsletterLogic() {
　　　　　　...
　　　　}

function subscribePerson(&$person) {
　　　　　　...
　　　　}

function unsubscribePerson(&$person) {
　　　　　　...
　　　　}

function sendNewsletter(&$newsletter) {
　　　　　　...
　　　　}
　　}

9. 頁(yè)邏輯（控制器）

　　當(dāng)一個(gè)網(wǎng)頁(yè)被請(qǐng)求時(shí)，頁(yè)控制器（page controller）就會(huì)運(yùn)行，然后產(chǎn)生輸出。控制器的任務(wù)，就是將HTTP請(qǐng)求轉(zhuǎn)化成業(yè)務(wù)對(duì)象（business object），然后調(diào)用相應(yīng)的業(yè)務(wù)邏輯，生成展示輸出的對(duì)象。

　　頁(yè)邏輯依次執(zhí)行以下步驟（請(qǐng)參照后面的PageController類(lèi)的代碼）：

i. 假定頁(yè)面請(qǐng)求之中，包含一個(gè)cmd參數(shù)。

ii. 根據(jù)cmd參數(shù)的值，執(zhí)行相應(yīng)的動(dòng)作。

iii. 驗(yàn)證頁(yè)面返回的值，生成一個(gè)值對(duì)象。

iv. 針對(duì)值對(duì)象，執(zhí)行業(yè)務(wù)邏輯。

v. 如果有必要，可以導(dǎo)向另一個(gè)頁(yè)面。

vi. 收集必要的數(shù)據(jù)，輸出結(jié)果。

　　注意：可以編寫(xiě)一個(gè)工具函數(shù)（utility function），處理GET或POST值，當(dāng)有的變量沒(méi)有賦值時(shí)，提供一個(gè)默認(rèn)值。頁(yè)邏輯不包含HTML代碼。

class PageController {
　　　　var $person; #$person is used by the HTML page
　　　　var $errs;

function PageController() {
　　　　　　$action = Form::getParameter('cmd');
　　　　　　$this->person = new Person();
　　　　　　$this->errs = array();

if ($action == 'save') {
　　　　　　　　$this->parseForm();
　　　　　　　　if (!this->validate()) return;

NewsletterLogic::subscribe($this->person);

header('Location: confirmation.php');
　　　　　　　　exit;
　　　　　　}
　　　　}

function parseForm() {
　　　　　　$this->person->name = Form::getParameter('name');
　　　　　　$this->person->birthdate = Util::parseDate(Form::getParameter('birthdate');
　　　　　　...
　　　　}

function validate() {
　　　　　　if ($this->person->name == '') $this->errs['name'] = FORM_MISSING;
　　　　　　#FORM_MISSING is a constant
　　　　　　...
　　　　　　return (sizeof($this->errs) == 0);
　　　　}
　　}

10. 表現(xiàn)層（Presentation Layer）

　　最頂層的頁(yè)面包含實(shí)際的HTML代碼。這個(gè)頁(yè)面需要的所有業(yè)務(wù)對(duì)象（business object），由頁(yè)邏輯提供。

　　這個(gè)頁(yè)面先讀取業(yè)務(wù)對(duì)象的屬性，然后將它們轉(zhuǎn)換成HTML格式。

<?php
　　　　require_once('control/ctl_person.inc.php'); #the page controller
　　　　$c =& new PageController();
　　?>

<html>
　　<body>
　　<form action="<?php echo htmlspecialchars($PHP_SELF) ?>" method="POST">
　　　　<input type="hidden" name="cmd" value="save">
　　　　<input type="text" name="name"
value="<?php echo htmlspecialchars($c->person->name); ?>">
　　　　<button type="submit">Subscribe</button>
　　</form>
　　</body>
　　</html>

11. 本地化（Localization）

　　本地化意味著要支持多種語(yǔ)言，這個(gè)比較麻煩，你無(wú)非有兩種方法可以選擇：

A) 準(zhǔn)備多重頁(yè)面。

B) HTML頁(yè)面中去除特定語(yǔ)言相關(guān)的內(nèi)容。

　　一般來(lái)說(shuō)，A方法用得比較多，因?yàn)锽方法會(huì)使得HTML頁(yè)面的可讀性很差。

　　所以，你可以先寫(xiě)完一種語(yǔ)言的頁(yè)面，然后把它們進(jìn)行拷貝，用某種命名法區(qū)別不同語(yǔ)言的版本，比如index_fr.php表示index.php的法語(yǔ)版。

　　為了保存用戶(hù)的語(yǔ)言選擇，你有幾種方法：

A) 將語(yǔ)言設(shè)定保存在一個(gè)session變量或cookie之中；

B) 從HTTP頭中讀取locale值；

C) 把語(yǔ)言設(shè)定作為一個(gè)參數(shù)，追加在每個(gè)URL后面。

　　看上去A方法比C方法容易得多（雖然session和cookie都有過(guò)期的問(wèn)題），而B(niǎo)方法只能作為A或C的補(bǔ)充。

　　最后不要忘了，數(shù)據(jù)庫(kù)中的字段也必須進(jìn)行本地化。

12. 安裝位置

　　有時(shí)候你需要知道程序的根目錄在哪里，但是$_SERVER['DOCUMENT_ROOT']只是web服務(wù)器的根目錄，如果你的程序安裝在它的某個(gè)子目錄之中，PHP沒(méi)法自動(dòng)知道。

　　你可以定義一個(gè)全局變量$ROOT，它的值就是程序的根目錄，然后把它包含在每一個(gè)腳本文件中。那么，你要包含某個(gè)文件，就這樣寫(xiě)require_once("$ROOT/lib/base.inc.php");。

13. 目錄結(jié)構(gòu)

　　首先，每個(gè)類(lèi)都應(yīng)該有自己的獨(dú)立文件，還必須有一套文件名的命名規(guī)則（naming convention）。

　　軟件的目錄結(jié)構(gòu)可以采用如下形式：

/ 根目錄。瀏覽器從這個(gè)頁(yè)面開(kāi)始訪(fǎng)問(wèn)。

/lib/ 包含全局變量（base.inc.php）和配置文件（config.inc.php）。

/lib/common/ 包含其他項(xiàng)目也可以共用的庫(kù)，比如數(shù)據(jù)庫(kù)抽象層。

/lib/model/ 包含值對(duì)象類(lèi)。

/lib/dao/ 包含數(shù)據(jù)訪(fǎng)問(wèn)對(duì)象（DAO）類(lèi)，以及DAO工廠(chǎng)函數(shù)。

/lib/logic/ 包含業(yè)務(wù)邏輯類(lèi)。

/parts/ 包含HTML模板文件。

/control/ 包含頁(yè)邏輯。對(duì)于大型程序來(lái)說(shuō)，這個(gè)目錄下面可能還有子目錄（比如admin/， /pub/）。

　　base.inc.php文件中，應(yīng)該按照以下順序添加包含文件：

* /lib/common之中經(jīng)常使用的類(lèi)（比如數(shù)據(jù)庫(kù)層）。

* 配置文件；

* /lib/model之中所有類(lèi)；

* /lib/dao的之中所有類(lèi)。

　　至于那些存放圖片、上傳文件的目錄，這里就省略了。

PHP最佳實(shí)踐