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

生徒

「Play Frameworkでプロジェクトを作ったんですが、構成をもっと整理したいです。何か良い方法はありますか？」

先生

「Play Frameworkでは、標準ディレクトリ構成をベースに、コントローラ、モデル、ビュー、静的ファイル、設定ファイル、テストを整理すると効率が上がります。チーム開発向けに最適化するルールも重要です。」

生徒

「具体的にどのようなベストプラクティスがありますか？」

先生

「順を追って説明しますね。初心者でもわかるように、サンプルや具体例を交えて解説します。」

1. ディレクトリを機能単位で整理する

Play Frameworkの基本構成はapp/controllers、app/models、app/views、public、conf、testです。この構成を元に機能ごとにサブフォルダを作るとチーム開発で管理がしやすくなります。

ユーザー関連機能：app/controllers/user, app/models/user, app/views/user
商品管理機能：app/controllers/product, app/models/product, app/views/product
管理画面機能：app/controllers/admin, app/views/admin

こうすることで、ファイルが増えても迷わず目的のコードにアクセスできます。

2. 命名規則の統一

チームで開発する際、クラス名やファイル名のルールを統一するとコードレビューや保守がスムーズになります。

コントローラクラス：UserController、ProductControllerなど先頭大文字で単数形
モデルクラス：User、Productなどデータベーステーブル名に合わせる
ビュー：home.scala.html、userList.scala.htmlのように画面内容を反映
部分テンプレート：partial_header.scala.htmlのようにpartial_を付ける

3. 共通コードやユーティリティの整理

複数の機能で共通して使う処理はapp/utilsやapp/servicesにまとめます。

日時変換やフォーマット処理：app/utils/DateUtils.scala
メール送信処理：app/services/MailService.scala
データベース共通処理：app/services/DBService.scala

共通化することで、コードの重複を避け、保守性が高まります。

4. 設定ファイルと環境ごとの管理

conf/application.confはアプリケーション全体の設定ファイルです。環境ごとに設定を分ける場合はapplication.dev.conf、application.prod.confなどを用意すると便利です。

開発環境：application.dev.conf
本番環境：application.prod.conf
秘密情報は環境変数やconf/secrets.confに分ける

5. テストとドキュメントの構成

テストコードはtestディレクトリに配置します。機能ごとにサブパッケージを作り、コントローラ、モデル、サービスごとに整理します。ドキュメントやREADMEもチームルールに沿って整理しましょう。

コントローラのテスト：test/controllers
モデルのテスト：test/models
サービスのテスト：test/services
READMEや設計資料はdocsディレクトリにまとめる

6. 公開用静的ファイルの整理

CSS、JavaScript、画像はpublicディレクトリにまとめます。機能や画面単位でサブディレクトリを作ると参照しやすくなります。

CSS：public/stylesheets/home.css、public/stylesheets/user.css
JavaScript：public/javascripts/main.js、public/javascripts/user.js
画像：public/images/logo.png、public/images/icons/

7. ベストプラクティスのまとめ

Play Frameworkでプロジェクトを最適化するには、機能単位でディレクトリを整理し、命名規則を統一し、共通処理をまとめることが重要です。環境ごとの設定やテスト、ドキュメントも明確に整理することで、チーム開発が効率的になり、保守性が向上します。初心者でもこれらのルールを覚えておくと、プロジェクトの成長に合わせて拡張しやすくなります。