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 リクエストから取り出すことができます。

public static Result index() {
  String user = session("connected");
  if(user != null) {
    return ok("Hello " + user);
  } else {
    return unauthorized("Oops, you are not connected");
  }
}

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

セッションはただのクッキーであると同時に、ただの HTTP ヘッダでもあります。しかし、Play はセッションの値を格納するためのヘルパーメソッドを提供しています。

public static Result index() {
  session("connected", "[email protected]");
  return ok("Welcome!");
}

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

public static Result index() {
  session().remove("connected");
  return ok("Bye");
}

§セッションの破棄

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

public static Result index() {
  session().clear();
  return ok("Bye");
}

§フラッシュスコープ

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

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

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

public static Result index() {
  String message = flash("success");
  if(message == null) {
    message = "Welcome!";
  }
  return ok(message);
}

public static Result save() {
  flash("success", "The item has been created");
  return redirect("/home");
}

 

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