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

生徒

「先生、Play Frameworkでチーム開発するとき、ディレクトリ構成はどう決めればいいですか？」

先生

「チームで開発する場合は、プロジェクト内のディレクトリ構成を統一すると作業がスムーズになります。ルールを決めておくと、誰が見ても分かりやすいプロジェクトになります。」

生徒

「具体的にどのようなルールがあるんですか？」

先生

「例えば、コントローラ、モデル、ビュー、静的ファイルの配置や命名規則、テストの場所などです。これらを明確に決めておくことが重要です。」

1. Play Frameworkの基本ディレクトリ構成

Play Frameworkの標準ディレクトリ構成は以下の通りです。


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

この基本構成を元にチーム開発用のルールを追加すると、プロジェクト管理がより効率的になります。

2. コントローラとモデルの命名ルール

チーム開発では、コントローラやモデルの命名を統一することが重要です。

コントローラ：UserController, ProductControllerなど、先頭を大文字でクラス名をわかりやすく
モデル：User, Productなど、データベーステーブルと対応させる
パッケージ：controllersやmodelsというフォルダで管理

これにより、他のメンバーがコードを見ても、どこに何があるかすぐに理解できます。

3. ビューと静的ファイルの管理

ビューはTwirlテンプレートを使ってapp/viewsに配置します。ファイル名は画面の内容がわかるように命名します。

ホーム画面：home.scala.html
ユーザー一覧：userList.scala.html
部分テンプレートはpartial_を付ける：partial_header.scala.html

また、CSSやJavaScript、画像などの静的ファイルはpublicディレクトリにまとめます。これもチームで統一することで参照ミスを減らせます。

4. テストディレクトリの活用

Play Frameworkではテストコードはtestディレクトリに配置します。チーム開発では、次のように分類するとわかりやすいです。

コントローラのテスト：controllersパッケージに配置
モデルのテスト：modelsパッケージに配置
共通ユーティリティやサービスのテストも別パッケージで管理

テストが整理されていると、チーム全体での品質向上にもつながります。

5. ルーティングと設定ファイルの整理

conf/routesファイルは、アプリケーションのURLとコントローラを紐付ける重要なファイルです。チームで編集する場合は次のルールを設けると良いでしょう。

画面単位でコメントを付けて区切る
新しいルートを追加する際は必ず既存の順序を守る
定数や設定はconf/application.confにまとめる

このルールにより、ルーティングの競合や設定の重複を防ぎ、チーム開発でのトラブルを減らせます。

6. まとめると

Play Frameworkのチーム開発では、ディレクトリ構成のルールを明確にしておくことが重要です。コントローラ、モデル、ビュー、静的ファイル、テスト、ルーティング、設定ファイルの配置と命名を統一することで、チーム全体が効率よく作業できます。初心者でもルールを覚えておくと、チーム開発がスムーズになり、後からコードを見たメンバーも理解しやすくなります。