エラーキャッチ時にform情報などを持たせたまま、入力画面に戻したい

Question

Java（Spring）初学者です。エラーキャッチ後のハンドリングについて質問です。
入力画面→確認画面→完了画面、と遷移する機能で
確認画面→完了画面の処理時に、入力内容を処理させる外部APIを叩き、正常時はそのまま完了画面に遷移しますが
エラー時は、Controllerのindexでformなど諸々定義された情報（下記Controller参照）を受け渡しつつ、入力画面に戻し、かつエラーメッセージも表示させたいです。

この場合、以下の実現方法を検討していますが、どうもしっくりきません。

①独自のExeptionを作成し、それをキャッチさせ、そのクラスの中で入力画面に戻すよう処理を組み込む。
→単に画面遷移だけであれば、ModelAndViewをnewしてsetViewNameで遷移先を指定すれば良いだけだが
form情報などControllerのindexメソッドでやっている処理ごと受け渡したい。その記述方法が不明。。

②formに新しくエラー表示用の項目を定義（"error"とします）し、エラー時に以下を記述（下記error参照）し、バインドエラーとして処理させる。
→バリデーションチェックでもないのに、エラー表示用にしか使わない項目をformに定義して使うこと自体が間違っている気がします。
また、gaibuService.gaibuApi(bindingResult);の処理後、すぐにbindingResult.hasErrors()を再度実行しているのもセンスが無い気がします。。

そもそもこの①、②の検討案自体間違っているかもしれませんが、作法等も含め、何かアドバイスを頂けるとありがたいです。

	/**
	* 入力画面
	**/
	@RequestMapping()
	public ModelAndView index(@ModelAttribute Form form) {

		List<TestDto> TestDtoList = CommonList.getTestDtoList();
		ModelAndView mav = new ModelAndView();
		mav.addObject("TestDtoList", TestDtoList);
		// 検討案②の時、以下を実装し、index.htmlで出力させる
		mav.addObject("error", error);
		mav.setViewName("/index");
		return mav;
	}

	/**
	* 完了画面
	**/
	@RequestMapping(value = complete)
	public ModelAndView complete(@Validated @ModelAttribute Form form, BindingResult bindingResult) throws Exception {

		// Validation Check
		if (bindingResult.hasErrors()) {
			return index(form);
		}

		// 外部APIを叩く処理。
		// 正常なら完了画面へ。エラー時はエラーメッセージと一緒に入力画面へ。
		gaibuService.gaibuApi(bindingResult);
		if (bindingResult.hasErrors()) {
			return index(form);
		}

		ModelAndView mav = new ModelAndView();
		mav.setViewName("/complete");
		return mav;
	}

		// エラー（ここではエラーフラグが"1"ならエラーとします）
		if(errorFlg.equals("1")) {
			FieldError fieldError = new FieldError(bindingResult.getObjectName(), "error", "表示させたいエラーメッセージ");
			bindingResult.addError(fieldError);
			return;
		}

Comments

[m.ts10806]

formをそのままMaVにaddするだけじゃだめなんですか？

[v_engineer0]

独自Exptionのクラスの中で、formで定義されている項目を以下のような感じで一つ一つaddするということでしょうか。
mav.addObject("test01", Form.getTest01);
記載し忘れてしまいましたが、formで定義された項目はprivateで定義されています・・

[m.ts10806]

>独自Exptionのクラスの中で
Exception です。
ただ、そのコードが提示されてないと、実装から「対応方法」は誰にも検討できないと思います。

Answer 1

入力→確認→完了画面のように入力内容を保持・伝搬させる場合、1つの方式として、セッション属性を利用します。
以下のように入力内容を格納するオブジェクト（ここではSampleFormとします）を用意し、

package com.github.apz.controller.confirm;

import java.io.Serializable;

import javax.validation.constraints.NotNull;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class SampleForm implements Serializable {
	@NotNull
	private String name;
}

ControllerにてSampleFormをセッション属性として利用するよう宣言します。

package com.github.apz.controller.confirm;

import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.SessionAttributes;
import org.springframework.web.servlet.ModelAndView;

import com.github.apz.service.ConfirmSampleService;

import lombok.RequiredArgsConstructor;

@Controller
@RequestMapping("/confirm")
@SessionAttributes("form")
@RequiredArgsConstructor
public class ConfirmSampleController {

	private final ConfirmSampleService service;

	@ModelAttribute(name = "form")
	public SampleForm form() {
		return new SampleForm();
	}

	@GetMapping("")
	public ModelAndView display(ModelAndView mnv, @ModelAttribute("form") SampleForm form) {
		mnv.setViewName("confirm/input");
		return mnv;
	}

	@PostMapping("confirm")
	public ModelAndView confirm(ModelAndView mnv, @ModelAttribute("form") @Validated SampleForm form, BindingResult bindingResult) {
		if (bindingResult.hasErrors()) {
			mnv.setViewName("confirm/input");
			return mnv;
		}
		mnv.setViewName("confirm/confirm");
		return mnv;
	}

	@PostMapping("complete")
	public ModelAndView complete(ModelAndView mnv, @ModelAttribute("form") @Validated SampleForm form, BindingResult bindingResult) {

		if (! service.test(form.getName())) {
			FieldError fieldError = new FieldError("form", "name", form.getName(), true, null, null, "capybaraから始まっていません。");
			bindingResult.addError(fieldError);
			mnv.setViewName("confirm/input");
			return mnv;
		}

		mnv.setViewName("confirm/complete");
		return mnv;
	}

}

なお、ここで定義しているConfirmSampleServiceは以下です。

package com.github.apz.service;

import org.springframework.stereotype.Service;

@Service
public class ConfirmSampleService {
	public boolean test(String name) {
		return name.startsWith("capybara");
	}
}

FieldErrorの作成については、以下の公式ドキュメントの日本語訳を参照してください。上記のサンプルコードでは便宜上nullで定義している内容は、エラーコードとエラーメッセージ用の設定を省略しています。

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/validation/FieldError.html

Comments

[v_engineer0]

返信遅れまして申し訳ありませんでした！
教えていただいた方法で解決致しました。ありがとうございました。