Documentation

§フィルタの利用

フィルターとは、アプリケーションへ送られてきたリクエストをインターセプト(傍受)したり、リクエストまたはレスポンスに変換処理を行うことを可能にするコンポーネントです。フィルターを使うと、アプリケーションを横断する関心事をうまく実装することができます。フィルターは Filter トレイトを継承して実装され、 Global へ追加されることで機能します。次の例では、全てのアクションの実行結果のログをとるアクセスログフィルターを実装しています。

import play.api.Logger
import play.api.mvc._

object AccessLoggingFilter extends Filter {
  def apply(next: (RequestHeader) => Future[Result])(request: RequestHeader): Future[Result] = {
    val result = next(request)
    Logger.info(request + "\n\t => " + result)
    result
  }
}

object Global extends WithFilters(AccessLoggingFilter)

Global オブジェクトは WithFilters クラスを継承しており、複数のフィルタを渡すとフィルタチェインをつくってくれます。

object AuthorizedFilter {
  def apply(actionNames: String*) = new AuthorizedFilter(actionNames)
}

class AuthorizedFilter(actionNames: Seq[String]) extends Filter {

  def apply(next: (RequestHeader) => Future[Result])(request: RequestHeader): Future[Result] = {
    if(authorizationRequired(request)) {
      /* do the auth stuff here */
      println("auth required")
      next(request)
    }
    else next(request)
  }

  private def authorizationRequired(request: RequestHeader) = {
    val actionInvoked: String = request.tags.getOrElse(play.api.Routes.ROUTE_ACTION_METHOD, "")
    actionNames.contains(actionInvoked)
  }


}


object Global extends WithFilters(AuthorizedFilter("editProfile", "buy", "sell")) with GlobalSettings {}

Tip RequestHeader.tags には、アクションの呼び出しに利用されたルートに関する有益な情報が色々と含まれています

§onRouteRequest をオーバライドする

Global オブジェクトにはもう一つ重要な側面があります。それは、リクエストをインターセプトする手段を提供してくれる、ということです。これを利用すると、アクションへリクエストが送られる前に任意のビジネスロジックを実行することができます。

import play.api._
import play.api.mvc._

// Note: this is in the default package.
object Global extends GlobalSettings {

  override def onRouteRequest(request: RequestHeader): Option[Handler] = {
    println("executed before every request:" + request.toString)
    super.onRouteRequest(request)
  }

}

ここで紹介した方法以外にも、 アクション合成 を使って特定のアクションメソッドだけをインターセプトする、というテクニックもあります。

次ページ: アプリケーションのテスト

このドキュメントの翻訳は Play チームによってメンテナンスされているものではありません。 間違いを見つけた場合、このページのソースコードを ここ で確認することができます。 ドキュメントガイドライン を読んで、お気軽にプルリクエストを送ってください。