あんまりDDD関係ないですが、DDDプロジェクトでフォームバリデーションがどうなってるのかを見てみる企画です。

関連記事

リンク

参考

https://github.com/citerus/dddsample-core

DDDのサンプルでどのようにエラーメッセージを出しているのか確認する。

画面

トラッキングIDから貨物の配送状況を検索できる

間違ったトラッキングIDや、入力不備がある場合はエラーメッセージが表示される

バインド

thymeleafのth:object=を使ってフォームのバインディングを行っています。

<form method="post" th:object="${trackCommand}">
    <table>
        <tr>
            <td>
                Enter your tracking id:
            </td>
            <td>
                <input th:field="*{trackingId}" id="idInput"/>
            </td>
            <td>
                <input type="submit" value="Track!"/>
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <p th:if="${#fields.hasErrors('trackingId')}" th:errors="*{trackingId}" class="error"></p>
            </td>
            <td></td>
        </tr>
    </table>
</form>

この場合はtrackCommandが紐づいてます。→ よくXXXFormって名前で利用することが多い印象です。

TrackCommand

インターフェース層にある
トラッキングIDのみ保持しています
アノテーションを利用していない

public final class TrackCommand {

  /**
   * The tracking id.
   */
  private String trackingId;

  public String getTrackingId() {
    return trackingId;
  }

  public void setTrackingId(final String trackingId) {
    this.trackingId = trackingId;
  }

  @Override
  public String toString() {
    return ToStringBuilder.reflectionToString(this, MULTI_LINE_STYLE);
  }
}

検証を行うにはValidatorを実装したクラスが必要になり、そのクラスがTrackCommandValidator(インターフェース層)です。Validatorインターフェースは、supportsとvalidateメソッドの実装が必要になります。

supports

検証するクラス(引数)
Spring設定ファイルの読み込み時にチェックされる

validate

検証するクラスのオブジェクト(引数)
検証結果を保持しているErrorsインターフェース（BindingResultはErrorsを継承している)(引数)
実際に行うバリデーショを実装する

validateメソッドは以下のようにしてValidationUtilsを使うこともできる

public void validate(final Object object, final Errors errors) {
    ValidationUtils.rejectIfEmptyOrWhitespace(errors, "trackingId", "error.required", "Required");
  }

以下のようにしてTrackCommandValidatorを利用する

new TrackCommandValidator().validate(command, bindingResult);

ちなみに現場至上主義の本ではUtilクラスを使わず、自分で決めたルールを実装しています。

参考 https://github.com/miyabayt/spring-boot-doma2-sample

テンプレートメソッドでvalidateメソッドから呼ばれています
引数はジェネリクスを利用してキャストしている

@Override
    protected void doValidate(StaffForm form, Errors errors) {

        if (isNotEquals(form.getPassword(), form.getPasswordConfirm())) {
            errors.rejectValue("password", "staffs.unmatchPassword");
            errors.rejectValue("passwordConfirm", "staffs.unmatchPassword");
        }
    }

抽象クラス

@SuppressWarnings("unchecked")
    @Override
    public void validate(final Object target, final Errors errors) {
        try {
            boolean hasErrors = errors.hasErrors();

            if (!hasErrors || passThruBeanValidation(hasErrors)) {
                doValidate((T) target, errors);
            }
        } catch (RuntimeException e) {
            log.error("validate error", e);
            throw e;
        }
    }

DDDのサンプルでは、指定したトラッキングIDでCargoが取得できない時にrejectValueを使っています。

@RequestMapping(method = RequestMethod.POST)
    protected String onSubmit(final HttpServletRequest request,
    														 final TrackCommand command,
    														 final Map<String, Object> model,
    														 final BindingResult bindingResult 
    														 
                                                             ) {
        new TrackCommandValidator().validate(command, bindingResult);

        final TrackingId trackingId = new TrackingId(command.getTrackingId());
        final Cargo cargo = cargoRepository.find(trackingId);

        if (cargo != null) {
            final Locale locale = RequestContextUtils.getLocale(request);
            final List<HandlingEvent> handlingEvents = handlingEventRepository.lookupHandlingHistoryOfCargo(trackingId).distinctEventsByCompletionTime();
            model.put("cargo", new CargoTrackingViewAdapter(cargo, messageSource, locale, handlingEvents));
        } else {
            bindingResult.rejectValue("trackingId", "cargo.unknown_id", new Object[]{command.getTrackingId()}, "Unknown tracking id");
        }
        return "track";
    }

入力値のエラー結果を、そのまま取得エラーなどでも流用している

アノテーションを使った場合

@NotEmptyなどのアノテーションを利用したい場合TrackCommandクラスにhogeIdを設定してNotEmptyアノテーションを利用する

/**
   * The hogeId id.
   */
  @NotEmpty
  private String hogeId;

  public String getHogeId() {
    return hogeId;
  }

  public void setgetHogeId(final String hogeId) {
    this.hogeId = hogeId;
  }

