1. routesファイルとは？

Play Frameworkのroutesファイルは、アプリケーションのURLと処理を結びつけるための設定ファイルです。例えば、ユーザーがブラウザで/helloにアクセスしたときに、どのコントローラのどの関数を呼び出すかをここで決めます。routesファイルを正しく設定することで、Webアプリ全体のルーティングを管理できます。

2. routesファイルの基本構造

routesファイルの基本は「HTTPメソッド」「URLパス」「コントローラ関数」の3つで構成されます。HTTPメソッドはGETやPOST、PUT、DELETEなどがあります。URLパスはブラウザからアクセスされるパスです。コントローラ関数は、実際に処理を行うScalaやJavaの関数です。


GET     /hello       controllers.HomeController.hello
POST    /submit      controllers.FormController.submit

上記の例では、/helloにGETリクエストが来たときに、HomeControllerのhello関数が呼ばれます。同様に、/submitにPOSTリクエストが来たときはFormControllerのsubmit関数が実行されます。

3. HTTPメソッドの使い分け

Webアプリでは、同じURLでもHTTPメソッドによって処理を変えることができます。GETはデータの取得、POSTはデータの送信、PUTは更新、DELETEは削除などに使います。routesファイルではそれぞれ明示的に書く必要があります。


GET     /items       controllers.ItemController.list
POST    /items       controllers.ItemController.create
PUT     /items/:id   controllers.ItemController.update(id: Long)
DELETE  /items/:id   controllers.ItemController.delete(id: Long)

この例では、/itemsにアクセスする方法によって呼び出される関数が変わります。ルーティングの基本的な考え方が理解できます。

4. URLパラメータの指定

routesファイルではURLの一部をパラメータとして渡すことができます。コロン（:）を使って変数名を指定します。コントローラ関数の引数として受け取ることができます。


GET     /user/:id    controllers.UserController.show(id: Long)

この場合、/user/123にアクセスすると、idに123が渡され、show関数で処理されます。

5. ルーティングの順序と注意点

routesファイルは上から順に評価されます。先に一致するルートがあれば、それが優先されます。そのため、より具体的なパスを先に書き、ワイルドカードや汎用的なルートは後ろに書くようにすると安全です。また、同じURLとHTTPメソッドで複数のルートを定義するとエラーになります。

6. 名前付きルートと逆ルーティング

routesファイルでは名前付きルートを指定することで、コードからURLを生成することができます。これを逆ルーティングと呼びます。例えば、@routes.UserController.show(123)と書くと、自動的に/user/123が生成されます。ルーティングを変更しても、この呼び出しは変わらないのでメンテナンス性が向上します。