Springbootでビジネスロジックにおける精査でエラーが発生した場合、該当の項目の背景色を変更したい

実現したいこと

Springbootで、ControllerやService層のビジネスロジックにおける精査でエラーが発生した場合、該当の項目の背景色を変更したい

前提

Strtusでは、Formのバリデーションだけでなく、ビジネスロジックの精査処理でエラーが発生した場合に、ActionErrorsにプロパティ名を引数で渡せば、該当の項目がerrorStyleClassに従い背景色が変わると思っています。

同様のことをSpringbootで実現したいです。Formのバリデーションではなく、ビジネスロジックでの精査で、該当の項目の背景色を変更したいです。
（form:inputタグを想定しています）

タグを拡張しないとできないとか、エラー処理の作り込みが必要など、本件実現したことがある方いればアドバイスいただければ幸いです。

行動規範の内容に同意します

回答1件

ベストアンサー

色々やり方はあると思いますが、例えばrejectValueで作ることができます。

java
1@PostMapping("/form")
2public String post(@Validated Product product, BindingResult result) {
3    if (result.hasErrors()) {
4        return "form";
5    }
6    // validateで何らかの精査処理が走る場合
7    if (businessLogic.validate(product)) {
8        result.rejectValue("content", "error.content", "ビジネスロジックのエラーです");
9        return "form";
10    }
11    return "index";
12}

HTML側は、th:errorclassを使うとエラー時に（classが追加され）背景色を変更できます。

html
1<!DOCTYPE html>
2<html xmlns:th="http://www.thymeleaf.org">
3<head>
4  <meta charset="UTF-8">
5  <title>Title</title>
6  <style>
7    .is-invalid {
8      background-color: #fee2e2;
9    }
10    .is-invalid-text {
11      color: red;
12    }
13  </style>
14</head>
15<body>
16  <form th:action="@{/form}" th:object="${product}" method="post">
17    <input type="text" th:field="*{content}" th:errorclass="is-invalid">
18    <button>登録</button>
19    <br>
20    <small th:errors="*{content}" class="is-invalid-text"></small>
21  </form>
22</body>
23</html>

■その他

以下は、その他のサンプルとなります。例えば、アノテーションを自作する場合は「@interface バリデーション名」で作成できます。

java
1@Getter
2@Setter
3@Entity
4public class Product {
5    @Id
6    @GeneratedValue
7    private Long id;
8
9    @NotBlank
10    //@Custom 自作バリデーションを作る場合
11    private String content;
12}
13
14@Retention(RetentionPolicy.RUNTIME)
15@Target(ElementType.FIELD)
16@Constraint(validatedBy = CustomValidator.class)
17public @interface Custom {
18    // 省略

投稿2023/12/09 14:36

編集2023/12/09 15:39

IT001

総合スコア618

kojiroy

2023/12/10 08:32

アドバイスありがとうございます。こちらの前提の提示がよくなかった点ではありますが、Thymeleafではなくjspでやれればと思います。(諸般の都合…) 単純なspringのタグ(form:inputなど)でやろうとすると、「エラー時にclassを追加する」拡張タグを作るしかないですかね…。 ※rejectValue+th:errorclass はそういうのもあるのかと勉強になりました。ありがとうございます。

IT001

2023/12/10 13:22 編集

jspの場合は、cssErrorClassでエラー時にclassを追加することができます。詳しくは、以下のドキュメントのcssErrorClassの部分をご参照ください。 https://terasolunaorg.github.io/guideline/current/ja/ArchitectureInDetail/WebApplicationDetail/Validation.html#validation-basic-validation jsp時のコードは、以下のようになります。 <form:input path="content" cssErrorClass="is-invalid" /> ※Spring Boot公式がJSPを推奨していないので、可能であればどこかのタイミングでThymeleafなどに移行した方が宜しいかとは思いますが…私自身も大規模案件で、諸般の都合がいっぱいあったので厳しいのが理解できます…。

kojiroy

2023/12/11 02:40

ありがとうございます。いただいたアドバイスをもとにrejectValueとcssErrorClassの合わせ技で想定の挙動となりました。大変助かりました。 ※そうですね、Thymeleafだともっといい点もあるかとおもいますが、なかなか諸般の都合が・・・。

IT001

2023/12/11 11:32

Thymeleaf時とJSP時の違いなど、Spring Bootは色々な書き方があるので動いて良かったです。

行動規範の内容に同意します