USERS
テーブルからIDの昇順に全件取得し、ユーザ一覧画面を表示します。
ビュー
テンプレートはviews
パッケージに作成します。appディレクトリ配下にviews.user
パッケージを作成し、以下の内容でlist.scala.html
を作成します。
@* このテンプレートの引数 *@
@(users: Seq[models.Tables.UsersRow])(implicit request: Request[Any])
@* テンプレートで利用可能なヘルパーをインポート *@
@import helper._
@* main.scala.htmlを呼び出す *@
@main("ユーザ一覧") {
<div>
<a href="@routes.UserController.edit()" class="btn btn-success" role="button">新規作成</a>
</div>
<div class="col-xs-6">
<table class="table table-hover">
<thead>
<tr>
<th>ID</th>
<th>名前</th>
<th> </th>
</tr>
</thead>
<tbody>
@* ユーザの一覧をループで出力 *@
@users.map { user =>
<tr>
<td>@user.id</td>
<td><a href="@routes.UserController.edit(Some(user.id))">@user.name</a></td>
<td>@helper.form(CSRF(routes.UserController.remove(user.id))){
<input type="submit" value="削除" class="btn btn-danger btn-xs"/>
}
</td>
</tr>
}
</tbody>
</table>
</div>
}
テンプレート一行目に(implicit request: Request[Any])
という引数が定義されていますが、これはテンプレート中で使用しているCSRF
というヘルパーを使用するために必要なものです。PlayではデフォルトでCSRF対策のためのフィルタが有効になっており、フォームの送信先を指定する際に@helper.form(CSRF(...))
のように指定するだけで自動的にトークンを使用したCSRF機能を利用することができます(CSRF
ヘルパーを指定しないとフォームの送信時に403エラーになってしまいます)。
POINT
- テンプレートの1行目にはコントローラから受け取る引数を記述します
- テンプレートには
@
でScalaのコードを埋め込むことができます@import
でインポート文を記述することができます。@import helper._
でPlayが提供する標準ヘルパー(フォームなどを出力する関数)をインポートしています- テンプレートには
@*...*@
でコメントを記述することができます- リンクやフォームのURLは、
@routes.・・・
と記述することでルーティングから生成することができます- デフォルトでCSRFフィルタが有効になっているため、フォームの送信先は
CSRF(...)
で囲む必要があります
コントローラ
UserController
のlist
メソッドを以下のように実装します。
def list = Action.async { implicit rs =>
// IDの昇順にすべてのユーザ情報を取得
db.run(Users.sortBy(t => t.id).result).map { users =>
// 一覧画面を表示
Ok(views.html.user.list(users))
}
}
Action.async
はアクションの処理結果をFuture
で非同期に返却します。Slick 3.0ではSQLの実行処理をFuture
で返すことができるため、これを利用してPlayのアクションもFuture
でレスポンスを返すようにしています。
上記のコードでは以下の記述でユーザの一覧を取得するDBIOAction
を生成しています。
Users.sortBy(t => t.id).result
これは以下のSQLと同じ意味になります。
SELECT * FROM USERS ORDER BY ID
db.run
で生成したDBIOAction
を実行してデータベースから結果を取得するFuture
が返ります。このFuture
に対してmap
メソッドで、データベースから取得した値をテンプレートに渡してレンダリング結果を返すFuture
に変換しています。最終的にこのアクションの戻り値は「DBの検索結果をテンプレートに渡し、そのテンプレートのレンダリング結果を返すFuture
」になります。
POINT
- Playの標準では
Action { ... }
の中に処理を記述しますが、レスポンスをFutureで返す場合はAction.async { ... }
に処理を記述します
implicit rs
はアクションの処理の中でHTTPリクエストやDBのセッションを暗黙的に使用するために必要になる記述ですOk
にviews.html.・・・
と記述することで、表示したいHTMLのテンプレートを指定できます
- 引数にはテンプレートに渡すパラメータを指定します
- Slick 3のクエリは
DBIOAction
を生成します。DBIOAction
をdb.run
で実行すると検索結果を返すFuture
を取得できます
実行
ここまで実装したらブラウザから http://localhost:9000/user/list にアクセスします(sbt run
を実行していない場合は実行してください)。すると以下のような画面が表示されるはずです。