高見龍

iOS app/Ruby/Rails Developer & Instructor, 喜愛非主流的新玩具 :)

Doctrine, the PHP ORM Framework

image

Doctrine是一個在PHP上的資料庫ORM(Object Relational Mapper),最近手邊的幾個小案子透過Doctrine來實作。ORM的確是讓開發者少寫不少的SQL查詢,但相對的效能一定是比簡單的SQL要來得 差,我想魚跟熊掌要兼得並不容易,便利跟效能之間總有個天平讓開發者來自已調整,所以ORM好不好用就見人見志囉。

一、前置作業:

1. 系統需求

依官網上面提到的,Doctrine需要PHP 5.2.3以上的版本,除此之外就不用再另外安裝其它的套件或函式庫即可運作,不過如果要使用PDO(PHP Data Object)的話,則可能會需要另外安裝PDO驅動程式。

2. 檢查PDO驅動程式

如果你要用PDO的話,想要知道你的主機上是不是有安裝你所需要的PDO驅動程式,只要一行簡單的PHP程式放到主機上執行:

1
<?php phpinfo(); ?>

如果你有看到一段PDO的資訊,那差不多應該就是有安裝了,再確認一下是不是有你要的版本,以及是否啟用即可。

二、取得原始檔

有幾種取得Doctrine的方法:

  • SVN(Subversion)
  • Pear
  • Zip-package

如果你熟悉SVN的操作的話,這應該是最簡單使用的了。如果你只是想試玩一下Doctrine的功能的話,你可以下載官網上打包好的Sandbox套件來玩。我個人比較喜歡官方打包好的壓縮檔 :)

什麼是Sandbox套件?

Doctrine網站的下載區有貼心的打包了免設定的方便套件,直接下載、解壓縮後,就可以拿來試玩了。這裡面包括了一些範例schema檔案以及可以匯入的資料檔,讓你可以很快的就可以開始體驗Doctrine的優點。

三、開始第一個專案

在Doctrine裡,Doctrine_Record是最基本的元件。資料庫裡的每個資料表都會有一個對應的Doctrine_Record類別。這個類別是以Active Record這個設計模式實作的,所以在其它語言像是在ROR(Ruby on Rails)上才看得到方便功能,在Doctrine裡也可以使用到了,即使是複雜的資料庫操作,透過這個類別也可以簡單的完成。

在使用Doctrine_Record來建立資料表時,如果沒有特別指定Primary Key的話,Doctrine會自動幫你加一個叫做id的主索引欄位(自動編號)。接下來你需要做的事情,就是建立一個繼承自 Doctrine_Record類別的子類別,然後透過setTableDefinition()以及hasColumn()就可以來建立你的資料表。

為了單純一些,我們這裡只先用一個表格做範例(多個表格之間的關聯性操作,例如一對一、一對多、多對多等關係,再另外開幾篇再寫)。假設我們現在要建立一個 叫做member的會員資料表,這個資料表裡會有id、username、password以及建立日期這幾個欄位,我們可以這樣做:

檔案:models/Member.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?php
     class Member extends Doctrine_Record
     {
         public function setTableDefinition()
         {
             // 預設將會使用跟"user"做為資料表的名稱(同名)
             // 並且會自動加一個欄位id的主索引鍵
             $this->hasColumn('username', 'string', 30);
             $this->hasColumn('password', 'string', 30);
         }

         public function setUp()
         {
             $this->actAs('Timestampable');
         }
     }

除了手工打造模型類別外,你也可以使用YAML格式的檔案來建立資料表的schema檔案,底下這個範例的設定跟上面這個類別是一樣的意思,而且也可以透過Doctrine的一些指令來互相轉換。

檔案:schemas/schema.yml

1
2
3
4
5
Member:
  columns:
    username: string(30)
    password: string(30)
  actAs: [Timestampable]

這裡要注意的是,YAML的縮排是有意義的,所以要特別注意縮排的層級。你可以用一行簡單的語法就可以把YAML檔案(.yml)轉換成模型類別(.php):

檔案:createMode.php

1
2
3
<?php
     require_once 'config/doctrine_config.php';
     Doctrine::generateModelsFromYaml('schemas/schema.yml', 'models');

