PHP程序設(shè)計最佳實踐
這篇文章給出了PHP程序設(shè)計常見問題的解決方法，同時也簡單的描述了PHP應(yīng)用程序的架構(gòu)，這些問題很多都是在開發(fā)項目中容易出現(xiàn)的。
推薦專題：PHP開發(fā)基礎(chǔ)入門
1. php.ini設(shè)置
php.ini控制了解釋器的行為，下面的一些設(shè)置保證了你的程序有最大的可移植性。
◆short_open_tag
設(shè)為0，即永遠(yuǎn)使用PHP的長標(biāo)簽形式：<?php echo "hello world"; ?>，不用短標(biāo)簽形式<?= "hello world" ?>。
◆asp_tags
設(shè)為0，不使用ASP標(biāo)簽<% echo "hello world"; %>。
◆magic_quotes_gpc
建議在腳本中包含一個全局文件，負(fù)責(zé)在讀取$_GET、$_POST、$_COOKIE變量之前，首先檢查這個設(shè)置是否打開，如果打開了，這對這些變量應(yīng)用stripslashes函數(shù)。（注：該設(shè)置已經(jīng)在PHP 5.3中被廢除。）
◆register_globals
不要依賴這個設(shè)置，永遠(yuǎn)通過全局變量$_GET、$_POST、$_COOKIE去讀取GET、POST和COOKIE的值。為了方便起見，建議聲明$PHP_SELF = $_SERVER['PHP_SELF']。
◆file_uploads
上傳文件的最大大小，由下面的設(shè)置決定：
- * file_uploads必須設(shè)為1（默認(rèn)值），表示允許上傳。
- * memory_limit必須略大于post_max_size和upload_max_filesize。
- * post_max_size和upload_max_filesize要足夠大，能滿足上傳的需要。
2. 配置文件（configuration file）
你應(yīng)該把與應(yīng)用程序相關(guān)的所有配置，寫在一個文件里。這樣你就能很方便地適應(yīng)開發(fā)環(huán)境的變化。配置文件通常包含以下信息：數(shù)據(jù)庫參數(shù)、email地址、各類選項、debug和logging輸出開關(guān)、應(yīng)用程序常數(shù)。
3. 名稱空間（namespace）
選擇類和函數(shù)名的時候，必須很小心，避免出現(xiàn)重名。盡可能不要在類以外，放置全局性函數(shù)，類對內(nèi)部的屬性和方法，相當(dāng)于有一層名稱空間保護(hù)。如果你確實有必要聲明全局性函數(shù)，那么使用一個前綴，比如dao_factory()、 db_getConnection()、text_parseDate()等等。
4. 數(shù)據(jù)庫抽象層
PHP不提供數(shù)據(jù)庫操作的通用函數(shù)，每種數(shù)據(jù)庫都有一套自己的函數(shù)。你不應(yīng)該直接使用這些函數(shù)，否則一旦改用其他數(shù)據(jù)庫（比如從MySQL 轉(zhuǎn)為Oracle），你就有大麻煩了。而且，數(shù)據(jù)庫抽象層通常比系統(tǒng)本身的數(shù)據(jù)庫函數(shù)，更易用一些。
5. "值對象"（Value Object, VO）
值對象（VO）在形式上，就像C語言的struct結(jié)構(gòu)。它是一個只包含屬性、不包含任何方法（或只包含很少方法）的類。一個值對象，就對應(yīng)一個實體。它的屬性，通常應(yīng)該與數(shù)據(jù)庫的字段名保持相同。此外，還應(yīng)該有一個ID屬性。
- class Person {
- var $id, $first_name, $last_name, $email;
- }
6. 數(shù)據(jù)訪問對象
數(shù)據(jù)訪問對象（DAO）的作用，主要是將數(shù)據(jù)庫訪問與其他代碼相隔離。DAO應(yīng)該是可以疊加（stacked）的，這樣就有利于將來你再添加數(shù)據(jù)庫緩存。每一個值對象的類，都應(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方法，常見的例子有isUsed()、getTop($n)、find($criteria)。
但是，所有的DAO方法都應(yīng)該與數(shù)據(jù)庫操作有關(guān)，不應(yīng)該執(zhí)行其他操作。DAO只應(yīng)該對一張表進(jìn)行基本的select / insert / update，不應(yīng)該包含業(yè)務(wù)邏輯。舉例來說，PersonDAO就不應(yīng)該包含向某人發(fā)送Email的代碼。你可以寫一個工廠函數(shù)，根據(jù)不同的類名，返回相應(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);
- ...
- }
- }
#p#
7. 自動生成代碼
99%的值對象和DAO代碼，可以根據(jù)數(shù)據(jù)庫模式（schema）自動生成，前提是你的表和列使用約定的方式進(jìn)行命名。如果你修改數(shù)據(jù)庫模式，一個自動生成代碼的腳本將大大節(jié)省你的時間。
8. 業(yè)務(wù)邏輯
業(yè)務(wù)邏輯直接反映使用者的需要。它們處理值對象，根據(jù)業(yè)務(wù)需要修改值對象的屬性，使用DAO與數(shù)據(jù)庫層交互。
- class NewsletterLogic {
- function NewsletterLogic() {
- ...
- }
- function subscribePerson(&$person) {
- ...
- }
- function unsubscribePerson(&$person) {
- ...
- }
- function sendNewsletter(&$newsletter) {
- ...
- }
- }
9. 頁邏輯（控制器）
當(dāng)一個網(wǎng)頁被請求時，頁控制器（page controller）就會運行，然后產(chǎn)生輸出。控制器的任務(wù)，就是將HTTP請求轉(zhuǎn)化成業(yè)務(wù)對象（business object），然后調(diào)用相應(yīng)的業(yè)務(wù)邏輯，最后生成一個"展示輸出"的對象。
頁邏輯依次執(zhí)行以下步驟（請參照后面的PageController類的代碼）：
◆假定頁面請求之中，包含一個cmd參數(shù)。
◆根據(jù)cmd參數(shù)的值，執(zhí)行相應(yīng)的動作。
◆驗證頁面返回的值，生成一個值對象。
◆針對值對象，執(zhí)行業(yè)務(wù)邏輯。
◆如果有必要，可以導(dǎo)向另一個頁面。
◆收集必要的數(shù)據(jù)，輸出結(jié)果。
注意：可以編寫一個工具函數(shù)（utility function），處理GET或POST值，當(dāng)有的變量沒有賦值時，提供一個默認(rèn)值。頁邏輯不包含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)層
最頂層的頁面包含實際的HTML代碼。這個頁面需要的所有業(yè)務(wù)對象（business object），由頁邏輯提供。這個頁面先讀取業(yè)務(wù)對象的屬性，然后將它們轉(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）
本地化意味著要支持多種語言，這個比較麻煩，你無非有兩種方法可以選擇：
A) 準(zhǔn)備多重頁面。
B) HTML頁面中去除特定語言相關(guān)的內(nèi)容。
一般來說，A方法用得比較多，因為B方法會使得HTML頁面的可讀性很差。所以，你可以先寫完一種語言的頁面，然后把它們進(jìn)行拷貝，用某種命名法區(qū)別不同語言的版本，比如index_fr.php表示index.php的法語版。為了保存用戶的語言選擇，你有幾種方法：
A) 將語言設(shè)定保存在一個session變量或cookie之中；
B) 從HTTP頭中讀取locale值；
C) 把語言設(shè)定作為一個參數(shù)，追加在每個URL后面。
看上去A方法比C方法容易得多（雖然session和cookie都有過期的問題），而B方法只能作為A或C的補(bǔ)充。最后不要忘了，數(shù)據(jù)庫中的字段也必須進(jìn)行本地化。
12. 安裝位置
有時候你需要知道程序的根目錄在哪里，但是$_SERVER['DOCUMENT_ROOT']只是web服務(wù)器的根目錄，如果你的程序安裝在它的某個子目錄之中，PHP沒法自動知道。
你可以定義一個全局變量$ROOT，它的值就是程序的根目錄，然后把它包含在每一個腳本文件中。那么，你要包含某個文件，就這樣寫require_once("$ROOT/lib/base.inc.php");。
13. 目錄結(jié)構(gòu)
首先，每個類都應(yīng)該有自己的獨立文件，還必須有一套文件名的命名規(guī)則（naming convention）。軟件的目錄結(jié)構(gòu)可以采用如下形式：
- / 根目錄。瀏覽器從這個頁面開始訪問。
- /lib/ 包含全局變量（base.inc.php）和配置文件（config.inc.php）。
- /lib/common/ 包含其他項目也可以共用的庫，比如數(shù)據(jù)庫抽象層。
- /lib/model/ 包含值對象類。
- /lib/dao/ 包含數(shù)據(jù)訪問對象（DAO）類，以及DAO工廠函數(shù)。
- /lib/logic/ 包含業(yè)務(wù)邏輯類。
- /parts/ 包含HTML模板文件。
- /control/ 包含頁邏輯。對于大型程序來說，這個目錄下面可能還有子目錄（比如admin/, /pub/）。
base.inc.php文件中，應(yīng)該按照以下順序添加包含文件：
- * /lib/common之中經(jīng)常使用的類（比如數(shù)據(jù)庫層）。
- * 配置文件；
- * /lib/model之中所有類；
- * /lib/dao的之中所有類。
至于那些存放圖片、上傳文件的目錄，這里就省略了。
原文地址：http://www.ruanyifeng.com/blog/2010/12/php_best_practices.html
【編輯推薦】
