前回の記事でリクエストの内容をFormクラスを使って処理できることを確認しました。今回はリクエストの内容の妥当性を検証するため、バリデーション処理を行います。

前回の記事

リンク

依存関係として以下を追加しています

implementation &#39;org.springframework.boot:spring-boot-starter-validation&#39;

単項目チェック

単項目チェックは1項目を単体でチェックします。例えば値が入力されているか、桁数が適切か、などのその項目単体で行われるチェックです。

今回は以下の手順で単項目チェックを実装します。

Formクラスにアノテーションを付与する
コントローラーにアノテーションを付与する
BindingResultを利用してエラー内容を表示する

Formクラスにアノテーションを付けてnameにはブランクを許可しないようにします。現状はブランクを渡しても問題なく処理が通ります。

Formクラスを修正します。@NotBlankを付けて空白文字列を許さないようにします。

@Getter
public class StoreForm {
	@NotBlank
	private String name;
	private String district;
}

@Validated

次にコントローラーでバリデーションを実行するための@Validatedアノテーションを付与します。

@PostMapping("/save")
	public Store save(@Validated @RequestBody StoreForm storeForm) {
		System.out.print(storeForm);
		Store store = new Store();
		store.setName(storeForm.getName());
		store.setDistrict(storeForm.getDistrict());
		return store;
	}

これで先ほどと同じリクエストを送信するとエラーになります。

BindingResult

次にBindingResultを利用します。今回はnameがブランクの時に速攻例外になっていましたが、BindingResultを使うことで一旦エラー内容を持っておくことができます。

BidingResultは引数の中でFormクラスのすぐ後ろに記載します。

@PostMapping("/save")
	public Store save(@Validated @RequestBody StoreForm storeForm,BindingResult bindingResult) throws Exception {
		if(bindingResult.hasErrors()) {
			bindingResult.getAllErrors().stream().forEach(System.out::println);
			throw new Exception();
		}
		System.out.print(storeForm);
		Store store = new Store();
		store.setName(storeForm.getName());
		store.setDistrict(storeForm.getDistrict());
		return store;
	}

以下のようなログが流れます

Field error in object &#39;storeForm&#39; on field &#39;name&#39;: rejected value []; codes [NotBlank.storeForm.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [storeForm.name,name]; arguments []; default message [name]]; default message [空白は許可されていません]

※エラーハンドリングについては関連記事をご確認ください。

相関チェック

相関チェックは複数の項目に対する妥当性検証です。例えばnameが入力されている場合はdistrictは必須など、何かの項目と何かの項目の両方を検証します。

手順

Validatorインターフェースを実装したクラスを作成する
コントローラーでバリデーターとフォームをバインドする
@Validatedアノテーションを付ける
- 単項目チェックと同様

Validatorインターフェースを実装する

org.springframework.validation.Validatorは、以下のメソッドをオーバーライドする必要があります。

supports
- 検証するクラス(引数)
- Spring設定ファイルの読み込み時にチェックされる
- Validatorのサポート対象の型かどうか判定されるhttps://terasolunaorg.github.io/guideline/5.4.1.RELEASE/ja/ArchitectureInDetail/WebApplicationDetail/Validation.html
  - https://terasolunaorg.github.io/guideline/5.4.1.RELEASE/ja/ArchitectureInDetail/WebApplicationDetail/Validation.html
validate
- 検証するクラスのオブジェクト(引数)キャストしてチェックします
- 検証結果を保持しているErrorsインターフェース（BindingResultはErrorsを継承している)(引数)
- メッセージは実在するメッセージコードを指定する
  - キャストしてチェックします

今回はnameが8文字以上の時にdistrictが6以下であることを検証します。（謎の妥当性）

@Component
public class StoreValidator implements Validator{

	@Override
	public boolean supports(Class<?> clazz) {
		// 定型的な書き方
		return StoreForm.class.isAssignableFrom(clazz);
	}

	@Override
	public void validate(Object target, Errors errors) {
		StoreForm form = (StoreForm)target;
		if(form.getName().length() > 8 && form.getDistrict().length() < 6) {
			errors.rejectValue("district", "error.required", "nameが8文字以上の時にdistrictが6以下である必要があります");
		}
	}

}

@Componentアノテーションをつけて、コントローラーからDIできるようにしておきます。

バリデーターをFormに紐づける

手順

バリデーターをDIする
@InitBinderがついたメソッドで作成したバリデーターをWebDataBinderに追加する

@Autowired
	private StoreValidator storeValidator;

	@InitBinder
	public void validatorBinder(WebDataBinder binder) {
		binder.addValidators(this.storeValidator);
	}

この状態で、単項目チェックと同様の@Validatedアノテーションがついたメソッドが実行されるとFormのバリデーションが行われます。

@PostMapping("/save")
	public Store save(@Validated @RequestBody StoreForm storeForm,BindingResult bindingResult) throws Exception {
		if(bindingResult.hasErrors()) {
			bindingResult.getAllErrors().stream().forEach(System.out::println);
			throw new Exception();
		}
		System.out.print(storeForm);
		Store store = new Store();
		store.setName(storeForm.getName());
		store.setDistrict(storeForm.getDistrict());
		return store;
	}

バリデーションでエラーになると以下のようなエラーメッセージがログに流れます

Field error in object 'storeForm' on field 'district': rejected value [東京]; codes [error.required.storeForm.district,error.required.district,error.required.java.lang.String,error.required]; arguments []; default message [nameが8文字以上の時にdistrictが6以下である必要があります]

関連記事

リンク

リンク

エラーハンドリングについて

リンク

参考サイト

https://b1san-blog.com/post/spring/spring-validation/

Spring | フォームバリデーション