執行之後看一下models資料夾有一個自動產生的generated資料夾(如下圖),你會看到有一個Member.php以 及BaseMember.php。其中,Member.php是可以讓你自己定義一些功能用的,而BaseMember.php裡的內容則是 依據YAML的內容幫你寫好的。(要特別注意BaseMember類別會在每次執行轉換的時候重新產生一次,而Member類別只會產生一次)。

image

我們現在有一個透過YAML建立的Doctrine_Record類別,接下來就可以把它匯入資料庫來建立資料表了。

檔案:modelToDatabase.php

1
2
3
4
<?php
     require_once 'config/doctrine_config.php';
     // 建立資料表
     Doctrine::createTablesFromArray(array('Member'));

這樣就搞定了!看一下資料表的樣子:

image

如前面說的,它會自動加上id這個欄位,而Timestampable則會自動幫忙加上created_atupdated_at這兩個欄位。

現在我們有一個資料表以及一個對應的模型類別可以讓我們來練習資料的基本操作了(新增、修改、刪除及查詢)。

新增:

檔案:testInsert.php

1
2
3
4
5
6
7
<?php
    require_once 'config/doctrine_config.php';

    $myTable = new Member;
    $myTable->username = 'eddie';
    $myTable->password = 'mypassword';
    $myTable->save();

資料表欄位的指定,除了上面這種物件式的存取方式外,也可以使用陣列的方式:

1
2
3
4
5
<?php
  $myTable = new Member;
  $myTable['username'] = 'eddie';
  $myTable['password'] = 'mypassword';
  $myTable->save();

不用寫什麼insert..into..,只要一個save()就完成了! 回頭看一下資料表就會發現,有一些神奇的事情它幫忙做了。上面這段程式碼執行後,member資料表會長得像這樣:

image

修改:

假設剛剛寫入的那筆資料的id編號是1號,更新方法是先找到它,然後一樣用save()來更新:

檔案:testUpdate.php

1
2
3
4
5
6
7
<?php
    require_once 'config/doctrine_config.php';

    $myTable = new Member;
    $record = $myTable->getTable()->find(1);
    $record->password = 'mynewpassword';
    $record->save();

結果如下:

image

你會發現,password欄位變成”mynewpassword”之外,它的更新時間(updated_at)也跟著更新了。

刪除:

跟更新差不多,也是先找到那筆資料後,再給它一個delete()

檔案:testDelete.php

1
2
3
4
5
<?php
    require_once 'config/doctrine_config.php';

    $myTable = new Member;
    $myTable->getTable()->find(1)->delete();

查詢:

假設我要找出id編號是1號的資料,可以這樣做:

1
2
3
<?php
  $myTable = new Member;
  $result =$myTable->getTable()->find(1);

除了透過find方法外,Doctrine還有它自已一套叫做DQL的語法,使用方法大致如下:

檔案:testDQL.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?php
    require_once 'config/doctrine_config.php';

    $myTable = new Member;
    $record = $myTable->getTable()->find(1);
    $record->password = 'mynewpassword';
    $record->save();
    $result = Doctrine_Query::CREATE()
                ->select('*')
                ->from('Member')
                ->where('id = ?', 1)
                ->fetchArray();

    print_r($result);

印出來的結果如下:

image

上面的DQL相當於底下的SQL:

1
select * from member where id = 1;

其實DQL的細節也可以另外來寫一篇 :)

結論

老實說,如果只是簡單的查詢,Doctrine寫起來不見得比原本的SQL快,而且效能又比較差一些,但如果是比較複雜的查詢,透過Doctrine包裝好 的一些方法,可以不用去想那些單引號、雙引號的問題外,也可以安全的避開可能的危機(例如SQL Injection) ,就如同最前面說的,便利跟效能,我會比較偏向便利的這一方。

更多的細節,可參考Doctrine官網手冊,寫得滿詳細的。

上面的程式碼我也有打包了一份供大家參考囉 :)

檔案下載

使用前請先看一下config/doctrine_config.php裡面的資料庫相關設定。

相關連結

Comments