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

生徒

「先生、Play Frameworkのプロジェクトを作りたいんですけど、最初はどうすればいいんですか？」

先生

「Play Frameworkのプロジェクトを作るには、sbt newというコマンドを使います。このコマンドを実行すると、Play Framework用のテンプレートから新しいプロジェクトを自動的に作成してくれるんです。」

生徒

「へぇ、便利ですね！でも、具体的にはどんな手順でやるんですか？」

先生

「それでは、これからPlay FrameworkのJavaプロジェクトを例にして、sbt newコマンドでの作成手順を順番に見ていきましょう。」

1. Play Frameworkのプロジェクト作成にはsbtが必要

まず、Play Frameworkのプロジェクトを作成する前に、開発に必要なツールであるsbt（Scala Build Tool）がインストールされていることを確認しましょう。Play Frameworkでは、このsbtを使ってプロジェクトの作成・ビルド・実行などを行います。

もしまだsbtをインストールしていない場合は、Play Frameworkの開発環境構築の記事（Play Frameworkの開発環境構築ガイド）を参考にしてセットアップを完了させておきましょう。

2. sbt newコマンドでPlay Frameworkプロジェクトを作成する

環境の準備ができたら、いよいよPlay Frameworkのプロジェクトを作成します。ここでは、Java版のPlay Frameworkプロジェクトを作る方法を紹介します。

まずは、作業したいディレクトリに移動して、次のコマンドをターミナル（またはコマンドプロンプト）で実行します。


sbt new playframework/play-java-seed.g8

このコマンドを実行すると、Play Frameworkが提供している「Java用のプロジェクトテンプレート（seed project）」をもとに新しいプロジェクトを作成します。

3. 対話形式でのプロジェクト設定

sbt newコマンドを実行すると、ターミナル上でいくつか質問が表示されます。これは、プロジェクトの名前や組織名などを入力して設定をカスタマイズするためです。以下のような質問が出てきます。


name [play-java-seed]: my-first-play
organization [com.example]: com.example.demo
play_version [2.9.0]:
scala_version [2.13.13]:

各項目に自分の好きな値を入力するか、何も入力せずにEnterキーを押すとデフォルト設定が使われます。たとえば、上記の例ではプロジェクト名がmy-first-play、パッケージ名がcom.example.demoになります。

設定が完了すると、自動的にプロジェクトのフォルダが作成され、中にはPlay Frameworkでアプリを開発するために必要なファイル一式が生成されます。

4. プロジェクトのフォルダ構成を確認しよう

作成が完了したら、以下のようなフォルダ構成になっているはずです。


my-first-play/
├── app/
│   ├── controllers/
│   └── views/
├── conf/
│   └── routes
├── public/
│   ├── images/
│   ├── javascripts/
│   └── stylesheets/
├── project/
├── build.sbt
└── README.md

appディレクトリには、Javaのコントローラやビュー（テンプレート）が格納されます。conf/routesはルーティング設定ファイルで、URLとコントローラを対応づけます。これらのフォルダ構成を理解しておくことで、後々の開発がスムーズになります。

5. sbt runでPlayアプリケーションを起動する

次に、作成したPlay Frameworkプロジェクトを起動してみましょう。まずは、プロジェクトのフォルダに移動します。


cd my-first-play

そして次のコマンドを実行します。


sbt run

初回の起動時には依存ライブラリのダウンロードが行われるため、少し時間がかかります。しばらく待つと次のようなメッセージが表示されます。


(Server started, use Ctrl+D to stop and go back to the console...)

この状態でブラウザを開き、次のURLにアクセスしてみましょう。

http://localhost:9000

すると、Play Frameworkのウェルカムページが表示されます。これでPlay Frameworkのプロジェクトが正常に作成・起動できたことが確認できます。

6. よくあるエラーと対処法

Play Frameworkのプロジェクト作成時に、ネットワーク環境やJavaの設定によってエラーが出る場合があります。例えば、次のようなエラーが発生することがあります。


Error: Unknown template playframework/play-java-seed.g8

この場合は、インターネット接続を確認したうえで、再度sbt newコマンドを実行してみてください。また、sbtのバージョンが古いとPlay Frameworkのテンプレートを取得できない場合もあるため、sbt sbtVersionコマンドでバージョンを確認し、必要に応じてアップデートしましょう。