§プラグインを書く

Play フレームワークには、すべてのアプリケーションに対して、以下のようにあらかじめ定義されたプラグインがあります。

• DBPlugin -> JDBC データソースを提供します。
• EvolutionPlugin -> マイグレーション機能を提供します。 (データベースが設定されている場合のみ)
• EbeanPlugin -> Ebean をサポートします。 (データベースが設定されている場合のみ)
• MessagesPlugin - > i18n をサポートします。
• BasicCachePlugin -> インメモリキャッシュを提供します。
• GlobalPlugin -> アプリケーションの設定を実行します。

ですが、アプリケーションに新しいプラグインを追加するのも簡単です。

1. はじめに、onStart, onStop, enabled の三つのメソッドを持つ play.api.Plugin トレイトを実装します。- 参考)
2. このプラグインは Maven リポジトリから引き込まれるようにするか、アプリケーションの依存性として参照するか、あるいは Play アプリケーションの一部でなければなりません。
3. プラグインは次のように直接使うことができます。app.plugin[MyPlugin].map(_.api.mymethod).getOrElse(throwMyerror) ( appの場所は play.api.Play.current をインポートすることで得られる現在のアプリケーションから参照できるものになります) しかしながら、利便性のためにラップして使用することを奨めます。 (参考 こちら)
4. アプリケーション内に conf/play.plugins というファイルを作成し、作ったプラグインを次のように付け加えてください:

   5000:com.example.MyPlugin

冒頭の数字はプラグインは呼び出される順番を表しており、10000 以上に設定することでグローバルプラグインの後に確実に呼ばれるようになります。

Tip: もしあなたが scala 開発者で、自分のプラグインを Java 開発者と共有する場合は、Java ユーザーのためにラップされた API が必要になります。(参考 こちら と こちら)

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