Play Frameworkで複雑なネストフォームを攻略！複数モデルのバリデーションJava解説
生徒
「Play Frameworkでユーザー登録画面を作っているのですが、住所情報のようにもっと細かい項目をグループ化して管理する方法はありますか？」
先生
「ありますよ。それは『ネストしたフォーム』という手法を使います。ユーザーという大きな箱の中に、住所という小さな箱を入れるイメージですね。」
生徒
「複数のモデルが絡むとバリデーションやデータの受け取りが難しそうです。初心者でも実装できますか？」
先生
「大丈夫です！Play FrameworkのForm機能は非常に強力で、階層構造になったデータも自動的に整理してくれます。具体的な書き方をマスターしていきましょう！」
1. 複雑なフォームとネスト構造の重要性
ウェブアプリケーションを開発していると、単純な一行の入力項目だけでは足りない場面が多々あります。例えば「会員登録」を思い浮かべてください。名前やメールアドレスといった基本情報に加えて、「郵便番号、都道府県、市区町村」といった住所情報が必要になります。これらをバラバラに扱うのではなく、住所という一つのまとまりとして管理するのが「ネスト（入れ子）」という考え方です。
Play Frameworkでは、Javaのクラスの中に別のクラスを持たせることで、この階層構造を簡単に表現できます。これにより、データの整理がしやすくなるだけでなく、プログラムの再利用性も高まります。複数のモデルを組み合わせて一つの画面で送信する技術は、本格的なシステム開発において必須のスキルと言えるでしょう。
2. ネストされたデータモデルの作成方法
まずは、データを保持するためのJavaクラスを作成します。ポイントは、親となるクラスの中に、子となるクラスの変数を定義することです。例えば「UserForm」の中に「AddressForm」を含める形にします。これにより、送信されたフォームデータが自動的に適切な場所へ振り分けられるようになります。
このとき、各項目にはバリデーション用のアノテーションを付けておきます。親クラスを確認する際に、子クラスの中身までチェックするように設定するのがコツです。以下のコードは、その基本的な構造を示しています。
package forms;
import play.data.validation.Constraints;
import java.util.List;
public class UserForm {
@Constraints.Required(message = "名前は必須です")
protected String name;
// 住所情報をネストさせる
protected AddressForm address;
public String getName() { return name; }
public void setName(String name) { this.name = name; }
public AddressForm getAddress() { return address; }
public void setAddress(AddressForm address) { this.address = address; }
}
class AddressForm {
@Constraints.Required(message = "郵便番号を入力してください")
protected String zipCode;
@Constraints.Required(message = "住所を入力してください")
protected String street;
public String getZipCode() { return zipCode; }
public void setZipCode(String zipCode) { this.zipCode = zipCode; }
public String getStreet() { return street; }
public void setStreet(String street) { this.street = street; }
}
このように設計することで、プログラム側では「ユーザーの住所の郵便番号」という形で、整然とデータを扱うことができるようになります。未経験の方でも、フォルダの中にフォルダを作る感覚で理解できるはずです。
3. HTMLテンプレートでのネスト項目の書き方
画面側（Scalaテンプレート）では、入力項目の「name」属性の書き方に注意が必要です。親の項目名と子の項目名をドット（.）で繋ぐことで、Play Frameworkが「これはネストされたデータだ」と認識してくれます。
例えば、住所の郵便番号を入力する欄であれば、名前を「address.zipCode」にします。これにより、送信ボタンが押されたときに、自動的にJavaクラスの階層構造に合わせて値を詰め込んでくれます。実際のHTMLコードの例を見てみましょう。
@import play.data.Form
@(userForm: Form[forms.UserForm])
<div class="container mt-4">
<form action="/register" method="POST">
<div class="card p-3 mb-3">
<h5>基本情報</h5>
<input type="text" name="name" placeholder="お名前" class="form-control mb-2">
</div>
<div class="card p-3 mb-3 border-primary">
<h5>住所情報（ネスト項目）</h5>
<input type="text" name="address.zipCode" placeholder="郵便番号" class="form-control mb-2">
<input type="text" name="address.street" placeholder="住所" class="form-control mb-2">
</div>
<button type="submit" class="btn btn-primary">登録する</button>
</form>
</div>
このように書くだけで、複雑なデータの紐付けが完了します。ドット記法はネストフォームの基本ですので、しっかり覚えておきましょう。Bootstrapのカードを使って見た目を分けると、ユーザーにとっても親切な設計になります。
4. リスト形式の複数モデルを扱う方法
次に、さらに一歩進んで「一人のユーザーが複数の電話番号を持っている」というような、リスト形式のデータを扱う方法を解説します。これは、同じ項目のセットが画面上にいくつも並ぶパターンです。
HTML側では、添字（インデックス）を使って「phones[0].number」や「phones[1].number」のように記述します。Play FrameworkのJava側では、これらをListとして受け取ることができます。この仕組みを使えば、動的に入力欄が増えるような高度なフォームも作成可能です。
package forms;
import java.util.ArrayList;
import java.util.List;
public class ComplexUserForm {
protected String name;
// 複数の電話番号をリストで保持
protected List<PhoneForm> phones = new ArrayList<>();
public String getName() { return name; }
public void setName(String name) { this.name = name; }
public List<PhoneForm> getPhones() { return phones; }
public void setPhones(List<PhoneForm> phones) { this.phones = phones; }
}
class PhoneForm {
protected String number;
public String getNumber() { return number; }
public void setNumber(String number) { this.number = number; }
}
リスト形式にすることで、データの個数が決まっていない場合でも柔軟に対応できるアプリケーションになります。これが複数モデルを同時に扱う際の強力な武器となります。
5. コントローラーでの一括バリデーション
ネストされたフォームでも、コントローラーでの受け取り方は通常のフォームと同じです。formFactoryを使ってバインドするだけで、Play Frameworkが再帰的に（中身まで追いかけて）データを構築し、バリデーションを実行してくれます。
エラーが発生した場合は、親の項目に関連するエラーも、子の項目に関連するエラーもまとめて取得できます。以下のコードでは、複雑なデータを受け取って結果を判定する処理の流れを示します。
package controllers;
import forms.UserForm;
import play.data.Form;
import play.data.FormFactory;
import play.mvc.*;
import javax.inject.Inject;
public class UserController extends Controller {
@Inject
FormFactory formFactory;
public Result register(Http.Request request) {
Form<UserForm> userForm = formFactory.form(UserForm.class).bindFromRequest(request);
if (userForm.hasErrors()) {
// 子要素のエラーも含めて判定される
return badRequest(views.html.register.render(userForm));
}
UserForm data = userForm.get();
String city = data.getAddress().getStreet();
return ok("登録完了！住所は " + city + " ですね。");
}
}
このように、一つのhasErrors()チェックだけで、複雑な階層全体の正当性を確認できるのが大きな利点です。プログラミングの手間が大幅に削減されているのがわかるでしょう。
6. 画面へのエラーメッセージ表示のコツ
複雑なフォームになればなるほど、ユーザーはどこで間違えたのか分からなくなりがちです。Play Frameworkでは、ネストされた項目のエラーメッセージも簡単に取り出すことができます。テンプレート側で、特定のキーに紐付いたエラーがあるかどうかを確認しましょう。
例えば「address.zipCode」にエラーがある場合、そのキーを指定してエラー文言を表示させます。これにより、複雑な入力フォームでも、ユーザーが迷わずに修正できる親切なインターフェースを提供できます。エラー表示の有無でBootstrapのクラスを切り替えるなど、視覚的な工夫を凝らすのもおすすめです。
7. 複数モデル間の相関バリデーション
「ある項目がAなら、別の項目Bは必須」というような、モデルをまたいだチェックが必要な場合もあります。これは「相関バリデーション」と呼ばれます。Play FrameworkのJavaでは、フォームクラス内にvalidateメソッドを定義することで、カスタムチェックを記述できます。
このメソッドの中で、親クラスの値と子クラスの値を比較し、不整合があればエラーメッセージを返すようにします。これにより、単体のアノテーションでは表現できない、より業務に近い複雑なルールをアプリに組み込むことが可能になります。データの正確性を守るための、プロフェッショナルな一歩です。
8. 実践的なデバッグと動作確認の手順
複雑なフォームがうまく動かないときは、ブラウザからどのようなデータが送信されているかを確認しましょう。開発者ツールの「ネットワーク」タブを見れば、送信されたデータのキー名が「address.zipCode」のように正しくなっているかチェックできます。もしキー名が間違っていれば、Javaクラスの方にはデータが入りません。
また、コントローラーで受け取った直後に、ログ出力を行って中身を確認するのも有効です。パソコン操作に慣れていないうちは、一気に作ろうとせず、まずは一つのネスト項目から始め、動作を確認しながら徐々に項目を増やしていくのが、遠回りのようで一番の近道です。
9. 学習を加速させるためのアドバイス
最初は「クラスの中にクラスを入れる」という構造に戸惑うかもしれません。しかし、これは現実世界の「書類」と同じです。一つの大きな申込書の中に、「家族情報欄」や「勤務先情報欄」があるのと全く同じ理屈です。この感覚を掴んでしまえば、どんなに複雑な入力画面でも怖くありません。
Play Frameworkは、私たちが本来書かなければならない面倒な変換処理を、裏側で全て引き受けてくれます。その恩恵を最大限に活用するために、まずはこのネスト構造に慣れていきましょう。自分で作った複雑なフォームが思い通りに動いたとき、あなたの開発スキルは確実に一段階上のレベルへと到達しているはずです。
