PHP最佳實踐

阮一峰發表於2010-12-27

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

雖然名字叫《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檔案中,應該按照以下順序新增包含檔案:

  * /lib/common之中經常使用的類(比如資料庫層)。

  * 配置檔案;

  * /lib/model之中所有類;

  * /lib/dao的之中所有類。

至於那些存放圖片、上傳檔案的目錄,這裡就省略了。

(完)

相關文章