コントローラーの引数のTrackCommandに@Vaildアノテーションを付けて、BindingResultの順序をTrackCommandのすぐ後に変更する

@RequestMapping(method = RequestMethod.POST)
    protected String onSubmit(final HttpServletRequest request,
    														 @Valid final TrackCommand command,
    														 final BindingResult bindingResult,  
    														 final Map<String, Object> model
                                                             ) {
        new TrackCommandValidator().validate(command, bindingResult);

画面にhogeIdの項目を追加しておく。

<form method="post" th:object="${trackCommand}">
    <table>
        <tr>
            <td>
                Enter your tracking id:
            </td>
            <td>
                <input th:field="*{trackingId}" id="idInput"/>
            </td>
            <td>
                <input th:field="*{hogeId}" id="idHoge"/>
            </td>
            <td>
                <input type="submit" value="Track!"/>
            </td>
        </tr>
        <tr>
            <td></td>
            <td>
                <p th:if="${#fields.hasErrors('trackingId')}" th:errors="*{trackingId}" class="error"></p>
                <p th:if="${#fields.hasErrors('hogeId')}" th:errors="*{hogeId}" class="error"></p>
            </td>
            <td></td>
        </tr>
    </table>
</form>

hogeIdについては自動的にバリデーション処理が実行されています。

ちなみにコントローラーの引数の順序を間違えると400エラーになります。

WebDataBinderを利用する場合

WebDataBinderを使って事前にvalidateメソッドを呼び出してみます。

コントローラーの修正

@InitBinderを利用する
TrackCommandValidatorをAutowiredする
引数に@Validatedを付与する
引数の順序を変更する

@Controller
@RequestMapping("/track")
public final class CargoTrackingController {
...省略
    @Autowired
    TrackCommandValidator trackCommandValidator;
    
    @InitBinder("trackCommand")
    public void validatorBinder(WebDataBinder binder) {
        binder.addValidators(trackCommandValidator);
    }
..省略
    @RequestMapping(method = RequestMethod.POST)
    protected String onSubmit(final HttpServletRequest request,
    														@Validated final TrackCommand command,
    														 final BindingResult bindingResult,
    														 final Map<String, Object> model		 
                                                             ) {
    	
        // new TrackCommandValidator().validate(command, bindingResult);
    	// validateが既に呼ばれてbindingResultにはエラー結果が格納済である
    	if(bindingResult.hasErrors()) {
    		System.out.println("エラーあり");
    		System.out.println(bindingResult);
    	}

        final TrackingId trackingId = new TrackingId(command.getTrackingId());
        final Cargo cargo = cargoRepository.find(trackingId);

        if (cargo != null) {
            final Locale locale = RequestContextUtils.getLocale(request);
            final List<HandlingEvent> handlingEvents = handlingEventRepository.lookupHandlingHistoryOfCargo(trackingId).distinctEventsByCompletionTime();
            model.put("cargo", new CargoTrackingViewAdapter(cargo, messageSource, locale, handlingEvents));
        } else {
            bindingResult.rejectValue("trackingId", "cargo.unknown_id", new Object[]{command.getTrackingId()}, "Unknown tracking id");
        }
        return "track";
    }
...省略

Validatorクラスの修正

特に必要がないが、hogeIdの必須化と独自メッセージの設定を行っておく※@NotEmptyアノテーションを外しておきます。

public void validate(final Object object, final Errors errors) {
    ValidationUtils.rejectIfEmptyOrWhitespace(errors, "trackingId", "error.required", "Required");
    //　追加
    TrackCommand tc = (TrackCommand)object;
    if(Objects.isNull(tc.getHogeId())) {
    	errors.rejectValue("hogeId", "error.required","hogeIdが入力されていません");
  
    }
  }

注意点

rejectValueの引数のfiledはtemplateのth:fieldと一致していること
エラーコードは存在するものを指定する

画面の確認

何も入力せずにTrack!ボタンの呼び出しを行い、以下を確認

自動的にValidateメソッドが呼ばれていること
hogeIdについては独自のメッセージが表示されていること
ログにエラーありが出力されていること

ログ

エラーあり
org.springframework.validation.BeanPropertyBindingResult: 2 errors
Field error in object &#39;trackCommand&#39; on field &#39;trackingId&#39;: rejected value []; codes [error.required.trackCommand.trackingId,error.required.trackingId,error.required.java.lang.String,error.required]; arguments []; default message [Required]
Field error in object &#39;trackCommand&#39; on field &#39;hogeId&#39;: rejected value [null]; codes [error.required.trackCommand.hogeId,error.required.hogeId,error.required.java.lang.String,error.required]; arguments []; default message [hogeIdが入力されていません]

WebDataBinderを利用することでコントローラーより前に入力チェックが行われるので、コードがよりスッキリしたと思います。

もちろんWebDataBinderの設定がわかっていること前提ですが

DDDプロジェクトで見るSpringのバリデーション