バリデーション¶

クライアントサイド¶

jQuery Validation Pluginを使って、 FormのSubmitをフックして入力エラーがある場合は、動的にエラーメッセージを表示する。エラーがない場合は、Submitが行われる。

$(function() {
    // メッセージを上書きする
    $.extend($.validator.messages, {
        minlength: $.validator.format("{0}文字以上の文字を入力してください"),
        ...
    });

    $.validator.setDefaults({
        errorPlacement: function(error, element) {
            // エラーが発生した項目の色を変える
        },
        success: function(error, element) {
            // エラーがない状態に変わった時、色を戻す
        },
        onkeyup: function(element, event ) {
            // キーを離した時にバリデーションする
        },
        onfocusout: function(element) {
            // フォーカスが外れた時にバリデーションする
        },
        submitHandler: function(form){
            form.submit();
        }
    });

    // 入力チェックの種類を独自に増やす、または動作を上書きする
    $.validator.methods.email = function(value, element) {
        // 入力チェックして、エラーがある場合はfalseを返す
    };

    var options = {
        rules: {
            firstName: {
                required: true,
                maxlength: 50
            }
        }
    };

    // 初期化
    $("#form1").submit(function(e) {
        // validation pluginでsubmitするため潰しておく
        e.preventDefault();
    }).validate(options);
});

サーバーサイド¶

Bean Validation（単一項目チェック）¶

入力フォームのフィールドにアノテーションを指定する。

@Getter
@Setter
public class UserForm {

    @NotEmpty // ★空でないことをチェック
    @Size(min=2, max=30) // ★文字列長の下限上限チェック
    public String name;

    @Email // ★メールアドレス書式チェック
    public String email;
}

コントローラーの引数に@Validatedアノテーションを指定する。

public class UserController {

    @PostMapping("/new")
    public String newUser(@Validated UserForm form, BindingResult result, RedirectAttributes attributes) { // ★@Validatedを指定する
        if (result.hasErrors()) { // ★バリデーションエラーがある場合はTrueが返る
            setFlashAttributeErrors(attributes, result);
            return "redirect:/user/users/new";
        }
    }
}

画面にバリデーションエラーの内容を表示する。

<form th:object="${userForm}" method="post">
    <div th:with="valid=${!#fields.hasErrors('name')}">
        <input type="text" th:field="*{'name'}" />
        <span th:if="${!valid}" th:errors="*{'name'}">Error</span><!-- エラーがある場合はメッセージが表示される -->
    </div>
</form>

Spring Validator（相関チェック）¶

サンプルの実装では、org.springframework.validation.Validatorを実装した基底クラスを用意しているので、下記のようなバリデーターを実装すれば相関チェックができる。

@Component // ★Autowireするため@Componentを指定する
public class UserFormValidator extends AbstractValidator<UserForm> { // ★ジェネリクスにForm型を指定する

    @Override
    protected void doValidate(UserForm form, Errors errors) { // ★ジェネリクスの型で引数を受け取る

        // 確認用パスワードと突き合わせる
        if (!equals(form.getPassword(), form.getPasswordConfirm())) { // ★任意にチェックする
            errors.rejectValue("password", "users.unmatchPassword"); // ★エラーがあればErrorsオブジェクトに追加する
            errors.rejectValue("passwordConfirm", "users.unmatchPassword");
        }
    }
}

注釈

エラーメッセージは、ValidationMessages.propertiesに定義する。

コントローラーにFormオブジェクトごとにバリデーターを設定する。単一項目チェックと同様に、@Validatedアノテーションを指定しているとバリデーターが動作する。

@Controller
public class UserController {
    // ...
    @Autowired
    UserFormValidator userFormValidator; // ★Spring Validatorの実装

    @InitBinder("userForm")
    public void validatorBinder(WebDataBinder binder) {
        binder.addValidators(userFormValidator); // ★userFormにバインドする
    }
    // ...
}

アノテーションの自作¶

共通化したい場合は下記のようなアノテーションクラスを作成して利用できる。

@Documented
@Constraint(validatedBy = { ZipCodeValidator.class }) // ★バリデーターを指定する
@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RUNTIME)
public @interface ZipCode {

    String message() default "{validator.annotation.ZipCode.message}"; // ★バリデーションでエラーになった場合のメッセージキー

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    @Target({ FIELD })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        ZipCode[] value();
    }
}

アノテーションと対になるバリデーターを作成する。

public class ZipCodeValidator implements ConstraintValidator<ZipCode, String> { // ★どのアノテーションを対象とするか指定する

    static final Pattern p = Pattern.compile("^[0-9]{7}$");

    @Override
    public void initialize(ZipCode ZipCode) {
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        boolean isValid = false;

        if (StringUtils.isEmpty(value)) {
            isValid = true;
        } else {
            Matcher m = p.matcher(value);

            if (m.matches()) {
                isValid = true;
            }
        }

        return isValid;
    }
}