Play2.0と学ぶsqueryl (1) モデルの定義

2012-10-12tech

1.2.5 のときのチュートリアルにあった YABE(Yet Another Blog Engine)のモデル層の作成を通じて、

Scala の OR マッパーである squeryl の使い方をまとめておきます

利用した環境は

Play 2.0.5
Scala 1.9
squeryl 0.9.5-2

なお、squeryl 0.9.6 以降では仕様が変わるようなので動かなくなりそうです。

(KeyedEntity がなくなり KeyedEntityDef で自動採番するらしい(())) セットアップ

squeryl を使うために sbt のセットアップをします。

project/Build.scala に squeryl の依存関係を記述します。

valappDependencies = Seq(
      "org.squeryl" %% "squeryl" % "0.9.5"
)

今回はインメモリの h2 データベースを利用します。

conf/application.conf に以下の記述をします。

db.default.driver=org.h2.Driver
db.default.url="jdbc:h2:mem:play"

最後に squeryl データベースを接続の設定を行います。

app/Global.scala を新規作成して、Play の起動時に DB の接続設定を行う処理をグローバルクラスに記述します。

import org.squeryl.Session
import org.squeryl.SessionFactory
import org.squeryl.adapters.H2Adapter
import org.squeryl.adapters.PostgreSqlAdapter
import org.squeryl.internals.DatabaseAdapter
import org.squeryl.PrimitiveTypeMode._

import play.api.Application
import play.api.GlobalSettings
import play.api.db.DB

import models._

object Global extends GlobalSettings {

  override def onStart(app: Application) {
    SessionFactory.concreteFactory = app.configuration.getString("db.default.driver") match {
      case Some("org.h2.Driver") => Some(() => getSession(new H2Adapter, app))
      case _ => sys.error("Database driver must be either org.h2.Driver")
    }

  }

  def getSession(adapter: DatabaseAdapter, app: Application) = Session.create(DB.getConnection()(app), adapter)

}

User エンティティの作成

Play のチュートリアルと同様に User クラスを作成するところからブログエンジンのコーディングを始めます。

app/models/User.scala を作成し、以下のように記述します。

package models

import org.squeryl.KeyedEntity
import org.squeryl._
import org.squeryl.dsl._
import org.squeryl.PrimitiveTypeMode._

case class User(email: String, password: String, fullname: String, isAdmin: Boolean) extends KeyedEntity[Long] {
  val id: Long = 0
}

各フィールド + プライマリーキーとなる id を定義します。(なんでか id に自動採番された値が入る。きもい)

このクラスとは別に、User クラスを squeryl が DB へマッピングを行うスキーマのオブジェクトを作成します。

app/models/YabeDB.scala を作成して以下のように記述します。

package models

import org.squeryl.PrimitiveTypeMode._
import org.squeryl._
import org.squeryl.annotations.Column
import org.squeryl.dsl._

object YabeDB extends Schema {

  val users = table[User]("user_tb")
}

user は DB のキーワードとなる可能性があるのでここでは”user_tb”というテーブルに User クラスをマッピングするように定義しました。

DB の作成は evolution の機能を使った方がベターだろうが、ここでは作業を簡単にするために squeryl の機能を使って DB のテーブルを作成します。

そのために、app/Global.scala を以下のように変更します。

import org.squeryl.Session
import org.squeryl.SessionFactory
import org.squeryl.adapters.H2Adapter
import org.squeryl.adapters.PostgreSqlAdapter
import org.squeryl.internals.DatabaseAdapter
import org.squeryl.PrimitiveTypeMode._

import play.api.Application
import play.api.GlobalSettings
import play.api.db.DB

import models._

object Global extends GlobalSettings {

  override def onStart(app: Application) {
    SessionFactory.concreteFactory = app.configuration.getString("db.default.driver") match {
      case Some("org.h2.Driver") => Some(() => getSession(new H2Adapter, app))
      case Some("org.postgresql.Driver") => Some(() => getSession(new PostgreSqlAdapter, app))
      case _ => sys.error("Database driver must be either org.h2.Driver or org.postgresql.Driver")
    }

    transaction {
      // テーブルの削除
      YabeDB.drop
      // テーブルの作成
      YabeDB.create
    }

  }

  def getSession(adapter: DatabaseAdapter, app: Application) = Session.create(DB.getConnection()(app), adapter)

}

squeryl でトランザクションを利用したい場合は transaction メソッドを利用します。

transaction メソッドに渡すブロック内に処理を書きます。

あと、チュートリアル通り、User クラスに関する最初のテストも作成します。

test/models/UserSpec.scala に以下のように記述します。

package models

import play.api.test._
import play.api.test.Helpers._
import org.specs2.mutable.Specification
import org.squeryl._
import org.squeryl.PrimitiveTypeMode._

class UserSpec extends Specification {

  "User" should {

    "creat new User" in {
      running(FakeApplication()) {

        transaction {
          val user = YabeDB.users.insert(User("bob@gmail.com", "secret", "Bob", false))

          user must not be null
          user.fullname must beEqualTo("Bob")
        }
      }
    }

  }

}

OneToMany などのレーションシップの関係は次回紹介します。

Rhyztech blog

Play2.0と学ぶsqueryl (1) モデルの定義

参考文献