Cubby ではフォームから入力された値をバリデーションする仕組みが用意されています。
フォームから入力された値は HttpServletRequest#getParameterValues で返される値が String の配列であることからもわかるように、 全ての値は配列として取得できます。この配列に対してバリデーションを行います。
また、それ以外にもフォームオブジェクトやデータベースを参照したバリデーションをプログラム上に定義することができます。
バリデーションの定義は Java コードで記述します。以下のように、アクションメソッドに対してバリデーションのルールを定義します。
以下のようにDefaultValidationRules を継承して、 initialize メソッドをオーバーライドし、そのメソッドの中で add メソッドを用いて フォームのフィールドごとにバリデーションのルールを追加します。
public class LoginAction extends Action { // バリデーションのルール public ValidationRules validationRules = new DefaultValidationRules() { @Override public void initialize() { // フィールド "userId" は必須入力で最大10文字まで add("userId", new RequiredValidator(), new MaxLengthValidator(10)); // フィールド "password" は必須入力で最大10文字まで add("password", new RequiredValidator(), new MaxLengthValidator(10)); } }; ...
入力検証でエラーを検出した場合は、アクションのプロパティerrors にメッセージが設定され、errorPage で指定されたページに遷移します。
// プロパティ「validationRules」をバリデーションのルールとして使用します。 // 検証エラー発生時は「confirm.jsp」に遷移します。 @Form @Validation(rules = "validationRules", errorPage = "confirm.jsp") public ActionResult save1() { ... } }
Cubbyで定義済みのバリデーションクラスは以下のものがあります。
ScalarFieldValidator を実装しているクラスがひとつの要素を検証するバリデータ、 ArrayFieldValidator を実装しているクラスが配列全体を検証するバリデータとなっています。
定義済みバリデーションクラス一覧
クラス名 | 説明 |
ArrayMaxSizeValidator | 配列の最大サイズを検証します。 |
ArrayMinSizeValidator | 配列の最小サイズを検証します。 |
DateFormatValidator | 日付に対する検証を行います。 |
EmailValidator | Eメールアドレスに対する検証を行います。 |
EqualsValidator | 指定した文字列と等しいかどうかを検証します。 |
FileRegexpValidator | ファイルアップロードのファイル名が指定された正規表現にマッチするか検証します。 |
MaxLengthValidator | 最大文字数を検証します。 |
NumberValidator | 数値かどうかを検証します。 |
RangeLengthValidator | 文字列の長さの範囲を指定して検証します。 |
RangeValidator | 数値の範囲を指定して検証します。 |
RegexpValidator | 指定された正規表現にマッチするか検証します。 |
RequiredValidator | 必須検証します。 |
TokenValidator | 2重サブミットを検証します。 |
詳細はAPIドキュメント をご覧下さい。
バリデーションのエラーメッセージは以下のルールで作成されます。
public class LoginAction extends Action { // 項目のメッセージキーを指定 public static ValidationRules VALIDATION = new DefaultValidationRules() { @Override public void initialize() { // メッセージキー"userId"の値がエラーメッセージ中の項目名として使用されます。 add("userId", new RequiredValidator(), new MaxLengthValidator(10)); // メッセージキー"login.password"の値がエラーメッセージ中の項目名として使用されます。 add("password", "login.password", new RequiredValidator(), new MaxLengthValidator(10)); } }; // 項目名のメッセージキーのプリフィックスを指定 public static ValidationRules VALIDATION2 = new DefaultValidationRules("login.") { @Override public void initialize() { // メッセージキー"login.userId"の値がエラーメッセージ中の項目名として使用されます。 add("userId", new RequiredValidator(), new MaxLengthValidator(10)); } }; // 各バリデーションにメッセージキーを指定 public static ValidationRules VALIDATION3 = new DefaultValidationRules() { @Override public void initialize() { // メッセージキー"err.myrequired"がエラーメッセージとして使用されます。 add("password", new RequiredValidator("err.myrequired")); } }; ... }
ほとんどが同じでいくつかの項目が異なる複数のルールを作りたい場合、以下のように他のルールをコピーして使用することができます。
public class LoginAction extends Action { // ベースのルール public static ValidationRules BASE_VALIDATION = new DefaultValidationRules() { @Override public void initialize() { add("userId", new RequiredValidator(), new MaxLengthValidator(10)); add("password", "login.password", new RequiredValidator(), new MaxLengthValidator(10)); } }; // ベースのルールに「nickname」の検証を追加 public static ValidationRules VALIDATION1 = new DefaultValidationRules() { @Override public void initialize() { // BASE_VALIDATIONのルールをコピーして追加 getRules().addAll(BASE_VALIDATION.getRules()); add("nickname", new RequiredValidator(), new MaxLengthValidator(10)); } }; // ベースのルールに「password2」の検証を追加 public static ValidationRules VALIDATION2 = new DefaultValidationRules() { @Override public void initialize() { // BASE_VALIDATIONのルールをコピーして追加 getRules().addAll(BASE_VALIDATION.getRules()); add("password2", new RequiredValidator(), new MaxLengthValidator(10)); } }; ... }
リクエストパラメータのバリデーションを独自に作成するにはScalarFieldValidator
またはArrayFieldValidator
を実装して作成します。
実装の方法はそれぞれのインターフェイスの実装クラス
を参照してください。
データベースアクセスなどの業務ロジックによるバリデーションを作成するにはValidationRule を実装して作成してください。
public String userId; public String password; public Map<String, Object> sessionScope; public ValidationRules loginValidation = new DefaultValidationRules( "login.") { @Override public void initialize() { add("userId", new RequiredValidator()); add("password", new RequiredValidator()); add(new UserValidationRule()); } }; private class UserValidationRule implements ValidationRule { public void apply(Map<String, Object[]> params, Object form, ActionErrors errors) throws ValidationException { if (userId == null || password == null) { return; } User user = findUser(userId, password); if (user != null) { sessionScope.put("user", user); } else { errors.add("ユーザIDかパスワードが違います。", "userId", "password"); } sessionScope.put("user", user); } }