Documentation

You are viewing the documentation for the 2.1.5 release in the 2.1.x series of releases. The latest stable release series is 2.4.x.

§セッションとフラッシュスコープ

§Play におけるセッションとフラッシュスコープ

複数のリクエストにまたがってデータを保持したい場合、セッションまたはフラッシュスコープにデータを保存することができます。一旦セッションに保存されたデータは、ユーザの 1 セッション中ずっと保持され、フラッシュスコープに保存されたデータは次のリクエストまで保持されます。

セッションやフラッシュのデータはサーバに保存されるのではなく、クッキーを利用して後続のリクエストに追加されるということはとても重要です。このことは、データサイズがかなり制限される (4KB まで) と同時に、文字列型の値しか保存できないということを意味します。

もちろん、クッキーの値は秘密鍵によって署名されているため、クライアントがクッキーのデータを変更することはできません (変更すると、値が無効化されます) 。

Play のセッションはキャッシュとして使われることを想定して作られてはいません。もし、特定のセッションに関するデータをキャッシュしたい場合、Play に組み込まれたキャッシュ機構を利用すると同時に、ユーザのセッションにユニーク ID を保存して、キャッシュを特定のユーザに対応づけることができます。

セッションには技術的にタイムアウトが存在しません。セッションは、ユーザが web ブラウザを終了させたときに切れます。もし、特定のアプリケーションでタイムアウトの機能が必要になった場合は、ユーザのセッションにタイムスタンプを保存して、必要なところで参照すると良いでしょう (例えば、セッションの最長期間、期限切れまでに許される無操作時間等) 。

§セッション値の読み込み

次のように、送信されてきたセッションを HTTP リクエストから取り出すことができます。

def index = Action { request =>
  request.session.get("connected").map { user =>
    Ok("Hello " + user)
  }.getOrElse {
    Unauthorized("Oops, you are not connected")
  }
}

別の方法として、リクエストから暗黙的にセッションを取り出すこともできます。

def index = Action { implicit request =>
  session.get("connected").map { user =>
    Ok("Hello " + user)
  }.getOrElse {
    Unauthorized("Oops, you are not connected")
  }
}

§セッションへの値の保存

セッションはただのクッキーであると同時に、ただの HTTP ヘッダでもあります。したがって、Result の他のプロパティを操作するのと同様の方法で、セッションデータを操作することができます。

Ok("Welcome!").withSession(
  "connected" -> "[email protected]"
)

このコードはセッションを丸ごと入れ替えてしまうことに注意してください。もし、既存のセッションに要素を追加する必要がある場合、受けとったセッションに要素を追加したものを新たなセッションとして指定してください。

Ok("Hello World!").withSession(
  session + ("saidHello" -> "yes")
)

同じ方法で、受け取ったセッション中の値を削除することができます。

Ok("Theme reset!").withSession(
  session - "theme"
)

§セッションの破棄

セッション全体を破棄するために、特別な操作が用意されています。

Ok("Bye").withNewSession

§フラッシュスコープ

フラッシュスコープは次の 2 点の違いを除いて、セッションと全く同じように動作します。

重要: フラッシュスコープはシンプルかつ非 Ajax なアプリケーションにおいて、成功/失敗メッセージをやり取りするためだけに利用すべきです。データは次のリクエストまでしか保持されず、また複雑な Web アプリケーションにおいてはリクエストの順序が保証できないため、フラッシュスコープが競合状態に陥る可能性があります。

次にフラッシュスコープの利用例をいくつか示します。

def index = Action { implicit request =>
  Ok {
    flash.get("success").getOrElse("Welcome!")
  }
}

def save = Action {
  Redirect("/home").flashing(
    "success" -> "The item has been created"
  )
}

フラッシュスコープの値をビューから取得するには Flash に implicit を追加します:

@()(implicit flash: Flash)
...
@flash.get("success").getOrElse("Welcome!")
...

アクションがリクエストオブジェクトを import しなかった場合、‘could not find implicit value for parameter flash: play.api.mvc.Flash’ というエラーが発生します。以下のように “implicit request=>” を追加します。

def index() = Action {   
  implicit request =>
    Ok(views.html.Application.index())
}

次ページ: ボディパーサー