阮一峰譯：PHP最佳實踐

2024-09-04 11:50:18

字體：大中小

來源：轉載

供稿：網友

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

雖然名字叫《PHP最佳實踐》，但是它主要談的不是編程規則，而是PHP應用程序的合理架構。

它提供了一種邏輯和數據分離的架構模式，屬于MVC模式的一種實踐。我覺得，這是很有參考價值的學習資料，類似的文章網上并不多，所以一邊學習，一邊就把它翻譯了出來。

根據自己的理解，我總結了它的MVC模式的實現方式（詳細解釋見譯文）：

　　* 視圖層（View）：前端網頁；
　　* 邏輯層（Controller）：先是頁邏輯（Page Controller），負責處理頁面請求；然后，調用業務邏輯（Business Controller），實現具體功能；
　　* 數據層（Model）：數據保存在數據庫之中，上面有一個數據庫抽象層，再上面則是一個"數據訪問對象"（DAO），它生成"值對象"（Value Object）。業務邏輯通過DAO，操作值對象。

=======================================

PHP最佳實踐

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

譯者：阮一峰

本文給出了PHP程序設計常見問題的解決方法，同時簡單描述了PHP應用程序的架構。

1. php.ini設置

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

i. short_open_tag

設為0，即永遠使用PHP的長標簽形式：<?php echo "hello world"; ?>，不用短標簽形式<?= "hello world" ?>。

ii. asp_tags

設為0，不使用ASP標簽<% echo "hello world"; %>。

iii. magic_quotes_gpc

建議在腳本中包含一個全局文件，負責在讀取$_GET、$_POST、$_COOKIE變量之前，首先檢查這個設置是否打開，如果打開了，這對這些變量應用stripslashes函數。（注：該設置已經在PHP 5.3中被廢除。）

iv. register_globals

不要依賴這個設置，永遠通過全局變量$_GET、$_POST、$_COOKIE去讀取GET、POST和COOKIE的值。為了方便起見，建議聲明$PHP_SELF = $_SERVER['PHP_SELF']。

v. file_uploads

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

　　* file_uploads必須設為1（默認值），表示允許上傳。
　　* memory_limit必須略大于post_max_size和upload_max_filesize。
　　* post_max_size和upload_max_filesize要足夠大，能滿足上傳的需要。

2. 配置文件（configuration file）

你應該把與應用程序相關的所有配置，寫在一個文件里。這樣你就能很方便地適應開發環境的變化。配置文件通常包含以下信息：數據庫參數、email地址、各類選項、debug和logging輸出開關、應用程序常數。

3. 名稱空間（namespace）

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

4. 數據庫抽象層

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

5. "值對象"（Value Object, VO）

值對象（VO）在形式上，就像C語言的struct結構。它是一個只包含屬性、不包含任何方法（或只包含很少方法）的類。一個值對象，就對應一個實體。它的屬性，通常應該與數據庫的字段名保持相同。此外，還應該有一個ID屬性。

　　class Person {
　　　　var $id, $first_name, $last_name, $email;
　　}

6. 數據訪問對象（Data Access Object, DAO）

數據訪問對象（DAO）的作用，主要是將數據庫訪問與其他代碼相隔離。DAO應該是可以疊加（stacked）的，這樣就有利于將來你再添加數據庫緩存。每一個值對象的類，都應該有自己的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通常應該部署以下方法：

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

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

但是，所有的DAO方法都應該與數據庫操作有關，不應該執行其他操作。DAO只應該對一張表進行基本的select / insert / update，不應該包含業務邏輯。舉例來說，PersonDAO就不應該包含向某人發送Email的代碼。

你可以寫一個工廠函數，根據不同的類名，返回相應的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. 自動生成代碼

99%的值對象和DAO代碼，可以根據數據庫模式（schema）自動生成，前提是你的表和列使用約定的方式進行命名。如果你修改數據庫模式，一個自動生成代碼的腳本將大大節省你的時間。

8. 業務邏輯

業務邏輯直接反映使用者的需要。它們處理值對象，根據業務需要修改值對象的屬性，使用DAO與數據庫層交互。

　　class NewsletterLogic {
　　　　function NewsletterLogic() {
　　　　　　...
　　　　}
　　　　function subscribePerson(&$person) {
　　　　　　...
　　　　}
　　　　function unsubscribePerson(&$person) {
　　　　　　...
　　　　}
　　　　function sendNewsletter(&$newsletter) {
　　　　　　...
　　　　}
　　}

9. 頁邏輯（控制器）

當一個網頁被請求時，頁控制器（page controller）就會運行，然后產生輸出。控制器的任務，就是將HTTP請求轉化成業務對象（business object），然后調用相應的業務邏輯，最后生成一個"展示輸出"的對象。

頁邏輯依次執行以下步驟（請參照后面的PageController類的代碼）：

　　i. 假定頁面請求之中，包含一個cmd參數。
　　ii. 根據cmd參數的值，執行相應的動作。
　　iii. 驗證頁面返回的值，生成一個值對象。
　　iv. 針對值對象，執行業務邏輯。
　　v. 如果有必要，可以導向另一個頁面。
　　vi. 收集必要的數據，輸出結果。

注意：可以編寫一個工具函數（utility function），處理GET或POST值，當有的變量沒有賦值時，提供一個默認值。頁邏輯不包含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. 表現層（Presentation Layer）

最頂層的頁面包含實際的HTML代碼。這個頁面需要的所有業務對象（business object），由頁邏輯提供。

這個頁面先讀取業務對象的屬性，然后將它們轉換成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）

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

　　A) 準備多重頁面。
　　B) HTML頁面中去除特定語言相關的內容。

一般來說，A方法用得比較多，因為B方法會使得HTML頁面的可讀性很差。

所以，你可以先寫完一種語言的頁面，然后把它們進行拷貝，用某種命名法區別不同語言的版本，比如index_fr.php表示index.php的法語版。

為了保存用戶的語言選擇，你有幾種方法：

　　A) 將語言設定保存在一個session變量或cookie之中；
　　B) 從HTTP頭中讀取locale值；
　　C) 把語言設定作為一個參數，追加在每個URL后面。

看上去A方法比C方法容易得多（雖然session和cookie都有過期的問題），而B方法只能作為A或C的補充。

最后不要忘了，數據庫中的字段也必須進行本地化。

12. 安裝位置

有時候你需要知道程序的根目錄在哪里，但是$_SERVER['DOCUMENT_ROOT']只是web服務器的根目錄，如果你的程序安裝在它的某個子目錄之中，PHP沒法自動知道。

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

13. 目錄結構

首先，每個類都應該有自己的獨立文件，還必須有一套文件名的命名規則（naming convention）。

軟件的目錄結構可以采用如下形式：

　　/ 根目錄。瀏覽器從這個頁面開始訪問。
　　/lib/ 包含全局變量（base.inc.php）和配置文件（config.inc.php）。
　　/lib/common/ 包含其他項目也可以共用的庫，比如數據庫抽象層。
　　/lib/model/ 包含值對象類。
　　/lib/dao/ 包含數據訪問對象（DAO）類，以及DAO工廠函數。
　　/lib/logic/ 包含業務邏輯類。
　　/parts/ 包含HTML模板文件。
　　/control/ 包含頁邏輯。對于大型程序來說，這個目錄下面可能還有子目錄（比如admin/, /pub/）。

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