7.3　簡易書籍登録アプリケーションの説明（バリデーション版）

簡易書籍登録アプリケーションの説明（バリデーション版）

7.3 簡易書籍登録アプリケーションの説明（バリデーション版）

7.2で作成したアプリケーションをもとに、エンティティを利用したバリデーション処理が実際どのような流れで動作しているのかを説明していきます。

7.3.1 Bookクラス（エンティティクラス）

1　アプリケーション作成の目的

まず初めに、エンティティクラスから確認していきましょう。

1package jp.co.f1.spring.bms.entity;
2 
3import jakarta.persistence.Entity;
4import jakarta.persistence.Table;
5import jakarta.persistence.Id;
6import jakarta.persistence.Column;
7import jakarta.validation.constraints.NotEmpty;
8 
9@Entity
10@Table(name="bookinfo")
11public class Book {
12 
13    // ISBN
14    @Id
15    @Column(length = 20)
16    @NotEmpty(message="ISBNを入力してください")
17    private String isbn;
18 
19    public String getIsbn() {
20        return isbn;
21    }
22 
23    public void setIsbn(String isbn) {
24        this.isbn = isbn;
25    }
26 
27    // タイトル
28    @Column(length = 100, nullable = true)
29    @NotEmpty(message="タイトルを入力してください")
30    private String title;
31 
32    public String getTitle() {
33        return title;
34    }
35 
36    public void setTitle(String title) {
37        this.title = title;
38    }
39 
40    // 価格
41    @Column(length = 11, nullable = true)
42    @NotEmpty(message="価格を入力してください")
43    private String price;
44 
45    public String getPrice() {
46        return price;
47    } 
48 
49    public void setPrice(String price) {
50        this.price = price;
51    }
52     
53}

ここでは全てのプロパティにバリデーション用のアノテーションを1つずつ追加しました。こうすることで、未入力を許可しないようにしています。また、アノテーションの引数内に message=”○○” という形でエラーメッセージを指定しています。もしこのルールに該当した場合はここで設定した値がメッセージとして表示されます。どちらもとても簡単ですね。

バリデーションのルールはまだ他にも多く用意されていますが、まず先に一連の流れから確認していきましょう。

7.3.2 BookControllerクラス（コントローラークラス）

元々コントローラーでもエンティティを利用していましたが、今回はバリデーション処理を行うことがポイントとなります。それでは確認していきましょう。

1package jp.co.f1.spring.bms.controller;
2 
3import org.springframework.stereotype.Controller;
4import org.springframework.web.bind.annotation.GetMapping;
5import org.springframework.web.bind.annotation.PostMapping;
6import org.springframework.web.bind.annotation.ModelAttribute;
7import org.springframework.web.servlet.ModelAndView;
8import org.springframework.beans.factory.annotation.Autowired;
9import org.springframework.validation.BindingResult;
10import org.springframework.validation.annotation.Validated;
11 
12import jp.co.f1.spring.bms.repository.BookRepository;
13import jp.co.f1.spring.bms.entity.Book;
14 
15@Controller
16public class BmsController {
17 
18    // Repositoryインターフェースを自動インスタンス化
19    @Autowired
20    private BookRepository bookinfo;
21 
22    ・・・途中、省略・・・
23 
24    /*
25     * 「/insert」へアクセスがあった場合
26     */
27    @GetMapping("/insert")
28    public ModelAndView insert(@ModelAttribute Book book, ModelAndView mav) {
29 
30        // Viewに渡す変数をModelに格納
31        mav.addObject("book", book);
32 
33        // 画面に出力するViewを指定
34        mav.setViewName("insert");
35 
36        // ModelとView情報を返す
37        return mav;
38    }
39 
40    /*
41     * 「/insert」へPOST送信された場合
42     */
43    @PostMapping(value = "/insert")
44    // POSTデータをBookインスタンスとして受け取る
45    public ModelAndView insertPost(@ModelAttribute @Validated Book book, BindingResult result, ModelAndView mav) {
46        // 入力エラーがある場合
47        if (result.hasErrors()) {
48            // エラーメッセージ
49            mav.addObject("message", "入力内容に誤りがあります");
50 
51            // 画面に出力するViewを指定
52            mav.setViewName("insert");
53 
54            // ModelとView情報を返す
55            return mav;
56        }
57 
58        // 入力されたデータをDBに保存
59        bookinfo.saveAndFlush(book);
60 
61        // リダイレクト先を指定
62        mav = new ModelAndView("redirect:/list");
63 
64        // ModelとView情報を返す
65        return mav;
66    }
67}

■@ValidatedとBindingResult
フォームが送信されると、insertPostメソッドが呼び出されます。このメソッドには、3つの引数が用意されています。これがここでのポイントとなります。

第1引数にはBookインスタンスが渡されますが、これには2つのアノテーションが付けられています。1つは、 @ModelAttribute。これは既におなじみですね。
もう1つは「@Validated」。これが、このエンティティの値をバリデーションチェックします。これを付けることで、エンティティの各値を自動的にチェックするようになるのです。

■バリデーションエラーのチェック
バリデーションチェックの結果は、その後にある「BindingResult」という引数で知ることができます。これはErrorsというインターフェースを継承するサブインターフェースで、その名の通りアノテーションを使って値をバインドした結果を得ます。
ここでいえば、@ModelAttributeでフォームの値からBookインスタンスを作成する際の結果がBindingResultで得られることになります。インスタンスを作成するとき、@Validatedによってバリデーションがチェックされていますから、このBindingResultを調べればその状況がわかるのです。

エラーが発生しているかどうかは、「hasErrors」メソッドで調べられます。これは名前の通り、エラーが起こっているかどうかを知るもので、trueならばエラー有り、falseならばエラー無し、となるのです。したがって、この結果がfalseならばそのままBookを保存すればいい、というわけです。

trueの場合は、必要な値をaddObjectして再び “/insert” に戻って再入力を行ないます。
falseの場合は保存し、”/list” にリダイレクトさせています。

7.3.3 insert.html（テンプレートファイル）

最後に、画面にデータを表示するテンプレートを見ていきましょう。

■エラーメッセージを出力する
バリデーションチェックの結果は、<input>の次にある<p>タグ部分で出力しています（<form>直前の<p>タグ部分では単純にコントローラーから渡された値を表示しているだけです。）
まず、<form>タグ自体には以下のようにbookオブジェクトが設定されています。

タグに、th:object=”${book}” という属性が用意されていますね。これは、非常に重要です。この後のエラーメッセージの表示処理は、th:objectを利用して、バリデーションチェックを行なったオブジェクトが設定されているタグ内に配置しなければいけないからです。
実際のエラー表示は、以下のように行なっています。

th:if で、${#fields.hasErrors(‘isbn’)} という変数式が設定されています。「#fields」は、エンティティの各フィールドをバリデーションチェックした結果などがまとめられたオブジェクトです。
このエラーメッセージの表示は、2つの点に注意する必要があります。1つは、「エラーが発生しているときだけ表示する」ということ。もう1つは、「このフィールド（isbn）のエラーだけを表示する」という点です。

「hasErrors」は、引数に指定したフィールドにエラーが発生しているかどうかをチェックします。th:if を使い、これがtrueのときだけタグを表示させます。

エラーメッセージの表示は、「th:errors」という属性を利用します。

NEXT>> 7.4 jakarta.validationによるアノテーション