Play Frameworkプロジェクトの作成方法を完全ガイド！初心者でもできる手順とポイント
生徒
「先生、Play Frameworkの環境構築まではできたんですが、新しいプロジェクトを作る方法がよくわかりません…。」
先生
「Play Frameworkでは、sbtコマンドを使ってプロジェクトを作成します。最初はちょっと独特な感じがしますが、慣れるととても簡単ですよ。」
生徒
「そうなんですね！sbtっていうのはPlayの専用コマンドなんですか？」
先生
「はい。ScalaやJavaのプロジェクトをビルドするためのツールで、Play Frameworkでもこれを使います。今日は初心者向けに、Play Frameworkの新規プロジェクト作成から起動までを丁寧に説明していきましょう。」
1. Play Frameworkプロジェクト作成の基本
Play Frameworkでは、sbtを使って新しいプロジェクトを作成します。sbtは「Scala Build Tool」の略で、JavaやScalaのアプリケーションをビルド、実行、テストするためのビルドツールです。Play Frameworkはこのsbtと連携して動作するため、プロジェクトの作成もsbtコマンドから始まります。
Play Frameworkのプロジェクトには、Java版とScala版があります。初心者の方には、まずJava版から始めることをおすすめします。
2. プロジェクトを作成するためのコマンド
Play Frameworkの新しいプロジェクトを作成するためには、ターミナル（またはコマンドプロンプト）で次のコマンドを実行します。
sbt new playframework/play-java-seed.g8
このコマンドを実行すると、sbtがPlay Frameworkのテンプレート（ひな型）を自動的にダウンロードし、新しいプロジェクトを作ってくれます。もしScala版を使いたい場合は、次のコマンドを使います。
sbt new playframework/play-scala-seed.g8
コマンドを実行すると、いくつかの質問が表示されます。たとえば、「プロジェクト名」や「組織名」などです。ここで入力する名前がそのままプロジェクトのフォルダ名になります。
3. sbt newコマンド実行後の流れ
コマンドを実行すると、以下のような手順でプロジェクトが作成されます。
- テンプレートのダウンロード：Play公式のGitHubからプロジェクトひな型が取得されます。
- プロジェクトフォルダの作成：指定した名前でディレクトリが自動生成されます。
- 設定ファイルの展開：
build.sbtやapplication.confなどの必要なファイルが配置されます。
すべてが完了すると、ターミナルに「Success! Your new application is ready.」と表示されます。これで新しいPlay Frameworkプロジェクトの準備が整いました。
4. プロジェクトを起動して確認する
次に、作成したプロジェクトを起動して動作を確認してみましょう。作成したディレクトリに移動してから、次のコマンドを実行します。
cd プロジェクト名
sbt run
初回起動時は依存ライブラリのダウンロードが行われるため、少し時間がかかります。完了すると、以下のようなメッセージが表示されます。
(Server started, use Ctrl+D to stop and go back to the console...)
この状態でブラウザを開き、http://localhost:9000にアクセスしてみてください。Play Frameworkのウェルカムページが表示されれば、プロジェクトの作成と起動が成功しています。
5. Play Frameworkプロジェクトのフォルダ構成
Play Frameworkのプロジェクトは、シンプルながら明確な構成になっています。以下が代表的なフォルダ構成です。
my-play-app/
├── app/ # コントローラ、モデル、ビューが入るメインフォルダ
│ ├── controllers/ # コントローラクラス
│ ├── models/ # モデルクラス
│ └── views/ # HTMLテンプレート（Twirlファイル）
├── conf/
│ ├── application.conf # 設定ファイル
│ └── routes # URLルーティング設定
├── public/ # 静的ファイル（CSS、JS、画像など）
├── build.sbt # プロジェクトビルド設定
└── project/ # sbt関連ファイル
初心者がまず理解しておくべきポイントは、appフォルダがアプリケーションの中核であることです。ここにコントローラやビュー、モデルといった主要なファイルが集まります。
6. IntelliJ IDEAでPlayプロジェクトを開く方法
Play FrameworkはIntelliJ IDEAとの相性が非常に良いです。次の手順で簡単に開発を始めることができます。
- IntelliJ IDEAを起動し、「Open」を選択します。
- 先ほど作成したPlayプロジェクトのフォルダを選びます。
- プロジェクトを開くと、自動的にsbtが認識され、依存関係をダウンロードします。
もし認識されない場合は、「File」→「Project Structure」→「Project SDK」でJDKを設定してから、「Reload sbt Project」をクリックしてください。
7. VSCodeでPlay Frameworkを開発する場合
VSCodeを使いたい方は、「Metals」拡張機能をインストールするのがおすすめです。これはScalaやsbtをサポートする強力なプラグインで、Play Frameworkの開発にも対応しています。
- 「Extensions」から「Metals」をインストール。
- Playプロジェクトを開くと、自動的にsbtを検出してビルドが始まります。
- コーディング中は、エラーや警告がリアルタイムで表示されます。
また、ターミナルでsbt runを実行すれば、VSCode上からサーバーを起動できます。保存した変更は自動的に反映されるため、開発効率が非常に高いのも特徴です。
8. 初心者がつまずきやすいポイント
Play Frameworkのプロジェクト作成では、いくつかの注意点があります。ここでは初心者がよく間違えるポイントを紹介します。
- 1. sbtが認識されない：環境変数PATHの設定を確認してください。
sbt sbtVersionが実行できればOKです。 - 2. JDKのバージョンエラー：Play 2.8以降はJDK 11以上が必要です。
- 3. フォルダ名に日本語やスペースを使う：sbtがうまく動かないことがあります。英数字のみを使いましょう。
- 4. 初回起動が遅い：依存ライブラリをダウンロードしているだけなので、時間がかかっても問題ありません。
これらを確認すれば、ほとんどのエラーは解決できます。Play Frameworkは構成がシンプルなので、慣れると非常に快適に開発できます。
9. Play Frameworkプロジェクト作成のコツ
Play Frameworkでの開発をスムーズに始めるためのコツをいくつか紹介します。
- プロジェクト名は短く、英小文字で統一する。
- テンプレートを使ってプロジェクトを作ることで、余計な設定を省ける。
conf/routesやapp/controllersの構造を理解しておくと、次のステップが楽になる。- 開発中は
sbt runを起動したままにして、ホットリロードを活用する。
これらを意識することで、初心者でもPlay Frameworkの開発をスムーズに進めることができます。
この記事を読んだ人からの質問
