Learning Spring Framework

21 Apr 2017

1. 日本語文字化け対策とValidationの実装

1-1. 実習テーマ

1. 日本語文字化け対策 および HTML エスケープ処理
2. Validation 実装にむけた環境設定
3. Validation 定義とエラーハンドリング

1-2.今回やること および 学習ポイント

1. 日本語文字化け対策 および HTML エスケープ処理
   • やること
     • サーブレット定義ファイル web.xml に設定を追加
   • 学習ポイント
     • サーブレット定義ファイル web.xml における設定内容を把握する
2. Validation 実装にむけた環境設定
   • やること
     • Validation に必要なライブラリを追加する
     • Spring 定義ファイルにエラーメッセージのための Bean 定義を追加
     • エラーメッセージリソースファイルの作成
   • 学習ポイント
     • Validation 実装に向けた環境構築手順を理解する
3. Validation 定義とエラーハンドリング
   • やること
     • モデルクラスに Validation 用アノテーションを付与する
     • コントロールクラスに Validation 実行とエラーハンドリング処理を実装する
     • 画面 JSP ファイルにエラーメッセージを表示させるタグを追加する
   • 学習ポイント
     • Validation 用アノテーションについて理解
     • Validation の実行とエラーハンドリングの実装方法を把握
     • エラーメッセージを画面JSPに出力する方法を習得する

2. 技術解説 - Validation

2-1. JSR-303 - Bean Validation とは

• JavaBeans オブジェクトのデータ整合性検証ロジック（Validation）を対象とする仕様
• Java仕様を策定しているJCP（Java Community Process）が、当該検証ロジックの共通化を図る事を目的に「JSR-303 Bean Validation」仕様を策定した
• 幾つかのプロダクトにより実装されているが、現時点で最も利用されている実装は「Hibernate Validator」であり、単体での利用も可能
• Sprign でも本仕様に準じたバリデーションを実装することが可能
• 本仕様により、データ整合性検証ロジックをアノテーションで実装することが可能となった
• 独自に定義する検証処理（Validator）を自分で作成する事も可能

2-2. Validation 適用箇所

• Validation はプレゼンテーション層、ビジネスロジック層に適用される

2-3. Validation 用のアノテーション

• Validation を定義するアノテーション付与例

    // @@@@
    // @@@@ Validation アノテーションは
    // @@@@ Domain クラスのインスタンス変数に付与する
    // @@@@
  
    @NotNull
    private int id = 0;
  
    @NotBlank
    @Size(min=10, max=17)
    private String isbn = "";
  
    @NotBlank
    private String name = "";
  
    @NotNull
    private int price = 0;
  

2-4. Validation を適用する

• Validation を適用する例

    RequestMapping(value = "/book/add", method = RequestMethod.POST)
                    // @@@@
                    // @@@@ Controllerメソッドの入力値データ（引数）
                    // @@@@ の前に @valid おまじないを付ける
                    // @@@@ ↓
    public String addBook(@Valid @ModelAttribute("book") Book book,
                          BindingResult result) throws Exception {
                    // @@@@ ↑
                    // @@@@ Controller メソッドの入力値データ（引数）
                    // @@@@ の直後に BindinguResult 型の引数を追加する
                    // @@@@
  
        if(result.hasErrors()){
            // @@@@ ↑
            // @@@@ BindinguResult オブジェクトをチェックすることで
            // @@@@ Validation エラーがあったかどうかが判定できる
            // @@@@ 本例ではValidationエラー時は書籍登録フォーム画面に戻す
            // @@@@
            return "book-form";
        }
  
        // Something to do ...
        // ...
    }
  

2-5. Validation エラーメッセージの表示

• Validation エラーメッセージ表示例

    <form:form action="addbook" method="POST" modelAttribute="book">
    <table>
     <tr>
      <th>書籍ID</th>
      <td><form:input path="id"/></td>
      <td><form:errors path="id" cssStyle="color:red"/></td>
          <!--
          @@@@ Spring Form Tag ライブラリを使用する場合の
          @@@@ エラーメッセージ表示方法 
          @@@@ <form:errors path=“オブジェクトのプロパティ名”>
          @@@@ -->
     </tr>
     <tr>
      <th>ISBNコード</th>
      <td><form:input path="isbn"/></td>
      <td><form:errors path="isbn" cssStyle="color:red"/></td>
      <!-- @@@@ Spring Form Tag ライブラリエラーメッセージ表示 @@@@ -->
  
     </tr>
    </table>
    </form:form>
  

3. ハンズオン実習

STEP06 ハンズオン

• ハンズオン資料「 STEP06 - 日本語文字化けとかの対策 ＋ Validation Check の実装 」に従い実習を開始してください。

  • 日本語文字化け対策 および HTML エスケープ処理の設定方法を把握しましょう
  • Validation 実装にむけた環境設定方法をマスターしましょう
  • アノテーションを使用した Validation 定義方法を覚えましょう
  • Validation エラーハンドリング と エラーメッセージの表示方法を理解しましょう

次のステップ

次のステップは「 STEP07 - 例外のハンドリング 」です。もうちょいだ！