先生と生徒の会話形式で理解しよう

生徒

「Play Frameworkではルーティングってすごく重要だと聞きました。特にデフォルトルートとかエラーハンドリングってどういう仕組みなんでしょうか？」

先生

「Play Frameworkのルーティングはアプリケーションの入り口になるので、とても大切だよ。デフォルトルートやエラーハンドリングを理解しておくと、Webアプリの安全性や使いやすさがぐっと上がるんだ。」

生徒

「デフォルトルートは知らないページにアクセスしたときの動きに関係しているんですか？」

先生

「そうだね。では、基礎から順番に見ていこう。」

Play Frameworkのデフォルトルートとは

Play Frameworkでは、conf/routesファイルを使ってURLとコントローラの対応付けを定義します。通常のルーティングは明示的にURLを書くことで動作しますが、アプリケーション全体の安全性を高めるために、存在しないページへのアクセスや未定義のパスに対する動作を考える必要があります。これを処理する仕組みがデフォルトルートです。

デフォルトルートは、開発時に特に意識しないまま進めてしまうことが多いですが、実際にはユーザ体験に直接関わる重要な部分です。例えば、Webサイト利用者が誤ってURLを入力した場合でも、適切なページに誘導したり、エラーメッセージを返したりすることができます。Play Frameworkでは、これらの動作を柔軟に設定できるため、初心者でもシンプルな方法で安全なアプリケーションを構築できます。


# conf/routes
GET     /                   controllers.HomeController.index()

Play Frameworkのエラーハンドリングの基本

エラーハンドリングは、Play Frameworkでアプリケーションを運用する上で欠かせない要素です。アクセスされたURLが定義されていない場合や、サーバ内部で例外が発生した場合に、どのようなレスポンスを返すかを決める仕組みです。特に、404 Not Foundと500 Internal Server Errorの処理はWebアプリケーションでは頻繁に発生するため、正しく実装しておくと信頼性が高まります。

Play Frameworkでは、デフォルトのエラーハンドリングが用意されていますが、自分で独自のエラーページを作成して適用することも簡単にできます。エラーページを独自のテンプレートに変更することで、ユーザが迷わず次の行動をとれるように誘導したり、ブランドイメージに合わせた画面を表示したりすることが可能です。

まずはルーティングで例外が発生した際にどのような挙動をするかを確認し、必要に応じてカスタマイズしていきます。

404エラー（Not Found）をハンドリングする方法

Play Frameworkでは、存在しないパスにアクセスされると自動的に404エラーが発生します。初期状態でもPlayが標準のエラーページを返しますが、これを自分で変更したい場合には、ErrorHandlerを作成して制御することができます。


package error;

import play.*;
import play.mvc.*;
import play.http.*;

import javax.inject.Singleton;

@Singleton
public class CustomErrorHandler extends HttpErrorHandler {

    public Result onClientError(Http.RequestHeader request, int statusCode, String message) {
        if (statusCode == 404) {
            return Results.notFound("ページが見つかりませんでした。");
        }
        return Results.status(statusCode, "クライアントエラーが発生しました。");
    }

    public Result onServerError(Http.RequestHeader request, Throwable exception) {
        return Results.internalServerError("サーバ内部でエラーが発生しました。");
    }
}

このように、404エラーへのレスポンスをカスタマイズすることで、アクセスされた側が何をすべきか判断しやすくなります。例えばホームに戻るためのリンクを表示したり、FAQへの導線を追加したりすることも実務でよく行われる工夫です。

500エラー（Internal Server Error）を丁寧に処理する方法

アプリケーション内部で例外が発生したときに返されるのが500エラーです。これはユーザにとって非常に混乱しやすい状況なので、できる限り適切なメッセージや案内を表示する必要があります。さらに、開発者にとっても例外の内容がログに正しく残るようにしておくことが重要です。

エラーハンドラでは、ログの記録とユーザ向けメッセージの表示を分けて設計することが一般的です。サーバ内部で何が起きているかユーザに詳細を見せる必要はなく、むしろ「復旧手順」や「問い合わせ先」を示すほうが親切です。このバランスをとった実装を心がけることが、Play Frameworkでの安全なアプリ開発につながります。

routesファイルでのデフォルトルート設定

Play Frameworkでは、特定のパスに一致しなかったときの動作として、明示的にワイルドカードルートを設定することもできます。例えば、URLの末尾に特定のフォルダ名が続くパターンをまとめて処理したい場合に役立ちます。デフォルトルートはアプリケーションの最終的な受け皿になるため、どのように定義するかがとても大切です。


GET     /assets/*file        controllers.Assets.versioned(path="/public", file: Asset)

ワイルドカードを使うことで、ファイルリクエストなどに柔軟に対応できます。特に静的ファイルの配信では頻繁に使われるため、初心者でも必ず理解しておきたい基本部分です。

カスタムエラーページのテンプレートを作成する

Play FrameworkではTwirlテンプレートを使用してエラーページをデザインできます。例えば404ページを独自のデザインにしたい場合は、viewsフォルダに専用のテンプレートを作成してコントローラやErrorHandlerから呼び出す構成にします。見た目を整えてユーザの離脱を防ぐためには、軽量で読みやすいテンプレートを用意するのが理想的です。


@(message: String)

@main("ページが見つかりません") {
    <h1>お探しのページは存在しません</h1>
    <p>@message</p>
}

テンプレートを使うことで、視覚的なデザインも柔軟に構築でき、ブランドイメージに沿ったエラー画面をつくることができます。

Play Frameworkのデフォルトルートとエラーハンドリングを徹底解説！初心者でも理解できる基本と実践