PRADO SqlMapを利用する

SqlMapとはActiveRecordとは性質の異なるＯＲマッピングツール。
重点に置いているのはActiveRecordではテーブルだが、
SqlMapで重要視しているのはSQL。
SQLをベースにしたＯＲマッピングツールと言える。
iBatis Data MapperというJavaのＯＲマッパーがあるのだが、
これを参考に作成されている。

SQLを記述したマップデータを作成する。
「PRADO ActiveRecordを利用する」で作成したスキーマクラスdbUserも利用する。
/protected/database/sqlmap.xml

<?xml version="1.0" encoding="utf-8" ?>
<sqlMapConfig>
  <select id="getUserAll" resultClass="Application.database.dbUser">
    SELECT username, email FROM users
  </select>
  <select id="getUserByEmail" resultClass="Application.database.dbUser">
    SELECT username, email FROM users WHERE email = #email#
  </select>
</sqlMapConfig>

SqlMapの設定をapplication.xmlに記述する。
/application.xml

<modules>
  ・・・
  <!-- DATABASE -->
  <module id="db1">
    <database ConnectionString="mysql:host=localhost;dbname=test"
    username="dbuser" password="dbpass" Active="false" />
  </module>
  <!-- ACTIVE RECORD -->
  <module class="System.Data.ActiveRecord.TActiveRecordConfig"
   ConnectionID="db1" EnableCache="true" />
  <!-- SqlMap -->
  <module id="sqlmap" class="System.Data.SqlMap.TSqlMapConfig" 
   EnableCache="true" ConfigFile="Application.database.sqlmap"
   ConnectionID="db1" />
</modules>

コード上でSqlMapを利用する。
サンプルではonLoadで利用しているが、
実際は必要なビジネスロジック上で行う。

class Home extends TPage
{
  function onLoad($param)
  {
    parent::onLoad( $param );
 
    $sqlmap = $this->Application->Modules['sqlmap']->Client;
    $sqlmap->DbConnection->Active = true;
    $trans = $sqlmap->DbConnection->beginTransaction();
 
    $userObjs = $sqlmap->queryForObject('getUserAll');
    foreach( $userObjs as $userObj )
      print_r( $userObj );
 
    $trans->commit();
 
  }
}

Activeは設定ファイルで自動接続に切り替えることも可能だが、
無駄な接続はなるべくしない方が良いので、
必要な時にActiveに変更するようにする方が望ましい。

DBがMyISAMな上、データ取得なのであまりトランザクションは関係ないが一応載せておく。 DBをSqliteにした場合はselectでもトランザクションは必要。

テストファーストというのはなにもプログラムに限ったことではなく、
SQLでもユニットテストを行うことは非常に重要である。
ただ、データが空ではテストできないと言うのが
多少、やりづらいところではある。
ただ、最近のデータベース設計ツール、ＳＱＬクエリツールは良くできていて、
それらを駆使することで負担は軽減できる。
私がデータベース設計で利用しているツールは以下の二つ。

• CSE
• DB Designer

これらの詳細は今回は省く。

単体テストについてはこちらを参考して欲しい。
PRADO 単体および機能テスト
ここではテストケースのサンプルをあげておこう。
username = 'dozo', email = 'dozo@matrix.jp'
というデータが入っていたとすると、 /tests/unit/dbUsertest.php

<?
class dbUserTest extends UnitTestCase
{
  public function testDbUser()
  {
  // initialize
    $app = Prado::getApplication();
    $sqlmap = $app->Modules['sqlmap']->Client;
  // set data
    $user = new stdClass;
    $user->email = "dozo@matrix.jp";
  // get data
    $userObj = $sqlmap->queryForObject("getUserByEmail", $user );
    $this->assertIsA( $userObj, "dbUser", "class: ". 
      get_class( $userObj ) );
    $this->assertEqual( $userObj->username, "dozo", 
      get_class( $userObj )."->username: ". $userObj->username );
  // $this->dump( $userObj );
  }
}

Active Recordははっきり言って重くて使い物にならない。
なのでデータベース接続のメインはPDOまたはSqlMapということになる。
SQLをプログラム上に書くとメンテナンスが難しくなってしまうため、
可能な限りSqlMapを利用することを薦める。

Active Record同様、SqlMap(正確に言うとTSqlMapGateway)のメソッドを駆使することになる。
ここではメソッド群を列挙しておこう。