Modelの作成
投稿されたメッセージを表すMessage Modelを定義します。
このModelは、投稿されたメッセージ本文と、投稿日時、投稿したユーザーをプロパティとして持ちます。ユーザーは、Liftであらかじめ用意されているUser Modelを利用して、User Modelへのリレーションを設定しています。
プロジェクトディレクトリ以下の 「src/main/scala/demo/twitterclone/model/」ディレクトリに、「Message.scala」というファイル名で新しいファイルを作成し、リスト2の内容を入力します。
package demo.twitterclone.model import java.util.Date import _root_.net.liftweb.mapper._ import _root_.scala.xml.Text import _root_.net.liftweb.http.FieldError import _root_.net.liftweb.util.Helpers._ /** * 投稿されたメッセージのModel */ class Message extends LongKeyedMapper[Message] with IdPK { def getSingleton = Message /** * メッセージ本文 */ object status extends MappedTextarea(this, 140){ /** Textareaのカラム数 */ override def textareaCols = 40 /** Textareaの行数 */ override def textareaRows = 4 /** 入力チェックの定義 */ override def validations = // 入力されていない場合はエラー valNotNull("メッセージを入力してください。") _ :: // 140文字を超える場合はエラー valMaxLen( 140 , "メッセージは140文字以内です。") _ :: super.validations /** 入力されているかチェックするための関数 */ def valNotNull( msg : => String)(value : String): List[FieldError] = if ((value ne null) && (value ne "" )) Nil else List( FieldError(this, Text(msg))) } /** * 投稿日時 */ object dateOf extends MappedDateTime(this){ override def defaultValue = new Date } /** * 投稿したユーザー */ object user extends MappedLongForeignKey(this,User) } /** * Messageモデルに対するMetaMapper */ object Message extends Message with LongKeyedMetaMapper[Message] { override def fieldOrder = List(id) }
Model定義のおさらい
LiftのModelは、基本的にはデータベースのテーブルと1対1に対応します。規約による設定(CoC:Convention over Configuration)に従って、テーブル名がModelのクラス名に、テーブルのカラム名がModelクラスのプロパティ名になります(設定で名前の対応を変更することは可能です)。
Modelは、MapperとMetaMapperという2つのコンポーネントで構成されます。
Mapperは、データベース上の1レコードに対応するクラスです。データを登録するには、Mapperクラスのインスタンスを作成して、プロパティの値を設定した上でsave関数を呼び出すことで、データベースへINSERTが行われます。
MetaMapperは、テーブル単位の定義や操作を行うシングルトンオブジェクトです。MetaMapperオブジェクトは、Mapperクラスのファクトリクラスであり、各種のユーティリティ関数を持っています。
Validation(入力チェック)について
前回は説明しませんでしが、今回作成するModelクラスには、データの入力チェック(validation)機能を追加しています。
Modelクラスの各プロパティの中で、validationsをオーバーライドして、このModelでの入力チェックを行う関数オブジェクトを追加しています(*1)。
入力チェックを行う関数は、List[FieldError]を返す関数になります。このModelでは、statusプロパティに対して、値がnullか空文字であればエラーとするvalNotNullを(*2)作成して、validationsに追加しています。
object status extends MappedTextarea(this, 140){ /** 入力チェックの定義 */ override def validations = *1 // 入力されていない場合はエラー valNotNull("メッセージを入力してください。") _ :: // 140文字を超える場合はエラー valMaxLen( 140 , "メッセージは140文字以内です。") _ :: super.validations /** 入力されているかチェックするための関数 */ def valNotNull( msg : => String)(value : String): List[FieldError] = *2 if ((value ne null) && (value ne "" )) Nil else List( FieldError(this, Text(msg))) }
リレーションについて
Model間のリレーションの定義は、外部キーに指定したいプロパティにMappedLongForeignKeyなどの外部キーを表す型にすることで、簡単に実現できます。
今回のModelでは、投稿したユーザーを外部キーとして設定しています。参照先は、Liftであらかじめ用意されているUserモデルです。リスト4のように、MappedLongForeignKey(this,User)でUserモデルへの関連を定義しています。
/** * 投稿したユーザー */ object user extends MappedLongForeignKey(this,User)
参照先のModelを取得するには、次のようにmodelのuserプロパティのobj関数を呼び出します。
scala> model.user.obj res1: net.liftweb.util.Box[demo.twitterclone.model.User] = Full(demo.twitterclone.model.User={id=1,First Name=Tomohito,Last Name=Ozaki,Email=ozaki@yuroyoro.com,Locale=ja_JP,Time Zone=Asia/Tokyo,Password=*******,Personal Essay=,superuser=false,validated=true,uniqueid=B2GTMH0YOXQ5KMV5RN45G3ZLDD1DBQHK})