チュートリアル(Todoアプリケーション JSP編) ******************************************************************************** .. only:: html .. contents:: 目次 :depth: 3 :local: | はじめに ================================================================================ このチュートリアルで学ぶこと -------------------------------------------------------------------------------- * TERASOLUNA Server Framework for Java (5.x)による基本的なアプリケーションの開発方法 * MavenおよびSTS(Eclipse)プロジェクトの構築方法 * TERASOLUNA Server Framework for Java (5.x)の\ :doc:`../Overview/ApplicationLayering`\ に従った開発方法 | 対象読者 -------------------------------------------------------------------------------- * SpringのDIやAOPに関する基礎的な知識がある * Servlet/JSPを使用してWebアプリケーションを開発したことがある * SQLに関する知識がある | 検証環境 -------------------------------------------------------------------------------- このチュートリアルは以下の環境で動作確認している。他の環境で実施する際は本書をベースに適宜読み替えて設定していくこと。 .. tabularcolumns:: |p{0.30\linewidth}|p{0.70\linewidth}| .. list-table:: :header-rows: 1 :widths: 30 70 * - 種別 - 名前 * - OS - Windows 10 * - JVM - \ `Java `_\ 17 * - IDE - \ `Spring Tool Suite `_\ 4.17.1.RELEASE (以降「STS」と呼ぶ。設定方法は\ :doc:`../Appendix/SpringToolSuite4`\ を参照されたい。) * - Build Tool - \ `Apache Maven `_\ 3.8.6 (以降「Maven」と呼ぶ) * - Application Server - \ `Apache Tomcat `_\ 10.1.15 * - Web Browser - \ `Google Chrome `_\ 117 | 作成するアプリケーションの説明 ================================================================================ アプリケーションの概要 -------------------------------------------------------------------------------- TODOを管理するアプリケーションを作成する。TODOの一覧表示、TODOの登録、TODOの完了、TODOの削除を行える。 .. figure:: ./images_TutorialTodo/image001.png :width: 50% | .. _app-requirement: アプリケーションの業務要件 -------------------------------------------------------------------------------- アプリケーションの業務要件は、以下の通りとする。 .. tabularcolumns:: |p{0.20\linewidth}|p{0.80\linewidth}| .. list-table:: :header-rows: 1 :widths: 20 80 * - ルールID - 説明 * - B01 - 未完了のTODOは5件までしか登録できない * - B02 - 完了済みのTODOは完了できない .. note:: 本要件は学習のためのもので、現実的なTODO管理アプリケーションとしては適切ではない。 | アプリケーションの処理仕様 -------------------------------------------------------------------------------- アプリケーションの処理仕様と画面遷移は、以下の通りとする。 .. figure:: ./images_TutorialTodo/image002.png :width: 60% .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.10\linewidth}|p{0.15\linewidth}|p{0.45\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 10 15 45 * - 項番 - プロセス名 - HTTPメソッド - URL - 備考 * - 1 - Show all TODO - \- - /todo/list - * - 2 - Create TODO - POST - /todo/create - 作成処理終了後、Show all TODOへリダイレクト * - 3 - Finish TODO - POST - /todo/finish - 完了処理終了後、Show all TODOへリダイレクト * - 4 - Delete TODO - POST - /todo/delete - 削除処理終了後、Show all TODOへリダイレクト | Show all TODO ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * TODOを全件表示する * 未完了のTODOに対しては「Finish」と「Delete」用のボタンが付く * 完了のTODOは打ち消し線で装飾する * TODOの件名のみ表示する | Create TODO ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * フォームから送信されたTODOを保存する * TODOの件名は1文字以上30文字以下であること * \ :ref:`app-requirement`\ のB01を満たさない場合はエラーコードE001でビジネス例外をスローする * 処理が成功した場合は、遷移先の画面で「Created successfully!」を表示する | Finish TODO ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * フォームから送信された\ ``todoId``\ に対応するTODOを完了済みにする * 該当するTODOが存在しない場合はエラーコードE404でリソース未検出例外をスローする * \ :ref:`app-requirement`\ のB02を満たさない場合はエラーコードE002でビジネス例外をスローする * 処理が成功した場合は、遷移先の画面で「Finished successfully!」を表示する | Delete TODO ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * フォームから送信された\ ``todoId``\ に対応するTODOを削除する * 該当するTODOが存在しない場合はエラーコードE404でリソース未検出例外をスローする * 処理が成功した場合は、遷移先の画面で「Deleted successfully!」を表示する | エラーメッセージ一覧 -------------------------------------------------------------------------------- エラーメッセージとして、以下の3つを定義する。 .. tabularcolumns:: |p{0.15\linewidth}|p{0.50\linewidth}|p{0.35\linewidth}| .. list-table:: :header-rows: 1 :widths: 15 50 35 * - エラーコード - メッセージ - 置換パラメータ * - E001 - [E001] The count of un-finished Todo must not be over {0}. - {0}… max unfinished count * - E002 - [E002] The requested Todo is already finished. (id={0}) - {0}… todoId * - E404 - [E404] The requested Todo is not found. (id={0}) - {0}… todoId | 環境構築 ================================================================================ 本チュートリアルでは、インフラストラクチャ層のRepositoryImplの実装として、 * データベースを使用せず\ ``java.util.Map``\ を使ったインメモリ実装のRepositoryImpl * MyBatis3を使用してデータベースにアクセスするRepositoryImpl * Spring Data JPAを使用してデータベースにアクセスするRepositoryImpl の3種類を用意している。用途に応じていずれかを選択する。 チュートリアルの進行上、まずはインメモリ実装を試し、その後MyBatis3またはSpring Data JPAを選ぶのが円滑である。 | プロジェクトの作成 -------------------------------------------------------------------------------- まず、\ ``mvn archetype:generate``\ を利用して、実装するインフラストラクチャ層向けのブランクプロジェクトを作成する。 ここでは、Windowsのコマンドプロンプトを使用してブランクプロジェクトを作成する手順となっている。 .. note:: インターネット接続するために、プロキシサーバーを介する必要がある場合、以下の作業を行うため、STSのProxy設定と、\ `MavenのProxy設定 `_\ が必要である。 .. tip:: Bash上で\ ``mvn archetype:generate``\ を実行する場合は、以下のように"\ ``^``\ "を"\ ``\``\ "に置き換えて実行すればよい。 .. code-block:: bash mvn archetype:generate -B\ -DarchetypeGroupId=org.terasoluna.gfw.blank\ -DarchetypeArtifactId=terasoluna-gfw-web-blank-jsp-archetype\ -DarchetypeVersion=5.9.0.RELEASE\ -DgroupId=com.example.todo\ -DartifactId=todo\ -Dversion=1.0.0-SNAPSHOT | .. _TutorialCreatePlainBlankProject: O/R Mapperに依存しないブランクプロジェクトの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ データベースを使用せず\ ``java.util.Map``\ を使ったインメモリ実装のRepositoryImpl用のプロジェクトを作成する場合は、以下のコマンドを実行してO/R Mapperに依存しないブランクプロジェクトを作成する。\ **本チュートリアルを順序通り読み進める場合は、まずはこの方法でプロジェクトを作成すること**\ 。 .. tabs:: .. group-tab:: Java Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-jsp-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT .. group-tab:: XML Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-xmlconfig-jsp-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT .. _TutorialCreateMyBatis3BlankProject: MyBatis3用のブランクプロジェクトの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ MyBatis3を使用してデータベースにアクセスするRepositoryImpl用のプロジェクトを作成する場合は、以下のコマンドを実行してMyBatis3用のブランクプロジェクトを作成する。このプロジェクト作成方法は\ :ref:`using_MyBatis3`\ で使用する。 .. tabs:: .. group-tab:: Java Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-jsp-mybatis3-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT .. group-tab:: XML Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-xmlconfig-jsp-mybatis3-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT | .. _TutorialCreateJPABlankProject: JPA用のブランクプロジェクトの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Spring Data JPAを使用してデータベースへアクセスするRepositoryImpl用のプロジェクトを作成する場合は、以下のコマンドを実行してJPA用のブランクプロジェクトを作成する。このプロジェクト作成方法は\ :ref:`using_SpringDataJPA`\ で使用する。 .. tabs:: .. group-tab:: Java Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-jsp-jpa-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT .. group-tab:: XML Config .. code-block:: console mvn archetype:generate -B^ -DarchetypeGroupId=org.terasoluna.gfw.blank^ -DarchetypeArtifactId=terasoluna-gfw-web-blank-xmlconfig-jsp-jpa-archetype^ -DarchetypeVersion=5.9.0.RELEASE^ -DgroupId=com.example.todo^ -DartifactId=todo^ -Dversion=1.0.0-SNAPSHOT | プロジェクトのインポート -------------------------------------------------------------------------------- 作成したブランクプロジェクトをSTSへインポートする。 STSのメニューから、[File] -> [Import] -> [Maven] -> [Existing Maven Projects] -> [Next]を選択し、archetypeで作成したプロジェクトを選択する。 .. figure:: ./images_TutorialTodo/NewMVCProjectImport.png :alt: New MVC Project Import :width: 60% | Root Directoryに\ ``C:\work\todo``\ を設定し、Projectsにtodoのpom.xmlが選択された状態で、[Finish]を押下する。 .. figure:: ./images_TutorialTodo/NewMVCProjectCreate.png :alt: New MVC Project Import :width: 60% | インポートが完了すると、Package Explorerに次のようなプロジェクトが表示される。 .. tabs:: .. group-tab:: Java Config .. figure:: ./images_TutorialTodo/image004_JavaConfig.png :alt: workspace .. group-tab:: XML Config .. figure:: ./images_TutorialTodo/image004_XMLConfig.png :alt: workspace .. note:: インポート後にビルドエラーが発生する場合は、プロジェクト名を右クリックし、「Maven」->「Update Project...」をクリックし、「OK」ボタンをクリックすることでエラーが解消されるケースがある。 .. figure:: ./images_TutorialTodo/update-project.png :width: 70% .. note:: ビルド時にJSPファイルで以下のエラーが発生する場合がある。 .. code-block:: console The superclass "javax.servlet.http.HttpServlet", determined from the Dynamic Web Module facet version (2.5), was not found on the Java Build Path この状態は、Dynamic Web Moduleのバージョンをあげることで解消できる。 プロジェクト名を右クリックし、「Properties」を選択 ->「Project Facets」の「Dynamic Web Module」を5.0へ変更することで解決する。 .. figure:: ./images_TutorialTodo/change-DynamicWebModule.png :width: 70% .. tip:: パッケージの表示形式は、デフォルトは「Flat」だが、「Hierarchical」にしたほうが見通しがよい。 Package Explorerの「View Menu」 (右端の下矢印)をクリックし、「Package Presentation」->「Hierarchical」を選択する。 .. figure:: ./images_TutorialTodo/presentation-hierarchical.png :width: 80% Package PresentationをHierarchicalにすると、以下の様な表示になる。 .. figure:: ./images_TutorialTodo/presentation-hierarchical-view.png .. warning:: O/R Mapperを使用するブランクプロジェクトの場合、H2 Databaseがdependencyとして定義されているが、この設定は簡易的なアプリケーションを簡単に作成するためのものであり、実際のアプリケーション開発で使用されることは想定していない。 以下の定義は、実際のアプリケーション開発を行う際は削除すること。 .. code-block:: xml com.h2database h2 runtime .. note:: 上記設定例は、依存ライブラリのバージョンを親プロジェクトである terasoluna-gfw-parent で管理する前提であるため、pom.xmlでのバージョンの指定は不要である。 上記の依存ライブラリはterasoluna-gfw-parentが依存している\ `Spring Boot `_\ で管理されている。 | プロジェクトの構成 -------------------------------------------------------------------------------- 本チュートリアルで作成するプロジェクトの構成を以下に示す。 .. note:: \ :ref:`前節の「プロジェクト構成」 `\ ではマルチプロジェクトにすることを推奨していたが、本チュートリアルでは、学習容易性を重視しているためシングルプロジェクト構成にしている。 \ **ただし、実プロジェクトで適用する場合は、マルチプロジェクト構成を強く推奨する。**\ マルチプロジェクトの作成方法は、「\ :doc:`../ImplementationAtEachLayer/CreateWebApplicationProject`\ 」を参照されたい。 | \ **[O/R Mapperに依存しないブランクプロジェクト、JPA用のブランクプロジェクト用を作成した場合の構成]**\ .. tabs:: .. group-tab:: Java Config .. code-block:: console src └main ├java │ └com │ └example │ └todo │ ├ app ... (1) │ │ ├todo │ │ └welcome │ ├domain ... (2) │ │ ├model ... (3) │ │ ├repository ... (4) │ │ │ └todo │ │ └service ... (5) │ │ └todo │ └ config ... (6) │ ├app │ └web ├resources │ └META-INF │ └spring ... (6) └webapp ├resources │ └app │ └css ... (7) └WEB-INF └views ... (8) .. group-tab:: XML Config .. code-block:: console src └main ├java │ └com │ └example │ └todo │ ├ app ... (1) │ │ ├todo │ │ └welcome │ └domain ... (2) │ ├model ... (3) │ ├repository ... (4) │ │ └todo │ └service ... (5) │ └todo ├resources │ └META-INF │ └spring ... (6) └webapp ├resources │ └app │ └css ... (7) └WEB-INF └views ... (8) .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - アプリケーション層のクラスを格納するパッケージ。 本チュートリアルでは、Todo管理業務用のクラスを格納するためのパッケージを作成する。 * - | (2) - ドメイン層のクラスを格納するパッケージ。 * - | (3) - Domain Objectを格納するパッケージ。 * - | (4) - Repositoryを格納するパッケージ。 本チュートリアルでは、Todoオブジェクト(Domain Object)用のRepositoryを格納するためのパッケージを作成する * - | (5) - Serviceを格納するパッケージ。 本チュートリアルでは、Todo管理業務用のServiceを格納するためのパッケージを作成する。 * - | (6) - Spring関連の設定ファイルを格納するディレクトリ。 * - | (7) - cssファイルを格納するディレクトリ。 * - | (8) - jspを格納するディレクトリ。 | \ **[MyBatis3用のブランクプロジェクトを作成した場合の構成]**\ .. tabs:: .. group-tab:: Java Config .. code-block:: console src └main ├java │ └com │ └example │ └todo │ ├ app │ │ ├todo │ │ └welcome │ ├domain │ │ ├model │ │ ├repository │ │ │ └todo │ │ └service │ │ └todo │ └ config │ ├app │ │ └mybatis ... (9) │ └web ├resources │ ├META-INF │ │ └spring │ └com │ └example │ └todo │ └domain │ └repository ... (10) │ └todo └webapp ├resources │ └app │ └css └WEB-INF └views .. group-tab:: XML Config .. code-block:: console src └main ├java │ └com │ └example │ └todo │ ├ app │ │ ├todo │ │ └welcome │ └domain │ ├model │ ├repository │ │ └todo │ └service │ └todo ├resources │ ├META-INF │ │ ├mybatis ... (9) │ │ └spring │ └com │ └example │ └todo │ └domain │ └repository ... (10) │ └todo └webapp ├resources │ └app │ └css └WEB-INF └views .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (9) - MyBatis関連の設定ファイルを格納するディレクトリ。 * - | (10) - SQLを記述するMyBatisのMapperファイルを格納するディレクトリ。 本チュートリアルでは、Todoオブジェクト用のRepositoryのMapperファイルを格納するためのディレクトリを作成する。 | 設定ファイルの確認 -------------------------------------------------------------------------------- チュートリアルを進める上で必要となる設定の多くは、作成したブランクプロジェクトに既に設定済みの状態である。 チュートリアルを実施するだけであれば、これらの設定の理解は必須ではないが、アプリケーションを動かすためにどのような設定が必要なのかを理解しておくことを推奨する。 アプリケーションを動かすために必要な設定(設定ファイル)の解説については、「\ :ref:`TutorialTodoAppendixExpoundConfigurations`\ 」を参照されたい。 .. note:: まず、手を動かしてTodoアプリケーションを作成したい場合は、設定ファイルの確認は読み飛ばしてもよいが、Todoアプリケーションを作成した後に一読して頂きたい。 | プロジェクトの動作確認 -------------------------------------------------------------------------------- Todoアプリケーションの開発を始める前に、プロジェクトの動作確認を行う。 ブランクプロジェクトでは、トップページを表示するためのControllerとJSPの実装が用意されているため、トップページを表示する事で動作確認を行う事ができる。 ブランクプロジェクトから提供されているController(\ :file:`src/main/java/com/example/todo/app/welcome/HelloController.java`\ )は、以下のような実装となっている。 .. code-block:: java package com.example.todo.app.welcome; import java.text.DateFormat; import java.util.Date; import java.util.Locale; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; /** * Handles requests for the application home page. */ // (1) @Controller public class HelloController { // (2) private static final Logger logger = LoggerFactory .getLogger(HelloController.class); /** * Simply selects the home view to render by returning its name. */ // (3) @GetMapping(value = "/") public String home(Locale locale, Model model) { // (4) logger.info("Welcome home! The client locale is {}.", locale); Date date = new Date(); DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale); String formattedDate = dateFormat.format(date); // (5) model.addAttribute("serverTime", formattedDate); // (6) return "welcome/home"; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | Controllerとしてcomponent-scanの対象とするため、クラスレベルに\ ``@Controller``\ アノテーションが付与している。 * - | (2) - | (4)でログ出力するためのロガーを生成している。 | ロガーの実装はlogbackのものであるが、APIはSLF4Jの\ ``org.slf4j.Logger``\ を使用している。 * - | (3) - | \ ``@GetMapping``\ アノテーションを使用して、"\ ``/``\ "(ルート)へのアクセスに対するメソッドとしてマッピングを行っている。 * - | (4) - | メソッドが呼ばれたことを通知するためのログをinfoレベルで出力している。 * - | (5) - | 画面に表示するための日付文字列を、\ ``serverTime``\ という属性名でModelに設定している。 * - | (6) - | view名として\ ``welcome/home``\ を返す。\ ``ViewResolver``\ の設定により、\ ``WEB-INF/views/welcome/home.jsp``\ が呼び出される。 | ブランクプロジェクトから提供されているJSP(\ :file:`src/main/webapp/WEB-INF/views/welcome/home.jsp`\ )は、以下のような実装となっている。 .. code-block:: jsp Home

Hello world!

The time on the server is ${serverTime}.

.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (7) - | ControllerでModelに設定した\ ``serverTime``\ を表示する。 | ここでは、XSS対策を行っていないが、ユーザの入力値を表示する場合は、\ ``f:h()``\ 関数を用いて、必ずXSS対策を行うこと。 | プロジェクトを右クリックして「Run As」->「Run on Server」を選択する。 .. figure:: ./images_TutorialTodo/image031.jpg :width: 70% | APサーバー(Tomcat v10.1 Server at localhost)を選択し、「Next」をクリックする。 .. figure:: ./images_TutorialTodo/image032.jpg :width: 70% | todoが「Configured」に含まれていることを確認して「Finish」をクリックしてサーバーを起動する。 .. figure:: ./images_TutorialTodo/image033.jpg :width: 70% | 起動すると以下のようなログが出力される。 "\ ``/``\ "というパスに対して\ ``com.example.todo.app.welcome.HelloController``\ のhomeメソッドがマッピングされていることが分かる。 .. code-block:: console date:2022-11-25 17:22:36 thread:main X-Track: level:INFO logger:o.springframework.web.servlet.DispatcherServlet message:Initializing Servlet 'appServlet' date:2022-11-25 17:22:37 thread:main X-Track: level:TRACE logger:o.s.w.s.m.m.a.RequestMappingHandlerMapping message: c.e.t.a.w.HelloController: {GET [/]}: home(Locale,Model) date:2022-11-25 17:22:37 thread:main X-Track: level:DEBUG logger:o.s.w.s.m.m.a.RequestMappingHandlerMapping message:1 mappings in 'requestMappingHandlerMapping' date:2022-11-25 17:22:37 thread:main X-Track: level:INFO logger:o.springframework.web.servlet.DispatcherServlet message:Completed initialization in 753 ms | ブラウザで\ ``http://localhost:8080/todo``\ にアクセスすると、以下のように表示される。 .. figure:: ./images_TutorialTodo/image034.png :width: 60% コンソールを見ると、 * 共通ライブラリから提供している\ ``TraceLoggingInterceptor``\ のTRACEログ * Controllerで実装したINFOログ が出力されていることがわかる。 .. code-block:: console date:2022-11-25 17:24:47 thread:http-nio-8080-exec-4 X-Track:90843a0f267a4a85b70232ed9884d969 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[START CONTROLLER] HelloController.home(Locale,Model) date:2022-11-25 17:24:47 thread:http-nio-8080-exec-4 X-Track:90843a0f267a4a85b70232ed9884d969 level:INFO logger:com.example.todo.app.welcome.HelloController message:Welcome home! The client locale is ja. date:2022-11-25 17:24:47 thread:http-nio-8080-exec-4 X-Track:90843a0f267a4a85b70232ed9884d969 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[END CONTROLLER ] HelloController.home(Locale,Model)-> view=welcome/home, model={serverTime=2022年11月25日 17:24:47 JST} date:2022-11-25 17:24:47 thread:http-nio-8080-exec-4 X-Track:90843a0f267a4a85b70232ed9884d969 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[HANDLING TIME ] HelloController.home(Locale,Model)-> 51,864,000 ns .. note:: \ ``TraceLoggingInterceptor``\ はControllerの開始、終了でログを出力する。終了時には\ ``View``\ と\ ``Model``\ の情報および処理時間が出力される。 | Todoアプリケーションの作成 ================================================================================ | Todoアプリケーションを作成する。作成する順は、以下の通りである。 * ドメイン層(+ インフラストラクチャ層) * Domain Object作成 * Repository作成 * RepositoryImpl作成 * Service作成 * アプリケーション層 * Controller作成 * Form作成 * View作成 | RepositoryImplの作成は、選択したインフラストラクチャ層の種類に応じて実装方法が異なる。 | ここでは、データベースを使用せず\ ``java.util.Map``\ を使ったインメモリ実装のRepositoryImplを作成する方法について説明を行う。 | データベースを使用する場合は、「\ :ref:`tutorial-todo_infra`\ 」に記載されている内容で読み替えて、Todoアプリケーションを作成して頂きたい。 | ドメイン層の作成 -------------------------------------------------------------------------------- Domain Objectの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Domainオブジェクトを作成する。 Package Explorer上で右クリック -> New -> Class を選択し、「New Java Class」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.model``\ * - 2 - Name - \ ``Todo``\ * - 3 - Interfaces - \ ``java.io.Serializable``\ を入力して「Finish」する。 .. figure:: ./images_TutorialTodo/image057.png :width: 70% 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image058.png | 作成したクラスに以下のプロパティを追加する。 * ID → todoId * タイトル → todoTitle * 完了フラグ → finished * 作成日 → createdAt .. code-block:: java package com.example.todo.domain.model; import java.io.Serializable; import java.util.Date; public class Todo implements Serializable { private static final long serialVersionUID = 1L; private String todoId; private String todoTitle; private boolean finished; private Date createdAt; public String getTodoId() { return todoId; } public void setTodoId(String todoId) { this.todoId = todoId; } public String getTodoTitle() { return todoTitle; } public void setTodoTitle(String todoTitle) { this.todoTitle = todoTitle; } public boolean isFinished() { return finished; } public void setFinished(boolean finished) { this.finished = finished; } public Date getCreatedAt() { return createdAt; } public void setCreatedAt(Date createdAt) { this.createdAt = createdAt; } } .. tip:: Getter/SetterメソッドはSTSの機能を使って自動生成することができる。 フィールドを定義した後、エディタ上で右クリックし、「Source」->「Generate Getters and Setters…」を選択する。 .. figure:: ./images_TutorialTodo/image059.png :width: 90% serialVersionUID以外を選択して「Generate」 .. figure:: ./images_TutorialTodo/image060.png :width: 60% | .. _TutorialTodoCreateRepository: Repositoryの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | \ ``TodoRepository``\ インタフェースを作成する。 | データベースを使用する場合は、「\ :ref:`tutorial-todo_infra`\ 」に記載されている内容で読み替えて、Repositoryを作成する。 Package Explorer上で右クリック -> New -> Interface を選択し、「New Java Interface」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.repository.todo``\ * - 2 - Name - \ ``TodoRepository``\ を入力して「Finish」する。 作成したインタフェースは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image061.png 作成したインタフェースに、今回のアプリケーションで必要となる以下のCRUD操作を行うメソッドを定義する。 * TODOの1件取得 → findById * TODOの全件取得 → findAll * TODOの1件作成 → create * TODOの1件更新 → update * TODOの1件削除 → delete * 完了済みTODO件数の取得 → countByFinished .. code-block:: java package com.example.todo.domain.repository.todo; import java.util.Collection; import java.util.Optional; import com.example.todo.domain.model.Todo; public interface TodoRepository { Optional findById(String todoId); Collection findAll(); void create(Todo todo); boolean update(Todo todo); void delete(Todo todo); long countByFinished(boolean finished); } .. note:: \ ``java.util.Optional``\ 型はJava 8から導入された\ ``null``\ を安全に扱うための仕組みであり、コーディングミスによる\ ``NullPointerException``\ 等の防止に寄与する。 Repositoryの1件取得（\ ``findById``\ ）の戻り値を\ ``Optional``\ 型にすべきか否かは、以下のようにO/R Mapperにより異なるため、採用するO/R Mapperの仕様を確認されたい。 * O/R Mapperに依存しない場合とMyBatis3を利用する場合は、\ **Optional型にしても良い。**\ * Spring Data JPAを利用する場合は、Repositoryのメソッドシグネチャが決まっており\ **必ずOptional型となる。**\ 本チュートリアルではO/R Mapperによらず戻り値に\ ``Optional``\ 型に統一しているが、これはRepositoryを上記3種類のO/R Mapperで実装し、それらを呼び出すServiceの実装を統一するためである。 .. note:: ここでは、\ ``TodoRepository``\ の汎用性を上げるため、「完了済み件数を取得する」メソッド(\ ``long countFinished()``\ )ではなく、「完了状態がxxである件数を取得する」メソッド(\ ``long countByFinished(boolean)``\ )として定義している。 \ ``long countByFinished(boolean)``\ の引数として\ ``true``\ を渡すと「完了済みの件数」、\ ``false``\ を渡すと「未完了の件数」が取得できる仕様としている。 | RepositoryImplの作成(インフラストラクチャ層) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ここでは、説明を単純化するため、\ ``java.util.Map``\ を使ったインメモリ実装のRepositoryImplを作成する。 | データベースを使用する場合は、「\ :ref:`tutorial-todo_infra`\ 」に記載されている内容で読み替えて、RepositoryImplを作成する。 Package Explorer上で右クリック -> New -> Class を選択し、「New Java Class」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.repository.todo``\ * - 2 - Name - \ ``TodoRepositoryImpl``\ * - 3 - Interfaces - \ ``com.example.todo.domain.repository.todo.TodoRepository``\ を入力して「Finish」する。 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image062.png 作成したクラスにCRUD操作を実装する。 .. note:: RepositoryImplには、業務ロジックは含めず、Domainオブジェクトの保存先への出し入れ(CRUD操作)に終始することが実装ポイントである。 .. code-block:: java package com.example.todo.domain.repository.todo; import java.util.Collection; import java.util.Map; import java.util.Optional; import java.util.concurrent.ConcurrentHashMap; import org.springframework.stereotype.Repository; import com.example.todo.domain.model.Todo; @Repository // (1) public class TodoRepositoryImpl implements TodoRepository { private static final Map TODO_MAP = new ConcurrentHashMap(); @Override public Optional findById(String todoId) { return Optional.ofNullable(TODO_MAP.get(todoId)); } @Override public Collection findAll() { return TODO_MAP.values(); } @Override public void create(Todo todo) { TODO_MAP.put(todo.getTodoId(), todo); } @Override public boolean update(Todo todo) { TODO_MAP.put(todo.getTodoId(), todo); return true; } @Override public void delete(Todo todo) { TODO_MAP.remove(todo.getTodoId()); } @Override public long countByFinished(boolean finished) { long count = 0; for (Todo todo : TODO_MAP.values()) { if (finished == todo.isFinished()) { count++; } } return count; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.80\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 80 * - 項番 - 説明 * - | (1) - | Repositoryとしてcomponent-scan対象とするため、クラスレベルに\ ``@Repository``\ アノテーションをつける。 .. note:: 本チュートリアルでは、インフラストラクチャ層に属するクラス(RepositoryImpl)をドメイン層のパッケージ(\ ``com.example.todo.domain``\ )に格納しているが、完全に層別にパッケージを分けるのであれば、インフラストラクチャ層のクラスは、\ ``com.example.todo.infra``\ 以下に作成した方が良い。 ただし、通常のプロジェクトでは、インフラストラクチャ層が変更されることを前提としていない(そのような前提で進めるプロジェクトは、少ない)。 そこで、作業効率向上のために、ドメイン層のRepositoryインタフェースと同じ階層に、RepositoryImplを作成しても良い。 | Serviceの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ まず、\ ``TodoService``\ インタフェースを作成する。 Package Explorer上で右クリック -> New -> Interface を選択し、「New Java Interface」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.service.todo``\ * - 2 - Name - \ ``TodoService``\ を入力して「Finish」する。 作成したインタフェースは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image063.png 作成したインタフェースに以下の業務処理を行うメソッドを定義する。 * Todoの全件取得 → findAll * Todoの新規作成 → create * Todoの完了 → finish * Todoの削除 → delete .. code-block:: java package com.example.todo.domain.service.todo; import java.util.Collection; import com.example.todo.domain.model.Todo; public interface TodoService { Collection findAll(); Todo create(Todo todo); Todo finish(String todoId); void delete(String todoId); } | 次に、\ ``TodoService``\ インタフェースに定義したメソッドを実装する\ ``TodoServiceImpl``\ クラスを作成する。 Package Explorer上で右クリック -> New -> Class を選択し、「New Java Class」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.service.todo``\ * - 2 - Name - \ ``TodoServiceImpl``\ * - 3 - Interfaces - \ ``com.example.todo.domain.service.todo.TodoService``\ を入力して「Finish」する。 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image064.png .. code-block:: java package com.example.todo.domain.service.todo; import java.util.Collection; import java.util.Date; import java.util.UUID; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; import org.terasoluna.gfw.common.exception.BusinessException; import org.terasoluna.gfw.common.exception.ResourceNotFoundException; import org.terasoluna.gfw.common.message.ResultMessage; import org.terasoluna.gfw.common.message.ResultMessages; import com.example.todo.domain.model.Todo; import com.example.todo.domain.repository.todo.TodoRepository; import jakarta.inject.Inject; @Service// (1) @Transactional // (2) public class TodoServiceImpl implements TodoService { private static final long MAX_UNFINISHED_COUNT = 5; @Inject// (3) TodoRepository todoRepository; @Override @Transactional(readOnly = true) // (4) public Collection findAll() { return todoRepository.findAll(); } @Override public Todo create(Todo todo) { long unfinishedCount = todoRepository.countByFinished(false); if (unfinishedCount >= MAX_UNFINISHED_COUNT) { // (5) ResultMessages messages = ResultMessages.error(); messages.add(ResultMessage.fromText( "[E001] The count of un-finished Todo must not be over " + MAX_UNFINISHED_COUNT + ".")); // (6) throw new BusinessException(messages); } // (7) String todoId = UUID.randomUUID().toString(); Date createdAt = new Date(); todo.setTodoId(todoId); todo.setCreatedAt(createdAt); todo.setFinished(false); todoRepository.create(todo); /* REMOVE THIS LINE IF YOU USE JPA todoRepository.save(todo); // (8) REMOVE THIS LINE IF YOU USE JPA */ return todo; } @Override public Todo finish(String todoId) { Todo todo = findOne(todoId); if (todo.isFinished()) { ResultMessages messages = ResultMessages.error(); messages.add(ResultMessage.fromText( "[E002] The requested Todo is already finished. (id=" + todoId + ")")); throw new BusinessException(messages); } todo.setFinished(true); todoRepository.update(todo); /* REMOVE THIS LINE IF YOU USE JPA todoRepository.save(todo); // (9) REMOVE THIS LINE IF YOU USE JPA */ return todo; } @Override public void delete(String todoId) { Todo todo = findOne(todoId); todoRepository.delete(todo); } // (10) private Todo findOne(String todoId) { return todoRepository.findById(todoId).orElseThrow(() -> { // (11) ResultMessages messages = ResultMessages.error(); messages.add(ResultMessage.fromText( "[E404] The requested Todo is not found. (id=" + todoId + ")")); return new ResourceNotFoundException(messages); }); } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | Serviceとしてcomponent-scanの対象とするため、クラスレベルに\ ``@Service``\ アノテーションをつける。 * - | (2) - | クラスレベルに、\ ``@Transactional``\ アノテーションをつけることで、公開メソッドをすべてトランザクション管理する。 | アノテーションを付与することで、メソッド開始時にトランザクションを開始、メソッド正常終了時にトランザクションのコミットが行われる。 | また、途中で非検査例外が発生した場合は、トランザクションがロールバックされる。 | | データベースを使用しない場合は、\ ``@Transactional``\ アノテーションは不要である。 * - | (3) - | \ ``@Inject``\ アノテーションで、\ ``TodoRepository``\ の実装をインジェクションする。 * - | (4) - | 参照のみ行う処理に関しては、\ ``readOnly=true``\ をつける。 | O/R Mapperによっては、この設定により、参照時のトランザクション制御の最適化が行われる(JPAを使用する場合、効果はない)。 | | データベースを使用しない場合は、\ ``@Transactional``\ アノテーションは不要である。 * - | (5) - | 結果メッセージを格納するクラスとして、共通ライブラリで用意されている\ ``org.terasoluna.gfw.common.message.ResultMessage``\ を用いる。 | 今回は、エラーメッセージを例外に追加する際に、\ ``ResultMessages.error()``\ でメッセージ種別を指定して、\ ``ResultMessage``\ を追加している。 * - | (6) - | 業務エラーが発生した場合、共通ライブラリで用意されている\ ``org.terasoluna.gfw.common.exception.BusinessException``\ をスローする。 * - | (7) - | 一意性のある値を生成するために、UUIDを使用している。データベースのシーケンスを用いてもよい。 * - | (8) - | Spring Data JPAを使用してデータベースにアクセスする場合は、\ ``create``\ メソッドではなく、\ ``save``\ メソッドを呼び出す。 * - | (9) - | Spring Data JPAを使用してデータベースにアクセスする場合は、\ ``update``\ メソッドではなく、\ ``save``\ メソッドを呼び出す。 * - | (10) - | 1件取得は、\ ``finish``\ メソッドでも\ ``delete``\ メソッドでも使用するため、メソッドとして用意しておく(interfaceに公開しても良い)。 * - | (11) - | 取得したデータを返す。対象のデータが存在しない場合は共通ライブラリで用意されている\ ``org.terasoluna.gfw.common.exception.ResourceNotFoundException``\ をスローする。 .. note:: 本節では、説明を単純化するため、エラーメッセージをハードコードしているが、メンテナンスの観点で本来は好ましくない。通常、メッセージは、プロパティファイルに外部化することが推奨される。 プロパティファイルに外部化する方法は、\ :doc:`../ArchitectureInDetail/GeneralFuncDetail/PropertyManagement`\ を参照されたい。 | アプリケーション層の作成 -------------------------------------------------------------------------------- ドメイン層の実装が完了したので、次はドメイン層を利用して、アプリケーション層の作成に取り掛かる。 | Controllerの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ まずは、Todo管理業務にかかわる画面遷移を、制御するControllerを作成する。 Package Explorer上で右クリック -> New -> Class を選択し、「New Java Class」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.app.todo``\ * - 2 - Name - \ ``TodoController``\ を入力して「Finish」する。 .. note:: \ **上位パッケージがドメイン層と異なるので注意すること。**\ 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image065.png .. code-block:: java package com.example.todo.app.todo; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller // (1) @RequestMapping("todo") // (2) public class TodoController { } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | Controllerとしてcomponent-scanの対象とするため、クラスレベルに、\ ``@Controller``\ アノテーションをつける。 * - | (2) - | \ ``TodoController``\ が扱う画面遷移のパスを、すべて\ ``/todo``\ 配下にするため、クラスレベルに\ ``@RequestMapping(“todo”)``\ を設定する。 | Show all TODOの実装 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 本チュートリアルで作成する画面では、 * 新規作成フォームの表示 * TODOの全件表示 を行う。 はじめに、TODOの全件表示を行うための処理を実装する。 | Formの作成 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Formクラス(JavaBean)を作成する。 Package Explorer上で右クリック -> New -> Class を選択し、「New Java Class」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.app.todo``\ * - 2 - Name - \ ``TodoForm``\ * - 3 - Interfaces - \ ``java.io.Serializable``\ を入力して「Finish」する。 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/image066.png 作成したクラスに以下のプロパティを追加する。 * タイトル → todoTitle .. code-block:: java package com.example.todo.app.todo; import java.io.Serializable; public class TodoForm implements Serializable { private static final long serialVersionUID = 1L; private String todoTitle; public String getTodoTitle() { return todoTitle; } public void setTodoTitle(String todoTitle) { this.todoTitle = todoTitle; } } | Controllerの実装 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 一覧画面表示処理を\ ``TodoController``\ に追加する。 .. code-block:: java package com.example.todo.app.todo; import java.util.Collection; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import com.example.todo.domain.model.Todo; import com.example.todo.domain.service.todo.TodoService; import jakarta.inject.Inject; @Controller @RequestMapping("todo") public class TodoController { @Inject // (1) TodoService todoService; @ModelAttribute // (2) public TodoForm setUpForm() { TodoForm form = new TodoForm(); return form; } @GetMapping("list") // (3) public String list(Model model) { Collection todos = todoService.findAll(); model.addAttribute("todos", todos); // (4) return "todo/list"; // (5) } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | \ ``TodoService``\ を、DIコンテナによってインジェクションさせるために、\ ``@Inject``\ アノテーションをつける。 | | DIコンテナの管理する\ ``TodoService``\ 型のインスタンス(\ ``TodoServiceImpl``\ のインスタンス)がインジェクションされる。 * - | (2) - | Formを初期化する。 | | \ ``@ModelAttribute``\ アノテーションをつけることで、このメソッドの返り値のformオブジェクトが、\ ``todoForm``\ という名前で\ ``Model``\ に追加される。 | これは、\ ``TodoController``\ の各処理で、\ ``model.addAttribute("todoForm", form)``\ を実装するのと同義である。 * - | (3) - | \ ``/todo/list``\ というパスに\ ``GET``\ メソッドを使用してリクエストされた際に、一覧画面表示処理用のメソッド(\ ``list``\ メソッド)が実行されるように\ ``@GetMapping``\ アノテーションを設定する。 | | クラスレベルに\ ``@RequestMapping(“todo”)``\ が設定されているため、ここでは\ ``@GetMapping("list")``\ のみで良い。 * - | (4) - | \ ``Model``\ にTodoのリストを追加して、Viewに渡す。 * - | (5) - | View名として\ ``todo/list``\ を返すと、spring-mvc.xmlまたはSpringMvcConfig.javaに定義した\ ``ViewResolver``\ によって、\ :file:`WEB-INF/views/todo/list.jsp`\ がレンダリングされることになる。 .. note:: \ ``@GetMapping``\ や\ ``@PostMapping``\ は、対応するHTTPメソッドにマッピングする。 詳細は、\ :ref:`controller_mapping-label`\ を参照されたい。 | JSPの作成 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" JSPを作成し、Controllerから渡されたModelを表示する。 Package Explorer上で右クリック -> New -> File を選択し、「Create New File」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Enter or select the parent folder - \ ``todo/src/main/webapp/WEB-INF/views/todo``\ * - 2 - File name - \ ``list.jsp``\ を入力して「Finish」する。 作成したファイルは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/create-list-jsp.png まず、TODOの全件表示を行うために必要なJSPの実装を行う。 .. code-block:: jsp Todo List

Todo List

  • ${f:h(todo.todoTitle)} ${f:h(todo.todoTitle)}
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | \ ````\ タグを用いて、Todoのリストを全て表示する。 * - | (2) - | 完了かどうか(\ ``finished``\ )で、打ち消し線(\ ``text-decoration: line-through;``\ )を装飾するかどうかを判断する。 * - | (3) - | \ **文字列値を出力する際は、XSS対策のため、必ずf:h()関数を使用してHTMLエスケープを行うこと。**\ | XSS対策についての詳細は、\ :doc:`../Security/XSS`\ を参照されたい。 | | STSで「todo」プロジェクトを右クリックし、「Run As」→「Run on Server」でWebアプリケーションを起動する。 | ブラウザで http://localhost:8080/todo/todo/list にアクセスすると、以下のような画面が表示される。 .. figure:: ./images_TutorialTodo/image067.png :width: 25% | .. note:: 上記で表示されている画面には、TODOが1件も登録されていないため、TODOの一覧は出力されない。 以下のように、ドメイン層の作成で作成したTodoRepositoryImplを一時的に修正し初期データを登録することで、TODOの一覧が出力されることを確認できる。 なお、次節「\ :ref:`CreateTodoImplementation`\ 」で実際にTODOを登録できるようになるため、一覧の出力が確認できたら削除して構わない。 * \ ``TodoRepositoryImpl.java``\ .. code-block:: java package com.example.todo.domain.repository.todo; import java.util.Collection; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.springframework.stereotype.Repository; import com.example.todo.domain.model.Todo; @Repository public class TodoRepositoryImpl implements TodoRepository { private static final Map TODO_MAP = new ConcurrentHashMap(); static { Todo todo1 = new Todo(); todo1.setTodoId("1"); todo1.setTodoTitle("Send a e-mail"); Todo todo2 = new Todo(); todo2.setTodoId("2"); todo2.setTodoTitle("Have a lunch"); Todo todo3 = new Todo(); todo3.setTodoId("3"); todo3.setTodoTitle("Read a book"); todo3.setFinished(true); TODO_MAP.put(todo1.getTodoId(), todo1); TODO_MAP.put(todo2.getTodoId(), todo2); TODO_MAP.put(todo3.getTodoId(), todo3); } // omitted 以下のように画面に出力される。 .. figure:: ./images_TutorialTodo/show-all-todo-note.png :width: 30% | .. _CreateTodoImplementation: Create TODOの実装 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 次に、一覧表示画面から「Create TODO」ボタンを押した後の、新規作成処理を実装する。 はじめに、TODOの全件表示を行うための処理を実装する。 | マッパーインタフェースの作成 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Beanマッピングのマッパーインタフェースを作成する。 Package Explorer上で右クリック -> New -> Interface を選択し、「New Java Interface」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.app.todo``\ * - 2 - Name - \ ``TodoMapper``\ を入力して「Finish」する。 作成したクラスは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/create-bean-mapper.png 作成したクラスに以下の\ ``@Mapper``\ アノテーションを付与したBeanマッピングメソッドを追加する。 * Todo map(TodoForm form) * \ ``@Mapping``\ アノテーションによるマッピング除外項目定義 * createdAt * finished .. code-block:: java package com.example.todo.app.todo; import org.mapstruct.Mapper; import org.mapstruct.Mapping; import com.example.todo.domain.model.Todo; @Mapper public interface TodoMapper { @Mapping(target = "createdAt", ignore = true) @Mapping(target = "finished", ignore = true) Todo map(TodoForm form); } .. note:: マッパーインタフェース追加後、以下のようなビルドエラーが発生する場合がある。 .. code-block:: console Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.example.todo.app.todo.TodoMapper' この場合は、プロジェクト名を右クリックし、「Run As」->「Maven build」をクリックする。 Goalsに「compile」を指定し「Run」をクリックする。 .. figure:: ./images_TutorialTodo/mvnBuild.png :width: 40% ビルドが成功した後、プロジェクト名を右クリックし、「Run As」->「Maven install」をクリックする。 | Controllerの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 新規作成処理を\ ``TodoController``\ に追加する。 .. code-block:: java package com.example.todo.app.todo; import java.util.Collection; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.validation.BindingResult; 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.servlet.mvc.support.RedirectAttributes; import org.terasoluna.gfw.common.exception.BusinessException; import org.terasoluna.gfw.common.message.ResultMessage; import org.terasoluna.gfw.common.message.ResultMessages; import com.example.todo.domain.model.Todo; import com.example.todo.domain.service.todo.TodoService; import jakarta.inject.Inject; import jakarta.validation.Valid; @Controller @RequestMapping("todo") public class TodoController { @Inject TodoService todoService; // (1) @Inject TodoMapper beanMapper; @ModelAttribute public TodoForm setUpForm() { TodoForm form = new TodoForm(); return form; } @GetMapping("list") public String list(Model model) { Collection todos = todoService.findAll(); model.addAttribute("todos", todos); return "todo/list"; } @PostMapping("create") // (2) public String create(@Valid TodoForm todoForm, BindingResult bindingResult, // (3) Model model, RedirectAttributes attributes) { // (4) // (5) if (bindingResult.hasErrors()) { return list(model); } // (6) Todo todo = beanMapper.map(todoForm); try { todoService.create(todo); } catch (BusinessException e) { // (7) model.addAttribute(e.getResultMessages()); return list(model); } // (8) attributes.addFlashAttribute(ResultMessages.success().add(ResultMessage .fromText("Created successfully!"))); return "redirect:/todo/list"; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | FormオブジェクトをDomainObjectに変換するために、``TodoMapper``\ インタフェースをインジェクションする。 * - | (2) - | \ ``/todo/create``\ というパスに\ ``POST``\ メソッドを使用してリクエストされた際に、新規作成処理用のメソッド(\ ``create``\ メソッド)が実行されるように\ ``@PostMapping``\ アノテーションを設定する。 * - | (3) - | フォームの入力チェックを行うため、Formの引数に\ ``@Valid``\ アノテーションをつける。入力チェック結果は、その直後の引数\ ``BindingResult``\ に格納される。 * - | (4) - | 正常に作成が完了した後にリダイレクトし、一覧画面を表示する。 | リダイレクト先への情報を格納するために、引数に\ ``RedirectAttributes``\ を加える。 * - | (5) - | 入力エラーがあった場合、一覧画面に戻る。 | Todo全件取得を再度行う必要があるので、\ ``list``\ メソッドを再実行する。 * - | (6) - | \ ``Mapstruct``\ を用いて、\ ``TodoForm``\ オブジェクトから\ ``Todo``\ オブジェクトを作成する。 * - | (7) - | 業務処理を実行して、\ ``BusinessException``\ が発生した場合、結果メッセージを\ ``Model``\ に追加して、一覧画面に戻る。 * - | (8) - | 正常に作成が完了したので、結果メッセージをflashスコープに追加して、一覧画面でリダイレクトする。 | リダイレクトすることにより、ブラウザを再読み込みして、再び新規登録処理が\ ``POST``\ されることがなくなる。（詳しくは、「\ :ref:`DoubleSubmitProtectionAboutPRG`\ 」を参照されたい） | なお、今回は成功メッセージであるため、\ ``ResultMessages.success()``\ を使用している。 | Formの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 入力チェックのルールを定義するため、Formオブジェクトにアノテーションを追加する。 .. code-block:: java package com.example.todo.app.todo; import java.io.Serializable; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Size; public class TodoForm implements Serializable { private static final long serialVersionUID = 1L; @NotNull // (1) @Size(min = 1, max = 30) // (2) private String todoTitle; public String getTodoTitle() { return todoTitle; } public void setTodoTitle(String todoTitle) { this.todoTitle = todoTitle; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.80\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 80 * - 項番 - 説明 * - | (1) - | \ ``@NotNull``\ アノテーションを使用して必須チェックを有効化する。 * - | (2) - | \ ``@Size``\ アノテーションを使用して文字数チェックを有効化する。 | JSPの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 以下を表示するために必要なJSPの実装を追加する。 * TODOの入力フォーム * 「Create Todo」ボタン * 入力チェックエラーを表示するエリア * 結果メッセージを表示するエリア .. code-block:: jsp Todo List

Todo List

Create Todo
  • ${f:h(todo.todoTitle)} ${f:h(todo.todoTitle)}
.. tabularcolumns:: |p{0.10\linewidth}|p{0.80\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 80 * - 項番 - 説明 * - | (1) - | \ ````\ タグで、結果メッセージを表示する。 * - | (2) - | 新規作成処理用のformを表示する。 | formを表示するために、\ ````\ タグを使用する。 | \ ``modelAttribute``\ 属性には、Controllerで\ ``Model``\ に追加したFormの名前を指定する。 | \ ``action``\ 属性には新規作成処理を実行するためのURL(\ ``/todo/create``\ )を指定する。 | 新規作成処理は更新系の処理なので、\ ``method``\ 属性には\ ``POST``\ メソッドを指定する。 | | \ ``action``\ 属性に指定するは、\ ``${pageContext.request.contextPath}``\ で取得することができる。 * - | (3) - | \ ````\ タグでフォームのプロパティをバインドする。 | \ ``modelAttribute``\ 属性に指定したFormのプロパティ名と、\ ``path``\ 属性の値が一致している必要がある。 * - | (4) - | \ ````\ タグで、入力エラーがあった場合に表示する。\ ``path``\ 属性の値は、\ ````\ タグと合わせる。 | フォームに適切な値を入力してsubmitすると、以下のように、成功メッセージが表示される。 .. figure:: ./images_TutorialTodo/image068.png :width: 40% .. figure:: ./images_TutorialTodo/image069.png :width: 40% 未完了のTODOが5件登録済みの場合は、業務エラーとなり、エラーメッセージが表示される。 .. figure:: ./images_TutorialTodo/image070.png :width: 60% 入力フォームを、空文字にしてsubmitすると、以下のように、エラーメッセージが表示される。 .. figure:: ./images_TutorialTodo/image071.png :width: 65% | メッセージ表示のカスタマイズ """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ ````\ を使用した場合、以下のようなHTMLが出力される。 .. code-block:: html
  • Created successfully!
スタイルシート(\ ``list.jsp``\ の\ ``

Todo List

Create Todo
  • ${f:h(todo.todoTitle)} ${f:h(todo.todoTitle)} Finish
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | TODOが未完了の場合は、TODOを完了させるためのリクエストを送信するformを表示する。 | \ ``action``\ 属性には完了処理を実行するためのURL(\ ``/todo/finish``\ )を指定する。 | 完了処理は更新系の処理なので、\ ``method``\ 属性には\ ``POST``\ メソッドを指定する。 | なお、「Finish」ボタンをインラインブロック要素（\ ``display: inline-block;``\ ）としてTODOの横に表示させている。 * - | (2) - | \ ````\ タグを使用して、リクエストパラメータとして\ ``todoId``\ を送信する。 | \ ``value``\ 属性に値を設定する場合も、\ **必ずf:h()関数でHTMLエスケープすること。**\ | Todoを新規作成した後に、「Finish」ボタン押下すると、以下のように打ち消し線が入り、完了したことがわかる。 .. figure:: ./images_TutorialTodo/image075.png :width: 40% .. figure:: ./images_TutorialTodo/image076.png :width: 40% | Delete TODOの実装 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 一覧表示画面に「Delete」ボタンを追加して、TODOを削除するための処理を追加する。 | Formの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 削除処理用のFormについても、\ ``TodoForm``\ を使用する。 .. code-block:: java package com.example.todo.app.todo; import java.io.Serializable; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Size; public class TodoForm implements Serializable { public static interface TodoCreate { }; public static interface TodoFinish { }; // (1) public static interface TodoDelete { } private static final long serialVersionUID = 1L; // (2) @NotNull(groups = { TodoFinish.class, TodoDelete.class }) private String todoId; @NotNull(groups = { TodoCreate.class }) @Size(min = 1, max = 30, groups = { TodoCreate.class }) private String todoTitle; public String getTodoId() { return todoId; } public void setTodoId(String todoId) { this.todoId = todoId; } public String getTodoTitle() { return todoTitle; } public void setTodoTitle(String todoTitle) { this.todoTitle = todoTitle; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 削除処理用の入力チェックルールをグループ化するためのインタフェースとして\ ``TodoDelete``\ を作成する。 * - | (2) - | 削除処理では\ ``todoId``\ プロパティを使用する。 | そのため、\ ``todoId``\ の\ ``@NotNull``\ アノテーションの\ ``groups``\ 属性には、削除処理用の入力チェックルールである事を示す\ ``TodoDelete``\ インタフェースを指定する。 | Controllerの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 削除処理を\ ``TodoController``\ に追加する。完了処理とほぼ同じである。 .. code-block:: java package com.example.todo.app.todo; import java.util.Collection; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.validation.BindingResult; 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.servlet.mvc.support.RedirectAttributes; import org.terasoluna.gfw.common.exception.BusinessException; import org.terasoluna.gfw.common.message.ResultMessage; import org.terasoluna.gfw.common.message.ResultMessages; import com.example.todo.app.todo.TodoForm.TodoCreate; import com.example.todo.app.todo.TodoForm.TodoDelete; import com.example.todo.app.todo.TodoForm.TodoFinish; import com.example.todo.domain.model.Todo; import com.example.todo.domain.service.todo.TodoService; import jakarta.inject.Inject; import jakarta.validation.groups.Default; @Controller @RequestMapping("todo") public class TodoController { @Inject TodoService todoService; @Inject TodoMapper beanMapper; @ModelAttribute public TodoForm setUpForm() { TodoForm form = new TodoForm(); return form; } @GetMapping("list") public String list(Model model) { Collection todos = todoService.findAll(); model.addAttribute("todos", todos); return "todo/list"; } @PostMapping("create") public String create(@Validated({ Default.class, TodoCreate.class }) TodoForm todoForm, BindingResult bindingResult, Model model, RedirectAttributes attributes) { if (bindingResult.hasErrors()) { return list(model); } Todo todo = beanMapper.map(todoForm); try { todoService.create(todo); } catch (BusinessException e) { model.addAttribute(e.getResultMessages()); return list(model); } attributes.addFlashAttribute(ResultMessages.success().add(ResultMessage .fromText("Created successfully!"))); return "redirect:/todo/list"; } @PostMapping("finish") public String finish(@Validated({ Default.class, TodoFinish.class }) TodoForm form, BindingResult bindingResult, Model model, RedirectAttributes attributes) { if (bindingResult.hasErrors()) { return list(model); } try { todoService.finish(form.getTodoId()); } catch (BusinessException e) { model.addAttribute(e.getResultMessages()); return list(model); } attributes.addFlashAttribute(ResultMessages.success().add(ResultMessage .fromText("Finished successfully!"))); return "redirect:/todo/list"; } @PostMapping("delete") // (1) public String delete(@Validated({ Default.class, TodoDelete.class }) TodoForm form, BindingResult bindingResult, Model model, RedirectAttributes attributes) { if (bindingResult.hasErrors()) { return list(model); } try { todoService.delete(form.getTodoId()); } catch (BusinessException e) { model.addAttribute(e.getResultMessages()); return list(model); } attributes.addFlashAttribute(ResultMessages.success().add(ResultMessage .fromText("Deleted successfully!"))); return "redirect:/todo/list"; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - \ ``/todo/delete``\ というパスに\ ``POST``\ メソッドを使用してリクエストされた際に、削除処理用のメソッド(\ ``delete``\ メソッド)が実行されるように\ ``@PostMapping``\ アノテーションを設定する。 | JSPの修正 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 削除処理用のformを追加する。 .. code-block:: jsp Todo List

Todo List

Create Todo
  • ${f:h(todo.todoTitle)} ${f:h(todo.todoTitle)} Finish Delete
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 削除処理用のformを表示する。 | \ ``action``\ 属性には削除処理を実行するためのURL(\ ``/todo/delete``\ )を指定する。 | 削除処理は更新系の処理なので、\ ``method``\ 属性には\ ``POST``\ メソッドを指定する。 * - | (2) - | \ ````\ タグを使用して、リクエストパラメータとして\ ``todoId``\ を送信する。 | \ ``value``\ 属性に値を設定する場合も、\ **必ずf:h()関数でHTMLエスケープすること。**\ | 未完了状態のTODOの「Delete」ボタンを押下すると、以下のようにTODOが削除される。 .. figure:: ./images_TutorialTodo/image077.png :width: 40% .. figure:: ./images_TutorialTodo/image078.png :width: 40% | CSSファイルの使用 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ これまでスタイルシートをJSPファイルの中で直接定義していたが、 実際のアプリケーションを開発する場合は、CSSファイルに定義するのが一般的である。 ここでは、スタイルシートをCSSファイルに定義する方法について説明する。 ブランクプロジェクトから提供しているCSSファイル(\ ``src/main/webapp/resources/app/css/styles.css``\ )にスタイルシートの定義を追加する。 .. code-block:: css /* ... */ .strike { text-decoration: line-through; } .inline { display: inline-block; } .alert { border: 1px solid; margin-bottom: 5px; } .alert-error { background-color: #c60f13; border-color: #970b0e; color: white; } .alert-success { background-color: #5da423; border-color: #457a1a; color: white; } .text-error { color: #c60f13; } .alert ul { margin: 15px 0px 15px 0px; } #todoList li { margin-top: 5px; } | JSPからCSSファイルを読み込む。 .. code-block:: jsp Todo List

Todo List

Create Todo
  • ${f:h(todo.todoTitle)} ${f:h(todo.todoTitle)} Finish Delete
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | JSPファイルからスタイルシートの定義を削除し、代わりにスタイルシートを定義したCSSファイルを読み込む。 | CSSファイルを適用すると、以下のようなレイアウトになる。 .. figure:: ./images_TutorialTodo/list-screen-css.png :width: 40% | .. _tutorial-todo_infra: データベースアクセスを伴うインフラストラクチャ層の作成 ================================================================================ ここでは、Domainオブジェクトをデータベースに永続化するためのインフラストラクチャ層の実装方法について説明する。 本チュートリアルでは、以下の2つのO/R Mapperを使用したインフラストラクチャ層の実装方法について説明する。 * MyBatis3 * Spring Data JPA | .. _TutorialCreateORMapperBlankProject: O/R Mapperに依存したブランクプロジェクトの作成 -------------------------------------------------------------------------------- ここでは、O/R Mapperに依存したブランクプロジェクトの作成を行う。 まず、使用するO/R Mapperに応じてプロジェクトを作成し直す。 * \ :ref:`TutorialCreateMyBatis3BlankProject`\ * \ :ref:`TutorialCreateJPABlankProject`\ 次に、\ :ref:`tutorial-todo_infra`\ までで作成した\ :file:`src`\ フォルダ以下のうち、\ **TodoRepositoryImplクラス以外のファイルを新規作成したプロジェクトにコピーする**\ 。 \ **ただし、コピーするファイルは新規作成したファイル・変更を加えたファイルに限り、修正を加えていないファイルはコピーしないこと**\ 。 | .. _Tutorial_Setup_Database: データベースのセットアップ -------------------------------------------------------------------------------- ここでは、データベースのセットアップを行う。 本チュートリアルでは、データベースのセットアップの手間を省くため、H2 Databaseを使用する。 | todo-infra.propertiesの修正 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ APサーバ起動時にH2 Database上にテーブルが作成されるようにするために、\ :file:`src/main/resources/META-INF/spring/todo-infra.properties`\ の設定を変更する。 .. code-block:: properties database=H2 # (1) database.url=jdbc:h2:mem:todo;DB_CLOSE_DELAY=-1;INIT=create table if not exists todo(todo_id varchar(36) primary key, todo_title varchar(30), finished boolean, created_at timestamp) database.username=sa database.password= database.driverClassName=org.h2.Driver # connection pool cp.maxActive=96 cp.maxIdle=16 cp.minIdle=0 cp.maxWait=60000 .. tabularcolumns:: |p{0.10\linewidth}|p{0.80\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 80 * - 項番 - 説明 * - | (1) - | 接続URLのINITパラメータに、テーブルを作成するDDL文を指定する。 .. note:: INITパラメータに設定しているDDL文をフォーマットすると、以下の様なSQLとなる。 .. code-block:: sql create table if not exists todo ( todo_id varchar(36) primary key, todo_title varchar(30), finished boolean, created_at timestamp ) | .. _using_MyBatis3: MyBatis3を使用したインフラストラクチャ層の作成 -------------------------------------------------------------------------------- ここでは、MyBatis3を使用してインフラストラクチャ層のRepositoryImplを作成する方法について説明する。 Spring Data JPAを使用する場合は、本節を読み飛ばして、\ :ref:`using_SpringDataJPA`\ に進んでよい。 | TodoRepositoryの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | \ ``TodoRepository``\ は、O/R Mapperを使用しない場合と同じ方法で作成する。 | 作成方法は、「\ :ref:`TutorialTodoCreateRepository`\ 」を参照されたい。 | TodoRepositoryImplの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | MyBatis3を使用する場合、RepositoryImplはRepositoryインタフェース(Mapperインタフェース)から自動生成される。 | そのため、\ ``TodoRepositoryImpl``\ の作成は不要である。作成した場合は削除すること。 | Mapperファイルの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``TodoRepository``\ インタフェースのメソッドが呼び出された際に実行するSQLを定義するためのMapperファイルを作成する。 Package Explorer上で右クリック -> New -> File を選択し、「Create New File」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Enter or select the parent folder - \ ``todo/src/main/resources/com/example/todo/domain/repository/todo``\ * - 2 - File name - \ ``TodoRepository.xml``\ を入力して「Finish」する。 作成したファイルは以下のディレクトリに格納される。 .. figure:: ./images_TutorialTodo/create-mapper-for-mybatis3.png \ ``TodoRepository``\ インタフェースに定義したメソッドが呼び出された際に実行するSQLを記述する。 .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | \ ``mapper``\ 要素の\ ``namespace``\ 属性に、Repositoryインタフェースの完全修飾クラス名(FQCN)を指定する。 * - | (2) - | \ ````\ 要素に、検索結果(\ ``ResultSet``\ )とJavaBeanのマッピング定義を行う。 | マッピングファイルの詳細は\ :doc:`../ArchitectureInDetail/DataAccessDetail/DataAccessMyBatis3`\ を参照されたい。 * - | (3) - | \ ``todoId``\ (PK)が一致するレコードを1件取得するSQLを実装する。 | \ ````\ 要素の\ ``resultMap``\ 属性に、適用するマッピング定義のIDを指定する。 | アプリケーションの要件には記載がないが、最新のTODOが先頭に表示されるようにレコードを並び替えている。 * - | (5) - | 引数に指定されたTodoオブジェクトを挿入するSQLを実装する。 | \ ````\ 要素の\ ``parameterType``\ 属性に、パラメータのクラス名(FQCN又はエイリアス名)を指定する。 * - | (6) - | 引数に指定されたTodoオブジェクトを更新するSQLを実装する。 | \ ````\ 要素の\ ``parameterType``\ 属性に、パラメータのクラス名(FQCN又はエイリアス名)を指定する。 * - | (7) - | 引数に指定されたTodoオブジェクトを削除するSQLを実装する。 | \ ````\ 要素の\ ``parameterType``\ 属性に、パラメータのクラス名(FQCN又はエイリアス名)を指定する。 * - | (8) - | 引数に指定された\ ``finished``\ に一致するTodoの件数を取得するSQLを実装する。 | 以上で、MyBatis3を使用したインフラストラクチャ層の作成が完了したので、Service及びアプリケーション層の作成を行う。 Service及びアプリケーション層を作成後にAPサーバーを起動し、Todoの表示を行うと、以下のようなSQLログやトランザクションログが出力される。 .. code-block:: console date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[START CONTROLLER] TodoController.list(Model) date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:o.s.jdbc.datasource.DataSourceTransactionManager message:Creating new transaction with name [com.example.todo.domain.service.todo.TodoServiceImpl.findAll]: PROPAGATION_REQUIRED,ISOLATION_DEFAULT,readOnly date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:o.s.jdbc.datasource.DataSourceTransactionManager message:Acquired Connection [2013925503, URL=jdbc:h2:mem:todo-jsp-mybatis3, H2 JDBC Driver] for JDBC transaction date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:c.e.t.d.repository.todo.TodoRepository.findAll message:==> Preparing: SELECT todo_id, todo_title, finished, created_at FROM todo date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:c.e.t.d.repository.todo.TodoRepository.findAll message:==> Parameters: date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:c.e.t.d.repository.todo.TodoRepository.findAll message:<== Total: 0 date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:o.s.jdbc.datasource.DataSourceTransactionManager message:Initiating transaction commit date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:o.s.jdbc.datasource.DataSourceTransactionManager message:Committing JDBC transaction on Connection [2013925503, URL=jdbc:h2:mem:todo-jsp-mybatis3, H2 JDBC Driver] date:2022-11-29 17:51:09 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:DEBUG logger:o.s.jdbc.datasource.DataSourceTransactionManager message:Releasing JDBC Connection [2013925503, URL=jdbc:h2:mem:todo-jsp-mybatis3, H2 JDBC Driver] after transaction date:2022-11-29 17:51:10 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[END CONTROLLER ] TodoController.list(Model)-> view=todo/list, model={todoForm=com.example.todo.app.todo.TodoForm@78becf2c, todos=[], org.springframework.validation.BindingResult.todoForm=org.springframework.validation.BeanPropertyBindingResult: 0 errors} date:2022-11-29 17:51:10 thread:http-nio-8080-exec-3 X-Track:9eef87761a264278a38d4c2e14a99959 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[HANDLING TIME ] TodoController.list(Model)-> 165,863,500 ns | .. _using_SpringDataJPA: Spring Data JPAを使用したインフラストラクチャ層の作成 -------------------------------------------------------------------------------- ここでは、\ `Spring Data JPA `_\ を使用してインフラストラクチャ層のRepositoryImplを作成する方法について説明する。 | Entityの修正 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TodoクラスとデータベースのTODOテーブルをマッピングするために、JPAのアノテーションを設定する。 .. code-block:: java package com.example.todo.domain.model; import java.io.Serializable; import java.util.Date; import jakarta.persistence.Column; import jakarta.persistence.Entity; import jakarta.persistence.Id; import jakarta.persistence.Table; import jakarta.persistence.Temporal; import jakarta.persistence.TemporalType; // (1) @Entity @Table(name = "todo") public class Todo implements Serializable { private static final long serialVersionUID = 1L; // (2) @Id @Column(name = "todo_id") private String todoId; @Column(name = "todo_title") private String todoTitle; @Column(name = "finished") private boolean finished; // (3) @Temporal(TemporalType.TIMESTAMP) @Column(name = "created_at") private Date createdAt; public String getTodoId() { return todoId; } public void setTodoId(String todoId) { this.todoId = todoId; } public String getTodoTitle() { return todoTitle; } public void setTodoTitle(String todoTitle) { this.todoTitle = todoTitle; } public boolean isFinished() { return finished; } public void setFinished(boolean finished) { this.finished = finished; } public Date getCreatedAt() { return createdAt; } public void setCreatedAt(Date createdAt) { this.createdAt = createdAt; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | JPAのエンティティであることを示す\ ``@Entity``\ アノテーションを付け、対応するテーブル名を\ ``@Table``\ アノテーションで設定する。 * - | (2) - | 主キーとなるカラムに対応するフィールドに、\ ``@Id``\ アノテーションをつける。 * - | (3) - | \ ``java.util.Date``\ 型は、\ ``java.sql.Date``\ ,\ ``java.sql.Time``\ ,\ ``java.sql.Timestamp``\ のインスタンスを格納できるため、明示的にどの型のインスタンスを設定するか指定する必要がある。 | \ ``createdAt``\ プロパティには、\ ``Timestamp``\ を指定する。 | TodoRepositoryの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Spring Data JPAのRepository機能を使用して\ ``TodoRepository``\ の作成を行う。 Package Explorer上で右クリック -> New -> Interface を選択し、「New Java Interface」ダイアログを表示し、 .. tabularcolumns:: |p{0.10\linewidth}|p{0.30\linewidth}|p{0.50\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 30 50 * - 項番 - 項目 - 入力値 * - 1 - Package - \ ``com.example.todo.domain.repository.todo``\ * - 2 - Name - \ ``TodoRepository``\ * - 3 - Extended interfaces - \ ``org.springframework.data.jpa.repository.JpaRepository``\ を入力して「Finish」する。 .. code-block:: java package com.example.todo.domain.repository.todo; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.Query; import org.springframework.data.repository.query.Param; import com.example.todo.domain.model.Todo; // (1) public interface TodoRepository extends JpaRepository { @Query("SELECT COUNT(t) FROM Todo t WHERE t.finished = :finished") // (2) long countByFinished(@Param("finished") boolean finished); // (3) } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | \ ``JpaRepository``\ のGenericsのパラメータを指定する。 | 左から順に、Entityのクラス(\ ``Todo`` \)、主キーのクラス(\ ``String``\ )を指定する。 | 基本的なCRUD操作(\ ``findById``\ ,\ ``findAll``\ ,\ ``save``\ ,\ ``deleteById``\ など)は、\ ``JpaRepository``\ インタフェースに定義済みであるため、\ ``TodoRepository``\ には\ ``countByFinished``\ メソッドのみ定義すればよい。 * - | (2) - | \ ``countByFinished``\ メソッドを呼び出した際に実行するJPQLを、\ ``@Query``\ アノテーションで指定する。 * - | (3) - | (2)で指定したJPQL内のバインド変数に対応するメソッド引数に、\ ``@Param``\ アノテーションを指定する。 | ここでは、JPQL中の\ ``”:finished”``\ に値を埋め込むために、メソッド引数の\ ``finished``\ に\ ``@Param(“finished”)``\ を付けている。 | TodoRepositoryImplの作成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Spring Data JPAを使用する場合、RepositoryImplはRepositoryインタフェースから自動生成される。 そのため、\ ``TodoRepositoryImpl``\ の作成は不要である。作成した場合は削除すること。 .. note:: 当ページをはじめから順に実施した場合、\ ``TodoRepositoryImpl``\ の削除が必要になるが、削除したタイミングで\ ``TodoServiceImpl``\ がコンパイルエラーとなる。 JPA用のメソッドに切り替える必要があるため、ソースコード内のコメントを参考に\ ``create``\ メソッドと\ ``update``\ メソッドを\ ``save``\ メソッドへ変更する必要がある。 | 以上で、Spring Data JPAを使用したインフラストラクチャ層の作成が完了したので、Service及びアプリケーション層の作成を行う。 Service及びアプリケーション層を作成後にAPサーバーを起動し、Todoの表示を行うと、以下のようなSQLログや、トランザクションログが出力される。 .. code-block:: console date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[START CONTROLLER] TodoController.list(Model) date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:DEBUG logger:o.h.engine.transaction.internal.TransactionImpl message:On TransactionImpl creation, JpaCompliance#isJpaTransactionComplianceEnabled == false date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:DEBUG logger:o.h.engine.transaction.internal.TransactionImpl message:begin date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:DEBUG logger:org.hibernate.SQL message:/* */ select t1_0.todo_id,t1_0.created_at,t1_0.finished,t1_0.todo_title from todo t1_0 date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:DEBUG logger:o.h.engine.transaction.internal.TransactionImpl message:committing date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[END CONTROLLER ] TodoController.list(Model)-> view=todo/list, model={todoForm=com.example.todo.app.todo.TodoForm@5fcdd91a, todos=[], org.springframework.validation.BindingResult.todoForm=org.springframework.validation.BeanPropertyBindingResult: 0 errors} date:2022-11-29 17:42:58 thread:http-nio-8080-exec-4 X-Track:67bbe0a8a3e8416baf91d5dcd73273e8 level:TRACE logger:o.t.gfw.web.logging.TraceLoggingInterceptor message:[HANDLING TIME ] TodoController.list(Model)-> 247,911,500 ns | おわりに ================================================================================ このチュートリアルでは、以下の内容を学習した。 * TERASOLUNA Server Framework for Java (5.x)による基本的なアプリケーションの開発方法 * MavenおよびSTS(Eclipse)プロジェクトの構築方法 * TERASOLUNA Server Framework for Java (5.x)のアプリケーションのレイヤ化に従った開発方法 * POJO(+ Spring)を使用したドメイン層の実装 * POJO(+ Spring MVC)とJSPタグライブラリを使用したアプリケーション層の実装 * MyBatis3を使用したインフラストラクチャ層の実装 * Spring Data JPAを使用したインフラストラクチャ層の実装 * O/R Mapperを使用しないインフラストラクチャ層の実装 本チュートリアルで作成したTODO管理アプリケーションには、以下の改善点がある。 アプリケーションの修正を学習課題として、ガイドライン中の該当する説明を参照されたい。 * プロパティ(未完了TODOの上限数)を外部化する → \ :doc:`../ArchitectureInDetail/GeneralFuncDetail/PropertyManagement`\ * メッセージを外部化する → \ :doc:`../ArchitectureInDetail/WebApplicationDetail/MessageManagement`\ * ページネーション機能を追加する → \ :doc:`../ArchitectureInDetail/WebApplicationDetail/Pagination`\ * 例外ハンドリングを加える → \ :doc:`../ArchitectureInDetail/WebApplicationDetail/ExceptionHandling`\ * 二重送信を防止する(トランザクショントークンチェックを追加する) → \ :doc:`../ArchitectureInDetail/WebApplicationDetail/DoubleSubmitProtection`\ * システム日時の取得元を変更する → \ :doc:`../ArchitectureInDetail/GeneralFuncDetail/SystemDate`\ | Appendix ================================================================================ .. _TutorialTodoAppendixExpoundConfigurations: 設定ファイルの解説 -------------------------------------------------------------------------------- | アプリケーションを動かすためにどのような設定が必要なのかを理解するために、設定ファイルの解説を行う。 | ここでは、チュートリアルで作成するTodoアプリケーションで使用しない設定については、解説を割愛している箇所がある。 | web.xml ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ :file:`web.xml`\ には、WebアプリケーションとしてTodoアプリをデプロイするための設定を行う。 作成したブランクプロジェクトの\ :file:`src/main/webapp/WEB-INF/web.xml`\ は、以下のような設定となっている。 .. tabs:: .. group-tab:: Java Config .. code-block:: xml logbackDisableServletContainerInitializer true contextClass org.springframework.web.context.support.AnnotationConfigWebApplicationContext ch.qos.logback.classic.servlet.LogbackServletContextListener org.springframework.web.context.ContextLoaderListener contextConfigLocation com.example.todo.config.app.ApplicationContextConfig com.example.todo.config.web.SpringSecurityConfig org.terasoluna.gfw.web.logging.HttpSessionEventLoggingListener MDCClearFilter org.terasoluna.gfw.web.logging.mdc.MDCClearFilter MDCClearFilter /* exceptionLoggingFilter org.springframework.web.filter.DelegatingFilterProxy exceptionLoggingFilter /* XTrackMDCPutFilter org.terasoluna.gfw.web.logging.mdc.XTrackMDCPutFilter XTrackMDCPutFilter /* CharacterEncodingFilter org.springframework.web.filter.CharacterEncodingFilter encoding UTF-8 forceEncoding true CharacterEncodingFilter /* springSecurityFilterChain org.springframework.web.filter.DelegatingFilterProxy springSecurityFilterChain /* appServlet org.springframework.web.servlet.DispatcherServlet contextClass org.springframework.web.context.support.AnnotationConfigWebApplicationContext contextConfigLocation com.example.todo.config.web.SpringMvcConfig 1 appServlet / *.jsp false UTF-8 false /WEB-INF/views/common/include.jsp 500 /WEB-INF/views/common/error/systemError.jsp 404 /WEB-INF/views/common/error/resourceNotFoundError.jsp java.lang.Exception /WEB-INF/views/common/error/unhandledSystemError.html 30 true COOKIE .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | Servlet6.0を使用するための宣言。 * - | (2) - | サーブレットコンテキストリスナーの定義。 ブランクプロジェクトでは、 * アプリケーション全体で使用される\ ``ApplicationContext``\ を作成するための\ ``ContextLoaderListener``\ * HttpSessionに対する操作をログ出力するための \ ``HttpSessionEventLoggingListener``\ が設定済みである。 * - | (3) - | サーブレットフィルタの定義。 ブランクプロジェクトでは、 * 共通ライブラリから提供しているサーブレットフィルタ * Spring Frameworkから提供されている文字エンコーディングを指定するための\ ``CharacterEncodingFilter``\ * Spring Securityから提供されている認証・認可用のサーブレットフィルタ が設定済みである。 * - | (4) - | Spring MVCのエントリポイントとなるDispatcherServletの定義。 | | DispatcherServletの中で使用する\ ``ApplicationContext``\ を、(2)で作成した\ ``ApplicationContext``\ の子として作成する。 | (2)で作成した\ ``ApplicationContext``\ を親にすることで、(2)で読み込まれたコンポーネントも使用することができる。 * - | (5) - | JSPの共通定義。 ブランクプロジェクトでは、 * JSP内でEL式が使用可能な状態 * JSPのページエンコーディングとしてUTF-8 * JSP内でスクリプティングが使用可能な状態 * 各JSPの先頭でインクルードするJSPとして、\ :file:`/WEB-INF/views/common/include.jsp`\ が設定済みである。 * - | (6) - | エラーページの定義。 ブランクプロジェクトでは、 * サーブレットコンテナにHTTPステータスコードとして、\ ``404``\ 又は\ ``500``\ が応答 * サーブレットコンテナに例外が通知 された際の遷移先が定義済みである。 * - | (7) - | セッション管理の定義。 ブランクプロジェクトでは、 * セッションタイムアウトとして、30分 が定義済みである。 | .. group-tab:: Xml Config .. code-block:: xml logbackDisableServletContainerInitializer true ch.qos.logback.classic.servlet.LogbackServletContextListener org.springframework.web.context.ContextLoaderListener contextConfigLocation classpath*:META-INF/spring/applicationContext.xml classpath*:META-INF/spring/spring-security.xml org.terasoluna.gfw.web.logging.HttpSessionEventLoggingListener MDCClearFilter org.terasoluna.gfw.web.logging.mdc.MDCClearFilter MDCClearFilter /* exceptionLoggingFilter org.springframework.web.filter.DelegatingFilterProxy exceptionLoggingFilter /* XTrackMDCPutFilter org.terasoluna.gfw.web.logging.mdc.XTrackMDCPutFilter XTrackMDCPutFilter /* CharacterEncodingFilter org.springframework.web.filter.CharacterEncodingFilter encoding UTF-8 forceEncoding true CharacterEncodingFilter /* springSecurityFilterChain org.springframework.web.filter.DelegatingFilterProxy springSecurityFilterChain /* appServlet org.springframework.web.servlet.DispatcherServlet contextConfigLocation classpath*:META-INF/spring/spring-mvc.xml 1 appServlet / *.jsp false UTF-8 false /WEB-INF/views/common/include.jsp 500 /WEB-INF/views/common/error/systemError.jsp 404 /WEB-INF/views/common/error/resourceNotFoundError.jsp java.lang.Exception /WEB-INF/views/common/error/unhandledSystemError.html 30 true COOKIE .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | Servlet6.0を使用するための宣言。 * - | (2) - | サーブレットコンテキストリスナーの定義。 ブランクプロジェクトでは、 * アプリケーション全体で使用される\ ``ApplicationContext``\ を作成するための\ ``ContextLoaderListener``\ * HttpSessionに対する操作をログ出力するための \ ``HttpSessionEventLoggingListener``\ が設定済みである。 * - | (3) - | サーブレットフィルタの定義。 ブランクプロジェクトでは、 * 共通ライブラリから提供しているサーブレットフィルタ * Spring Frameworkから提供されている文字エンコーディングを指定するための\ ``CharacterEncodingFilter``\ * Spring Securityから提供されている認証・認可用のサーブレットフィルタ が設定済みである。 * - | (4) - | Spring MVCのエントリポイントとなるDispatcherServletの定義。 | | DispatcherServletの中で使用する\ ``ApplicationContext``\ を、(2)で作成した\ ``ApplicationContext``\ の子として作成する。 | (2)で作成した\ ``ApplicationContext``\ を親にすることで、(2)で読み込まれたコンポーネントも使用することができる。 * - | (5) - | JSPの共通定義。 ブランクプロジェクトでは、 * JSP内でEL式が使用可能な状態 * JSPのページエンコーディングとしてUTF-8 * JSP内でスクリプティングが使用可能な状態 * 各JSPの先頭でインクルードするJSPとして、\ :file:`/WEB-INF/views/common/include.jsp`\ が設定済みである。 * - | (6) - | エラーページの定義。 ブランクプロジェクトでは、 * サーブレットコンテナにHTTPステータスコードとして、\ ``404``\ 又は\ ``500``\ が応答 * サーブレットコンテナに例外が通知 された際の遷移先が定義済みである。 * - | (7) - | セッション管理の定義。 ブランクプロジェクトでは、 * セッションタイムアウトとして、30分 が定義済みである。 | インクルードJSP ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ インクルードJSPには、全てのJSPに適用するJSPの設定や、タグライブラリの設定を行う。 作成したブランクプロジェクトの\ :file:`src/main/webapp/WEB-INF/views/common/include.jsp`\ は、以下のような設定となっている。 .. code-block:: jsp <%@ page session="false"%> <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%> <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt"%> <%@ taglib uri="http://www.springframework.org/tags" prefix="spring"%> <%@ taglib uri="http://www.springframework.org/tags/form" prefix="form"%> <%@ taglib uri="http://www.springframework.org/security/tags" prefix="sec"%> <%@ taglib uri="http://terasoluna.org/tags" prefix="t"%> <%@ taglib uri="http://terasoluna.org/functions" prefix="f"%> .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | JSP実行時にセッションを作成しないようにするための定義。 * - | (2) - | 標準タグライブラリの定義。 * - | (3) - | Spring MVC用タグライブラリの定義。 * - | (4) - | Spring Security用タグライブラリの定義(本チュートリアルでは使用しない。) * - | (5) - | 共通ライブラリで提供されている、EL関数、タグライブラリの定義。 | Bean定義ファイル ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 作成したブランクプロジェクトには、以下のBean定義ファイルとプロパティファイルが作成される。 .. tabs:: .. group-tab:: Java Config * \ :file:`src/main/java/com/example/todo/config/app/ApplicationContextConfig.java`\ * \ :file:`src/main/java/com/example/todo/config/app/TodoCodeListConfig.java`\ * \ :file:`src/main/java/com/example/todo/config/app/TodoDomainConfig.java`\ * \ :file:`src/main/java/com/example/todo/config/app/TodoInfraConfig.java`\ * \ :file:`src/main/resources/META-INF/spring/todo-infra.properties`\ * \ :file:`src/main/java/com/example/todo/config/app/TodoEnvConfig.java`\ * \ :file:`src/main/java/com/example/todo/config/web/SpringMvcConfig.java`\ * \ :file:`src/main/java/com/example/todo/config/web/SpringSecurityConfig.java`\ .. note:: O/R Mapperに依存しないブランクプロジェクトを作成した場合は、\ ``todo-infra.properties``\ と\ ``TodoEnvConfig.java``\ は作成されない。 .. group-tab:: XML Config * \ :file:`src/main/resources/META-INF/spring/applicationContext.xml`\ * \ :file:`src/main/resources/META-INF/spring/todo-codelist.xml`\ * \ :file:`src/main/resources/META-INF/spring/todo-domain.xml`\ * \ :file:`src/main/resources/META-INF/spring/todo-infra.xml`\ * \ :file:`src/main/resources/META-INF/spring/todo-infra.properties`\ * \ :file:`src/main/resources/META-INF/spring/todo-env.xml`\ * \ :file:`src/main/resources/META-INF/spring/spring-mvc.xml`\ * \ :file:`src/main/resources/META-INF/spring/spring-security.xml`\ .. note:: O/R Mapperに依存しないブランクプロジェクトを作成した場合は、\ ``todo-infra.properties``\ と\ ``todo-env.xml``\ は作成されない。 .. note:: 本ガイドラインでは、Bean定義ファイルを役割(層)ごとにファイルを分割することを推奨している。 これは、どこに何が定義されているか想像しやすく、メンテナンス性が向上するからである。 今回のチュートリアルのような小さなアプリケーションでは効果はないが、アプリケーションの規模が大きくなるにつれ、効果が大きくなる。 | applicationContext """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`ApplicationContextConfig.java`\ には、Todoアプリ全体に関わる設定を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/java/com/example/todo/config/app/ApplicationContextConfig.java`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: java package com.example.todo.config.app; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.Map; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.MessageSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.EnableAspectJAutoProxy; import org.springframework.context.annotation.Import; import org.springframework.context.support.PropertySourcesPlaceholderConfigurer; import org.springframework.context.support.ResourceBundleMessageSource; import org.springframework.core.io.Resource; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; import org.springframework.security.crypto.password.DelegatingPasswordEncoder; import org.springframework.security.crypto.password.PasswordEncoder; import org.springframework.security.crypto.password.Pbkdf2PasswordEncoder; import org.terasoluna.gfw.common.exception.ExceptionCodeResolver; import org.terasoluna.gfw.common.exception.ExceptionLogger; import org.terasoluna.gfw.common.exception.SimpleMappingExceptionCodeResolver; import org.terasoluna.gfw.web.exception.ExceptionLoggingFilter; /** * Application context. */ @Configuration @EnableAspectJAutoProxy @Import({ TodoDomainConfig.class }) // (1) public class ApplicationContextConfig { /** * Configure {@link PasswordEncoder} bean. * @return Bean of configured {@link DelegatingPasswordEncoder} */ @Bean("passwordEncoder") public PasswordEncoder passwordEncoder() { Map idToPasswordEncoder = new HashMap<>(); idToPasswordEncoder.put("pbkdf2", pbkdf2PasswordEncoder()); idToPasswordEncoder.put("bcrypt", bCryptPasswordEncoder()); /* When using commented out PasswordEncoders, you need to add bcprov-jdk18on.jar to the dependency. idToPasswordEncoder.put("argon2", argon2PasswordEncoder()); idToPasswordEncoder.put("scrypt", sCryptPasswordEncoder()); */ return new DelegatingPasswordEncoder("pbkdf2", idToPasswordEncoder); } /** * Configure {@link Pbkdf2PasswordEncoder} bean. * @return Bean of configured {@link Pbkdf2PasswordEncoder} */ @Bean public Pbkdf2PasswordEncoder pbkdf2PasswordEncoder() { return Pbkdf2PasswordEncoder.defaultsForSpringSecurity_v5_8(); } /** * Configure {@link BCryptPasswordEncoder} bean. * @return Bean of configured {@link BCryptPasswordEncoder} */ @Bean public BCryptPasswordEncoder bCryptPasswordEncoder() { return new BCryptPasswordEncoder(); } /* When using commented out PasswordEncoders, you need to add bcprov-jdk18on.jar to the dependency. @Bean public Argon2PasswordEncoder argon2PasswordEncoder() { return Argon2PasswordEncoder.defaultsForSpringSecurity_v5_8(); } @Bean public SCryptPasswordEncoder sCryptPasswordEncoder() { return SCryptPasswordEncoder.defaultsForSpringSecurity_v5_8(); } */ /** * Configure {@link PropertySourcesPlaceholderConfigurer} bean. * @param properties Property files to be read * @return Bean of configured {@link PropertySourcesPlaceholderConfigurer} */ // (2) @Bean public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer( @Value("classpath*:/META-INF/spring/*.properties") Resource... properties) { PropertySourcesPlaceholderConfigurer bean = new PropertySourcesPlaceholderConfigurer(); bean.setLocations(properties); return bean; } /** * Configure {@link MessageSource} bean. * @return Bean of configured {@link ResourceBundleMessageSource} */ @Bean("messageSource") public MessageSource messageSource() { ResourceBundleMessageSource bean = new ResourceBundleMessageSource(); bean.setBasenames("i18n/application-messages"); return bean; } /** * Configure {@link ExceptionCodeResolver} bean. * @return Bean of configured {@link SimpleMappingExceptionCodeResolver} */ @Bean("exceptionCodeResolver") public ExceptionCodeResolver exceptionCodeResolver() { LinkedHashMap map = new LinkedHashMap<>(); map.put("ResourceNotFoundException", "e.xx.fw.5001"); map.put("InvalidTransactionTokenException", "e.xx.fw.7001"); map.put("BusinessException", "e.xx.fw.8001"); map.put(".DataAccessException", "e.xx.fw.9002"); SimpleMappingExceptionCodeResolver bean = new SimpleMappingExceptionCodeResolver(); bean.setExceptionMappings(map); bean.setDefaultExceptionCode("e.xx.fw.9001"); return bean; } /** * Configure {@link ExceptionLogger} bean. * @return Bean of configured {@link ExceptionLogger} */ @Bean("exceptionLogger") public ExceptionLogger exceptionLogger() { ExceptionLogger bean = new ExceptionLogger(); bean.setExceptionCodeResolver(exceptionCodeResolver()); return bean; } /** * Configure {@link ExceptionLoggingFilter} bean. * @return Bean of configured {@link ExceptionLoggingFilter} */ @Bean("exceptionLoggingFilter") public ExceptionLoggingFilter exceptionLoggingFilter() { ExceptionLoggingFilter bean = new ExceptionLoggingFilter(); bean.setExceptionLogger(exceptionLogger()); return bean; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | ドメイン層に関するBean定義ファイルをimportする。 * - | (2) - | プロパティファイルの読み込み設定を行う。 | \ ``src/main/resources/META-INF/spring``\ 直下の任意のプロパティファイルを読み込む。 | この設定により、プロパティファイルの値をBean定義ファイル内で\ ``${propertyName}``\ 形式で埋め込んだり、Javaクラスに\ ``@Value("${propertyName}")``\ でインジェクションすることができる。 .. group-tab:: XML Config \ :file:`applicationContext.xml`\ には、Todoアプリ全体に関わる設定を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/applicationContext.xml`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: xml i18n/application-messages .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | ドメイン層に関するBean定義ファイルをimportする。 * - | (2) - | プロパティファイルの読み込み設定を行う。 | \ ``src/main/resources/META-INF/spring``\ 直下の任意のプロパティファイルを読み込む。 | この設定により、プロパティファイルの値をBean定義ファイル内で\ ``${propertyName}``\ 形式で埋め込んだり、Javaクラスに\ ``@Value("${propertyName}")``\ でインジェクションすることができる。 .. tip:: エディタの「Configure Namespaces」タブにて、以下のようにチェックを入れると、チェックしたXMLスキーマが有効になり、XML編集時にCtrl+Spaceを使用して入力を補完することができる。 「Namespace Versions」にはバージョンなしのxsdファイルを選択することを推奨する。バージョンなしのxsdファイルを選択することで、常にjarに含まれる最新のxsdが使用されるため、Springのバージョンアップを意識する必要がなくなる。 .. figure:: ./images_TutorialTodo/image021.jpg :width: 90% .. figure:: ./images_TutorialTodo/image023.png :width: 60% | todo-domain """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`TodoDomainConfig.java`\ には、Todoアプリのドメイン層に関わる設定を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/java/com/example/todo/config/app/TodoDomainConfig.java`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: java package com.example.todo.config.app; import org.springframework.aop.Advisor; import org.springframework.aop.aspectj.AspectJExpressionPointcut; import org.springframework.aop.support.DefaultPointcutAdvisor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.transaction.annotation.EnableTransactionManagement; import org.terasoluna.gfw.common.exception.ExceptionLogger; import org.terasoluna.gfw.common.exception.ResultMessagesLoggingInterceptor; /** * Bean definitions for domain layer. */ @Configuration @EnableTransactionManagement @ComponentScan(basePackages = { "com.example.todo.domain" }) // (1) @Import({ TodoInfraConfig.class, TodoCodeListConfig.class }) // (2) public class TodoDomainConfig { /** * Configure {@link ResultMessagesLoggingInterceptor} bean. * @param exceptionLogger Bean defined by ApplicationContextConfig#exceptionLogger * @see com.example.todo.config.app.ApplicationContextConfig#exceptionLogger() * @return Bean of configured {@link ResultMessagesLoggingInterceptor} */ @Bean("resultMessagesLoggingInterceptor") public ResultMessagesLoggingInterceptor resultMessagesLoggingInterceptor( ExceptionLogger exceptionLogger) { ResultMessagesLoggingInterceptor bean = new ResultMessagesLoggingInterceptor(); bean.setExceptionLogger(exceptionLogger); return bean; } /** * Configure messages logging AOP advisor. * @param resultMessagesLoggingInterceptor Bean defined by #resultMessagesLoggingInterceptor * @see #resultMessagesLoggingInterceptor(ExceptionLogger) * @return Advisor configured for PointCut */ @Bean public Advisor resultMessagesLoggingInterceptorAdvisor( ResultMessagesLoggingInterceptor resultMessagesLoggingInterceptor) { AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut(); pointcut.setExpression( "@within(org.springframework.stereotype.Service)"); return new DefaultPointcutAdvisor(pointcut, resultMessagesLoggingInterceptor); } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | ドメイン層のクラスを管理するcom.example.todo.domainパッケージ配下をcomponent-scan対象とする。 | これにより、com.example.todo.domainパッケージ配下のクラスに ``@Repository`` , ``@Service`` などのアノテーションを付けることで、Spring Framerowkが管理するBeanとして登録される。 | 登録されたクラス(Bean)は、ControllerやServiceクラスにDIする事で、利用する事が出来る。 * - | (2) - | インフラストラクチャ層に関するBean定義ファイルをimportする。 .. note:: O/R Mapperに依存するブランクプロジェクトを作成した場合は、\ ``@Transactional``\ アノテーションによるトランザクション管理を有効にするために、\ ``@EnableTransactionManagement``\ アノテーションが設定されている。 .. code-block:: java @EnableTransactionManagement .. group-tab:: XML Config \ :file:`todo-domain.xml`\ には、Todoアプリのドメイン層に関わる設定を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/todo-domain.xml`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | インフラストラクチャ層に関するBean定義ファイルをimportする。 * - | (2) - | ドメイン層のクラスを管理するcom.example.todo.domainパッケージ配下をcomponent-scan対象とする。 | これにより、com.example.todo.domainパッケージ配下のクラスに\ ``@Repository``\ ,\ ``@Service``\ などのアノテーションを付けることで、Spring Framerowkが管理するBeanとして登録される。 | 登録されたクラス(Bean)は、ControllerやServiceクラスにDIする事で、利用する事が出来る。 .. note:: O/R Mapperに依存するブランクプロジェクトを作成した場合は、\ ``@Transactional``\ アノテーションによるトランザクション管理を有効にするために、\ ````\ タグが設定されている。 .. code-block:: xml | todo-infra """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`TodoInfraConfig.java`\ には、Todoアプリのインフラストラクチャ層に関わる設定を行う。 作成したブランクプロジェクトの\ :file:`src/main/java/com/example/todo/config/app/TodoInfraConfig.java`\ は、以下のような設定となっている。 \ :file:`TodoInfraConfig.java`\は、インフラストラクチャ層によって設定が大きく異なるため、ブランクプロジェクト毎に説明を行う。作成したブランクプロジェクト以外の説明は読み飛ばしてもよい。 .. group-tab:: XML Config \ :file:`todo-infra.xml`\ には、Todoアプリのインフラストラクチャ層に関わる設定を行う。 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/todo-infra.xml`\ は、以下のような設定となっている。 \ :file:`todo-infra.xml`\は、インフラストラクチャ層によって設定が大きく異なるため、ブランクプロジェクト毎に説明を行う。作成したブランクプロジェクト以外の説明は読み飛ばしてもよい。 | O/R Mapperに依存しないブランクプロジェクトを作成した場合のtodo-infra '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' O/R Mapperに依存しないブランクプロジェクトを作成した場合、以下のように空定義のファイルが作成される。 .. tabs:: .. group-tab:: Java Config .. code-block:: java package com.example.todo.config.app; import org.springframework.context.annotation.Configuration; /** * Bean definitions for infrastructure layer. */ @Configuration public class TodoInfraConfig { } .. group-tab:: XML Config .. code-block:: xml | MyBatis3用のブランクプロジェクトを作成した場合のtodo-infra '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' MyBatis3用のブランクプロジェクトを作成した場合、以下のような設定となっている。 .. tabs:: .. group-tab:: Java Config .. code-block:: java package com.example.todo.config.app; import javax.sql.DataSource; import org.mybatis.spring.SqlSessionFactoryBean; import org.mybatis.spring.annotation.MapperScan; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import com.example.todo.config.app.mybatis.MybatisConfig; /** * Bean definitions for infrastructure layer. */ @Configuration @MapperScan("com.example.todo.domain.repository") // (1) @Import({ TodoEnvConfig.class }) // (2) public class TodoInfraConfig { /** * Configure {@link SqlSessionFactory} bean. * @param dataSource DataSource * @see com.example.todo.config.app.TodoEnvConfig#dataSource() * @return Bean of configured {@link SqlSessionFactoryBean} */ // (3) @Bean("sqlSessionFactory") public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); // (4) bean.setDataSource(dataSource); // (5) bean.setConfiguration(MybatisConfig.configuration()); return bean; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | Mapperインタフェースをスキャンするために\ ``@MapperScan``\ を定義し、Mapperインタフェースが格納されている基底パッケージを指定する。 | * - | (2) - | 環境依存するコンポーネント(データソースやトランザクションマネージャなど)を定義するBean定義ファイルをimportする。 | | 指定されたパッケージ配下に格納されている Mapperインタフェースがスキャンされ、スレッドセーフなMapperオブジェクト(MapperインタフェースのProxyオブジェクト)が自動的に生成される。 | * - | (3) - | \ ``SqlSessionFactory``\ を生成するためのコンポーネントとして、\ ``SqlSessionFactoryBean``\ をbean定義する。 | * - | (4) - | \ ``dataSource``\ プロパティに、設定済みのデータソースのbeanを指定する。 | | MyBatis3の処理の中でSQLを発行する際は、ここで指定したデータソースからコネクションが取得される。 * - | (5) - | \ ``configuration``\ プロパティに、MyBatisの設定をしたConfigurationクラスを指定する。 | | ここで指定したクラスは\ ``SqlSessionFactory``\ を生成する時に読み込まれる。 .. group-tab:: XML Config .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 環境依存するコンポーネント(データソースやトランザクションマネージャなど)を定義するBean定義ファイルをimportする。 * - | (2) - | \ ``SqlSessionFactory``\ を生成するためのコンポーネントとして、\ ``SqlSessionFactoryBean``\ をbean定義する。 * - | (3) - | \ ``dataSource``\ プロパティに、設定済みのデータソースのbeanを指定する。 | | MyBatis3の処理の中でSQLを発行する際は、ここで指定したデータソースからコネクションが取得される。 * - | (4) - | \ ``configLocation``\ プロパティに、MyBatis設定ファイルのパスを指定する。 | | ここで指定したファイルは\ ``SqlSessionFactory``\ を生成する時に読み込まれる。 * - | (5) - | Mapperインタフェースをスキャンするために\ ````\ を定義し、\ ``base-package``\ 属性には、Mapperインタフェースが格納されている基底パッケージを指定する。 | | 指定されたパッケージ配下に格納されている Mapperインタフェースがスキャンされ、スレッドセーフなMapperオブジェクト(MapperインタフェースのProxyオブジェクト)が自動的に生成される。 .. note:: \ :file:`mybatis-config.xml`\ は、MyBatis3自体の動作設定を行う設定ファイルである。 ブランクプロジェクトでは、デフォルトで以下の設定が行われている。 .. code-block:: xml | JPA用のブランクプロジェクトを作成した場合のtodo-infra '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' JPA用のブランクプロジェクトを作成した場合、以下のような設定となっている。 .. tabs:: .. group-tab:: Java Config .. code-block:: java package com.example.todo.config.app; import java.util.HashMap; import java.util.Map; import javax.sql.DataSource; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; import org.springframework.orm.jpa.vendor.Database; import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; /** * Bean definitions for infrastructure layer. */ @Configuration @EnableJpaRepositories("com.example.todo.domain.repository") // (1) @Import({ TodoEnvConfig.class }) // (2) public class TodoInfraConfig { /** * Database property. */ @Value("${database}") private Database database; /** * Configure {@link HibernateJpaVendorAdapter} bean. * @return Bean of configured {@link HibernateJpaVendorAdapter} */ // (3) @Bean("jpaVendorAdapter") public HibernateJpaVendorAdapter jpaVendorAdapter() { HibernateJpaVendorAdapter bean = new HibernateJpaVendorAdapter(); bean.setDatabase(database); return bean; } /** * Configure {@link LocalContainerEntityManagerFactoryBean} bean. * @param dataSource DataSource * @return Bean of configured {@link LocalContainerEntityManagerFactoryBean} */ // (4) @Bean("entityManagerFactory") public LocalContainerEntityManagerFactoryBean entityManagerFactory( DataSource dataSource) { LocalContainerEntityManagerFactoryBean bean = new LocalContainerEntityManagerFactoryBean(); bean.setPackagesToScan("com.example.todo.domain.model"); bean.setDataSource(dataSource); bean.setJpaVendorAdapter(jpaVendorAdapter()); bean.setJpaPropertyMap(jpaPropertyMap()); return bean; } /** * Configure {@link LocalContainerEntityManagerFactoryBean}.JpaPropertyMap. * @return configured JpaPropertyMap */ // (5) private Map jpaPropertyMap() { Map jpaPropertyMap = new HashMap<>(); jpaPropertyMap.put("hibernate.connection.charSet", "UTF-8"); jpaPropertyMap.put("hibernate.format_sql", false); jpaPropertyMap.put("hibernate.use_sql_comments", true); jpaPropertyMap.put("hibernate.jdbc.batch_size", 30); jpaPropertyMap.put("hibernate.jdbc.fetch_size", 100); return jpaPropertyMap; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | Spring Data JPAを使用して、Repositoryインタフェースから実装クラスを自動生成する。 | \ ``@EnableJpaRepositories``\ アノテーションに、Repositoryを格納するパッケージを指定する。 * - | (2) - | 環境依存するコンポーネント(データソースやトランザクションマネージャなど)を定義するBean定義ファイルをimportする。 * - | (3) - | JPAの実装ベンダの設定を行う。 | JPA実装として、Hibernateを使うため、\ ``HibernateJpaVendorAdapter``\ を定義している。 * - | (4) - | \ ``EntityManager``\ の定義を行う。 * - | (5) - | Hibernateに関する詳細な設定を行う。 .. group-tab:: XML Config .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 環境依存するコンポーネント(データソースやトランザクションマネージャなど)を定義するBean定義ファイルをimportする。 * - | (2) - | Spring Data JPAを使用して、Repositoryインタフェースから実装クラスを自動生成する。 | \ ````\ タグの\ ``base-package``\ 属性に、Repositoryを格納するパッケージを指定する。 * - | (3) - | JPAの実装ベンダの設定を行う。 | JPA実装として、Hibernateを使うため、\ ``HibernateJpaVendorAdapter``\ を定義している。 * - | (4) - | \ ``EntityManager``\ の定義を行う。 * - | (5) - | JPAのエンティティとして扱うクラスが格納されているパッケージ名を指定する。 * - | (6) - | Hibernateに関する詳細な設定を行う。 | todo-infra.properties """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ :file:`todo-infra.properties`\ には、Todoアプリのインフラストラクチャ層における環境依存値の設定を行う。 O/R Mapperに依存しないブランクプロジェクトを作成した際は、\ :file:`todo-infra.properties`\ は作成されない。 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/todo-infra.properties`\ は、以下のような設定となっている。 .. code-block:: properties # (1) database=H2 database.url=jdbc:h2:mem:todo;DB_CLOSE_DELAY=-1 database.username=sa database.password= database.driverClassName=org.h2.Driver # (2) # connection pool cp.maxActive=96 cp.maxIdle=16 cp.minIdle=0 cp.maxWait=60000 .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | データベースに関する設定を行う。 | 本チュートリアルでは、データベースのセットアップの手間を省くため、H2 Databaseを使用する。 * - | (2) - | コネクションプールに関する設定。 .. note:: これらの設定値は、\ :file:`todo-env.xml`\ または\ :file:`TodoEnvConfig.java`\ から参照されている。 | todo-env """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`TodoEnvConfig.java`\ には、デプロイする環境によって設定が異なるコンポーネントの設定を行う。 作成したブランクプロジェクトの\ ``src/main/java/com/example/todo/config/app/TodoEnvConfig.java``\ は、以下のような設定となっている。 ここでは、MyBatis3用のブランクプロジェクトに格納されるファイルを例に説明する。なお、データベースにアクセスしないブランクプロジェクトを作成した際は、\ :file:`TodoEnvConfig.java`\ は作成されない。 .. code-block:: java package com.example.todo.config.app; import java.time.Duration; import javax.sql.DataSource; import org.apache.commons.dbcp2.BasicDataSource; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.ClassPathResource; import org.springframework.jdbc.datasource.DataSourceTransactionManager; import org.springframework.jdbc.datasource.init.DataSourceInitializer; import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator; import org.springframework.transaction.TransactionManager; import org.terasoluna.gfw.common.time.ClockFactory; import org.terasoluna.gfw.common.time.DefaultClockFactory; /* REMOVE THIS LINE IF YOU USE JPA import org.springframework.orm.jpa.JpaTransactionManager; import jakarta.persistence.EntityManagerFactory; REMOVE THIS LINE IF YOU USE JPA */ /** * Define settings for the environment. */ @Configuration public class TodoEnvConfig { /** * DataSource.driverClassName property. */ @Value("${database.driverClassName}") private String driverClassName; /** * DataSource.url property. */ @Value("${database.url}") private String url; /** * DataSource.username property. */ @Value("${database.username}") private String username; /** * DataSource.password property. */ @Value("${database.password}") private String password; /** * DataSource.maxTotal property. */ @Value("${cp.maxActive}") private Integer maxActive; /** * DataSource.maxIdle property. */ @Value("${cp.maxIdle}") private Integer maxIdle; /** * DataSource.minIdle property. */ @Value("${cp.minIdle}") private Integer minIdle; /** * DataSource.maxWaitMillis property. */ @Value("${cp.maxWait}") private Integer maxWait; /** * Property databaseName. */ @Value("${database}") private String database; /** * Configure {@link ClockFactory}. * @return Bean of configured {@link DefaultClockFactory} */ @Bean("dateFactory") public ClockFactory dateFactory() { return new DefaultClockFactory(); } /** * Configure {@link DataSource} bean. * @return Bean of configured {@link BasicDataSource} */ // (1) @Bean(name = "dataSource", destroyMethod = "close") public DataSource dataSource() { BasicDataSource bean = new BasicDataSource(); bean.setDriverClassName(driverClassName); bean.setUrl(url); bean.setUsername(username); bean.setPassword(password); bean.setDefaultAutoCommit(false); bean.setMaxTotal(maxActive); bean.setMaxIdle(maxIdle); bean.setMinIdle(minIdle); bean.setMaxWait(Duration.ofMillis(maxWait)); return bean; } /** * Configuration to set up database during initialization. * @return Bean of configured {@link DataSourceInitializer} */ // (2) @Bean public DataSourceInitializer dataSourceInitializer() { DataSourceInitializer bean = new DataSourceInitializer(); bean.setDataSource(dataSource()); // (3) ResourceDatabasePopulator databasePopulator = new ResourceDatabasePopulator(); databasePopulator.addScript(new ClassPathResource("/database/" + database + "-schema.sql")); databasePopulator.addScript(new ClassPathResource("/database/" + database + "-dataload.sql")); databasePopulator.setSqlScriptEncoding("UTF-8"); databasePopulator.setIgnoreFailedDrops(true); bean.setDatabasePopulator(databasePopulator); return bean; } /* REMOVE THIS LINE IF YOU USE JPA /** * Configure {@link TransactionManager} bean for use with JPA. * @param entityManagerFactory EntityManager used within a transaction * @return Bean of configured {@link JpaTransactionManager} *REMOVE THIS COMMENT IF YOU USE JPA/ @Bean("transactionManager") public TransactionManager transactionManager(EntityManagerFactory entityManagerFactory) { JpaTransactionManager bean = new JpaTransactionManager(); bean.setEntityManagerFactory(entityManagerFactory); return bean; } REMOVE THIS LINE IF YOU USE JPA */ /** * Configure {@link TransactionManager} bean. * @return Bean of configured {@link DataSourceTransactionManager} */ // (4) @Bean("transactionManager") public TransactionManager transactionManager() { DataSourceTransactionManager bean = new DataSourceTransactionManager(); bean.setDataSource(dataSource()); bean.setRollbackOnCommitFailure(true); return bean; } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 実データソースの設定。 * - | (2) - | データベース初期化の設定。 | データベースを初期化するSQLファイルを実行するための設定を行っている。 | | この設定は通常、開発中のみでしか使用しない(環境に依存する設定)ため、\ ``TodoEnvConfig.java`` \ に定義されている。 * - | (3) - | データベースを初期化するSQLファイルの設定。 | データベースを初期化するための、DDL文が記載されているSQLファイルとDML文が記載されているSQLファイルを指定している。 | | ブランクプロジェクトの設定では\ ``todo-infra.properties``\ に\ ``database=H2``\ と定義されているため、\ ``H2-schema.sql``\ 及び\ ``H2-dataload.sql``\ が実行される。 * - | (4) - | トランザクションマネージャの設定。 | id属性には、\ ``transactionManager``\ を指定する。 | | ブランクプロジェクトでは、JDBCのAPIを使用してトランザクションを制御するクラス(\ ``org.springframework.jdbc.datasource.DataSourceTransactionManager``\ )が設定されている。 .. note:: JPA用のブランクプロジェクトを作成した場合は、トランザクションマネージャには、JPAのAPIを使用してトランザクションを制御するクラス(\ ``org.springframework.orm.jpa.JpaTransactionManager``\ )が設定されている。 .. code-block:: Java @Bean("transactionManager") public TransactionManager transactionManager(EntityManagerFactory entityManagerFactory) { JpaTransactionManager bean = new JpaTransactionManager(); bean.setEntityManagerFactory(entityManagerFactory); return bean; } .. group-tab:: XML Config \ :file:`todo-env.xml`\ には、デプロイする環境によって設定が異なるコンポーネントの設定を行う。 作成したブランクプロジェクトの\ ``src/main/resources/META-INF/spring/todo-env.xml``\ は、以下のような設定となっている。 ここでは、MyBatis3用のブランクプロジェクトに格納されるファイルを例に説明する。なお、データベースにアクセスしないブランクプロジェクトを作成した際は、\ :file:`todo-env.xml`\ は作成されない。 .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 実データソースの設定。 * - | (2) - | データベース初期化の設定。 | データベースを初期化するSQLファイルを実行するための設定を行っている。 | | この設定は通常、開発中のみでしか使用しない(環境に依存する設定)ため、\ ``todo-env.xml``\ に定義されている。 * - | (3) - | データベースを初期化するSQLファイルの設定。 | データベースを初期化するための、DDL文が記載されているSQLファイルとDML文が記載されているSQLファイルを指定している。 | | ブランクプロジェクトの設定では\ ``todo-infra.properties``\ に\ ``database=H2``\ と定義されているため、\ ``H2-schema.sql``\ 及び\ ``H2-dataload.sql``\ が実行される。 * - | (4) - | トランザクションマネージャの設定。 | id属性には、\ ``transactionManager``\ を指定する。 | 別の名前を指定する場合は、\ ````\ タグにもトランザクションマネージャ名を指定する必要がある。 | | ブランクプロジェクトでは、JDBCのAPIを使用してトランザクションを制御するクラス(\ ``org.springframework.jdbc.datasource.DataSourceTransactionManager``\ )が設定されている。 .. note:: JPA用のブランクプロジェクトを作成した場合は、トランザクションマネージャには、JPAのAPIを使用してトランザクションを制御するクラス(\ ``org.springframework.orm.jpa.JpaTransactionManager``\ )が設定されている。 .. code-block:: xml | spring-mvc """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`SpringMvcConfig.java`\ には、Spring MVCに関する定義を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/java/com/example/todo/config/web/SpringMvcConfig.java`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: java package com.example.todo.config.web; import java.util.List; import java.util.Properties; import java.util.regex.Pattern; import org.springframework.aop.Advisor; import org.springframework.aop.aspectj.AspectJExpressionPointcut; import org.springframework.aop.support.DefaultPointcutAdvisor; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.EnableAspectJAutoProxy; import org.springframework.context.support.PropertySourcesPlaceholderConfigurer; import org.springframework.core.io.Resource; import org.springframework.data.web.PageableHandlerMethodArgumentResolver; import org.springframework.http.HttpStatus; /* REMOVE THIS LINE IF YOU USE JPA import org.springframework.orm.jpa.support.OpenEntityManagerInViewInterceptor; REMOVE THIS LINE IF YOU USE JPA */ import org.springframework.security.web.method.annotation.AuthenticationPrincipalArgumentResolver; import org.springframework.security.web.servlet.support.csrf.CsrfRequestDataValueProcessor; /* REMOVE THIS LINE IF YOU USE JPA import org.springframework.web.context.request.WebRequestInterceptor; REMOVE THIS LINE IF YOU USE JPA */ import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.ViewResolverRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import org.springframework.web.servlet.support.RequestDataValueProcessor; import org.terasoluna.gfw.common.exception.ExceptionCodeResolver; import org.terasoluna.gfw.common.exception.ExceptionLogger; import org.terasoluna.gfw.web.codelist.CodeListInterceptor; import org.terasoluna.gfw.web.exception.HandlerExceptionResolverLoggingInterceptor; import org.terasoluna.gfw.web.exception.SystemExceptionResolver; import org.terasoluna.gfw.web.logging.TraceLoggingInterceptor; import org.terasoluna.gfw.web.mvc.support.CompositeRequestDataValueProcessor; import org.terasoluna.gfw.web.token.transaction.TransactionTokenInterceptor; import org.terasoluna.gfw.web.token.transaction.TransactionTokenRequestDataValueProcessor; /** * Configure SpringMVC. */ // (1) @ComponentScan(basePackages = { "com.example.todo.app" }) @EnableAspectJAutoProxy @EnableWebMvc @Configuration public class SpringMvcConfig implements WebMvcConfigurer { /** * Configure {@link PropertySourcesPlaceholderConfigurer} bean. * @param properties Property files to be read * @return Bean of configured {@link PropertySourcesPlaceholderConfigurer} */ // (2) @Bean public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer( @Value("classpath*:/META-INF/spring/*.properties") Resource... properties) { PropertySourcesPlaceholderConfigurer bean = new PropertySourcesPlaceholderConfigurer(); bean.setLocations(properties); return bean; } /** * {@inheritDoc} */ // (3) @Override public void addArgumentResolvers( List argumentResolvers) { argumentResolvers.add(pageableHandlerMethodArgumentResolver()); argumentResolvers.add(authenticationPrincipalArgumentResolver()); } /** * Configure {@link PageableHandlerMethodArgumentResolver} bean. * @return Bean of configured {@link PageableHandlerMethodArgumentResolver} */ @Bean public PageableHandlerMethodArgumentResolver pageableHandlerMethodArgumentResolver() { return new PageableHandlerMethodArgumentResolver(); } /** * Configure {@link AuthenticationPrincipalArgumentResolver} bean. * @return Bean of configured {@link AuthenticationPrincipalArgumentResolver} */ @Bean public AuthenticationPrincipalArgumentResolver authenticationPrincipalArgumentResolver() { return new AuthenticationPrincipalArgumentResolver(); } /** * {@inheritDoc} */ @Override public void configureDefaultServletHandling( DefaultServletHandlerConfigurer configurer) { configurer.enable(); } /** * {@inheritDoc} */ // (4) @Override public void addResourceHandlers(final ResourceHandlerRegistry registry) { registry.addResourceHandler("/resources/**").addResourceLocations( "/resources/", "classpath:META-INF/resources/").setCachePeriod( 60 * 60); } /** * {@inheritDoc} */ // (5) @Override public void addInterceptors(InterceptorRegistry registry) { addInterceptor(registry, traceLoggingInterceptor()); addInterceptor(registry, transactionTokenInterceptor()); addInterceptor(registry, codeListInterceptor()); /* REMOVE THIS LINE IF YOU USE JPA addWebRequestInterceptor(registry, openEntityManagerInViewInterceptor()); REMOVE THIS LINE IF YOU USE JPA */ } /** * Common processes used in #addInterceptors. * @param registry {@link InterceptorRegistry} * @param interceptor {@link HandlerInterceptor} */ private void addInterceptor(InterceptorRegistry registry, HandlerInterceptor interceptor) { registry.addInterceptor(interceptor).addPathPatterns("/**") .excludePathPatterns("/resources/**"); } /* REMOVE THIS LINE IF YOU USE JPA /** * Common processes used in #addInterceptors. * @param registry {@link InterceptorRegistry} * @param interceptor {@link WebRequestInterceptor} *REMOVE THIS COMMENT IF YOU USE JPA/ private void addWebRequestInterceptor(InterceptorRegistry registry, WebRequestInterceptor interceptor) { registry.addWebRequestInterceptor(interceptor).addPathPatterns("/**") .excludePathPatterns("/resources/**"); } REMOVE THIS LINE IF YOU USE JPA */ /** * Configure {@link TraceLoggingInterceptor} bean. * @return Bean of configured {@link TraceLoggingInterceptor} */ @Bean public TraceLoggingInterceptor traceLoggingInterceptor() { return new TraceLoggingInterceptor(); } /** * Configure {@link TransactionTokenInterceptor} bean. * @return Bean of configured {@link TransactionTokenInterceptor} */ @Bean public TransactionTokenInterceptor transactionTokenInterceptor() { return new TransactionTokenInterceptor(); } /** * Configure {@link CodeListInterceptor} bean. * @return Bean of configured {@link CodeListInterceptor} */ @Bean public CodeListInterceptor codeListInterceptor() { CodeListInterceptor codeListInterceptor = new CodeListInterceptor(); codeListInterceptor.setCodeListIdPattern(Pattern.compile("CL_.+")); return codeListInterceptor; } /* REMOVE THIS LINE IF YOU USE JPA /** * Configure {@link OpenEntityManagerInViewInterceptor} bean. * @return Bean of configured {@link OpenEntityManagerInViewInterceptor} *REMOVE THIS COMMENT IF YOU USE JPA/ @Bean public OpenEntityManagerInViewInterceptor openEntityManagerInViewInterceptor() { return new OpenEntityManagerInViewInterceptor(); } REMOVE THIS LINE IF YOU USE JPA */ /** * {@inheritDoc} */ // (6) @Override public void configureViewResolvers(ViewResolverRegistry registry) { registry.jsp("/WEB-INF/views/", ".jsp"); } /** * Configure {@link RequestDataValueProcessor} bean. * @return Bean of configured {@link CompositeRequestDataValueProcessor} */ @Bean("requestDataValueProcessor") public RequestDataValueProcessor requestDataValueProcessor() { return new CompositeRequestDataValueProcessor(csrfRequestDataValueProcessor(), transactionTokenRequestDataValueProcessor()); } /** * Configure {@link CsrfRequestDataValueProcessor} bean. * @return Bean of configured {@link CsrfRequestDataValueProcessor} */ @Bean public CsrfRequestDataValueProcessor csrfRequestDataValueProcessor() { return new CsrfRequestDataValueProcessor(); } /** * Configure {@link TransactionTokenRequestDataValueProcessor} bean. * @return Bean of configured {@link TransactionTokenRequestDataValueProcessor} */ @Bean public TransactionTokenRequestDataValueProcessor transactionTokenRequestDataValueProcessor() { return new TransactionTokenRequestDataValueProcessor(); } /** * Configure {@link SystemExceptionResolver} bean. * @param exceptionCodeResolver Bean defined by ApplicationContext#exceptionCodeResolver * @see com.example.todo.config.app.ApplicationContext#exceptionCodeResolver() * @return Bean of configured {@link SystemExceptionResolver} */ @Bean("systemExceptionResolver") public SystemExceptionResolver systemExceptionResolver( ExceptionCodeResolver exceptionCodeResolver) { SystemExceptionResolver bean = new SystemExceptionResolver(); bean.setExceptionCodeResolver(exceptionCodeResolver); bean.setOrder(3); Properties exceptionMappings = new Properties(); exceptionMappings.setProperty("ResourceNotFoundException", "common/error/resourceNotFoundError"); exceptionMappings.setProperty("BusinessException", "common/error/businessError"); exceptionMappings.setProperty("InvalidTransactionTokenException", "common/error/transactionTokenError"); exceptionMappings.setProperty(".DataAccessException", "common/error/dataAccessError"); bean.setExceptionMappings(exceptionMappings); Properties statusCodes = new Properties(); statusCodes.setProperty("common/error/resourceNotFoundError", String .valueOf(HttpStatus.NOT_FOUND.value())); statusCodes.setProperty("common/error/businessError", String.valueOf( HttpStatus.CONFLICT.value())); statusCodes.setProperty("common/error/transactionTokenError", String .valueOf(HttpStatus.CONFLICT.value())); statusCodes.setProperty("common/error/dataAccessError", String.valueOf( HttpStatus.INTERNAL_SERVER_ERROR.value())); bean.setStatusCodes(statusCodes); bean.setDefaultErrorView("common/error/systemError"); bean.setDefaultStatusCode(HttpStatus.INTERNAL_SERVER_ERROR.value()); return bean; } /** * Configure messages logging AOP. * @param exceptionLogger Bean defined by ApplicationContext#exceptionLogger * @see com.example.todo.config.app.ApplicationContext#exceptionLogger() * @return Bean of configured {@link HandlerExceptionResolverLoggingInterceptor} */ @Bean("handlerExceptionResolverLoggingInterceptor") public HandlerExceptionResolverLoggingInterceptor handlerExceptionResolverLoggingInterceptor( ExceptionLogger exceptionLogger) { HandlerExceptionResolverLoggingInterceptor bean = new HandlerExceptionResolverLoggingInterceptor(); bean.setExceptionLogger(exceptionLogger); return bean; } /** * Configure messages logging AOP advisor. * @param handlerExceptionResolverLoggingInterceptor Bean defined by #handlerExceptionResolverLoggingInterceptor * @see #handlerExceptionResolverLoggingInterceptor(ExceptionLogger) * @return Advisor configured for PointCut */ @Bean public Advisor handlerExceptionResolverLoggingInterceptorAdvisor( HandlerExceptionResolverLoggingInterceptor handlerExceptionResolverLoggingInterceptor) { AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut(); pointcut.setExpression( "execution(* org.springframework.web.servlet.HandlerExceptionResolver.resolveException(..))"); return new DefaultPointcutAdvisor(pointcut, handlerExceptionResolverLoggingInterceptor); } } .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | アプリケーション層のクラスを管理するcom.example.todo.appパッケージ配下をcomponent-scan対象とする。 * - | (2) - | プロパティファイルの読み込み設定を行う。 | src/main/resources/META-INF/spring直下の任意のプロパティファイルを読み込む。 | この設定により、プロパティファイルの値をBean定義ファイル内で\ ``${propertyName}``\ 形式で埋め込んだり、Javaクラスに\ ``@Value("${propertyName}")``\ でインジェクションすることができる。 * - | (3) - | Spring MVCのアノテーションベースのデフォルト設定を行う。 * - | (4) - | 静的リソース(css, images, jsなど)アクセスのための設定を行う。 | \ ``mapping``\ 属性にURLのパスを、\ ``location``\ 属性に物理的なパスの設定を行う。 | この設定の場合\ ``/resources/app/css/styles.css``\ に対してリクエストが来た場合、\ ``WEB-INF/resources/app/css/styles.css``\ を探し、見つからなければクラスパス上(\ ``src/main/resources``\ やjar内)の\ ``META-INF/resources/app/css/styles.css``\ を探す。 | どこにも\ ``styles.css``\ が格納されていない場合は、404エラーを返す。 | ここでは\ ``cache-period``\ 属性で静的リソースのキャッシュ時間(3600秒=60分)も設定している。 | \ ``cache-period="3600"``\ と設定しても良いが、60分であることを明示するために\ `SpEL `_\ を使用して\ ``cache-period="#{60 * 60}"``\ と書く方が分かりやすい。 * - | (5) - | コントローラ処理のTraceログを出力するインターセプタを設定する。 | \ ``/resources``\ 配下を除く任意のパスに適用されるように設定する。 * - | (6) - | \ ``ViewResolver``\ の設定を行う。 | この設定により、例えばコントローラからview名として\ ``hello``\ が返却された場合には\ ``/WEB-INF/views/hello.jsp``\ が実行される。 .. note:: JPA用のブランクプロジェクトを作成した場合は、\ ``addInterceptors``\ の定義として、\ ``OpenEntityManagerInViewInterceptor``\ の定義が有効な状態となっている。 .. code-block:: Java @Override protected void addInterceptors(InterceptorRegistry registry) { addInterceptor(registry, traceLoggingInterceptor()); addInterceptor(registry, transactionTokenInterceptor()); addInterceptor(registry, codeListInterceptor()); addWebRequestInterceptor(registry, openEntityManagerInViewInterceptor()); } @Bean public OpenEntityManagerInViewInterceptor openEntityManagerInViewInterceptor() { return new OpenEntityManagerInViewInterceptor(); } \ ``OpenEntityManagerInViewInterceptor``\ は、\ ``EntityManager``\ のライフサイクルの開始と終了を行う\ ``Interceptor``\ である。この設定を追加することで、アプリケーション層(Controllerや、Viewクラス)でのLazy Loadが、サポートされる。 .. group-tab:: XML Config \ :file:`spring-mvc.xml`\ には、Spring MVCに関する定義を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/spring-mvc.xml`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないコンポーネントについての説明は割愛する。 .. code-block:: xml .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 :class: longtable * - 項番 - 説明 * - | (1) - | プロパティファイルの読み込み設定を行う。 | src/main/resources/META-INF/spring直下の任意のプロパティファイルを読み込む。 | この設定により、プロパティファイルの値をBean定義ファイル内で\ ``${propertyName}``\ 形式で埋め込んだり、Javaクラスに\ ``@Value("${propertyName}")``\ でインジェクションすることができる。 * - | (2) - | Spring MVCのアノテーションベースのデフォルト設定を行う。 * - | (3) - | アプリケーション層のクラスを管理するcom.example.todo.appパッケージ配下をcomponent-scan対象とする。 * - | (4) - | 静的リソース(css, images, jsなど)アクセスのための設定を行う。 | \ ``mapping``\ 属性にURLのパスを、\ ``location``\ 属性に物理的なパスの設定を行う。 | この設定の場合\ ``/resources/app/css/styles.css``\ に対してリクエストが来た場合、\ ``WEB-INF/resources/app/css/styles.css``\ を探し、見つからなければクラスパス上(\ ``src/main/resources``\ やjar内)の\ ``META-INF/resources/app/css/styles.css``\ を探す。 | どこにも\ ``styles.css``\ が格納されていない場合は、404エラーを返す。 | ここでは\ ``cache-period``\ 属性で静的リソースのキャッシュ時間(3600秒=60分)も設定している。 | \ ``cache-period="3600"``\ と設定しても良いが、60分であることを明示するために\ `SpEL `_\ を使用して\ ``cache-period="#{60 * 60}"``\ と書く方が分かりやすい。 * - | (5) - | コントローラ処理のTraceログを出力するインターセプタを設定する。 | \ ``/resources``\ 配下を除く任意のパスに適用されるように設定する。 * - | (6) - | \ ``ViewResolver``\ の設定を行う。 | この設定により、例えばコントローラからview名として\ ``hello``\ が返却された場合には\ ``/WEB-INF/views/hello.jsp``\ が実行される。 .. note:: JPA用のブランクプロジェクトを作成した場合は、\ ````\ の定義として、\ ``OpenEntityManagerInViewInterceptor``\ の定義が有効な状態となっている。 .. code-block:: xml \ ``OpenEntityManagerInViewInterceptor``\ は、\ ``EntityManager``\ のライフサイクルの開始と終了を行う\ ``Interceptor``\ である。この設定を追加することで、アプリケーション層(Controllerや、Viewクラス)でのLazy Loadが、サポートされる。 | spring-security """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. tabs:: .. group-tab:: Java Config \ :file:`SpringSecurityConfig.java`\ には、Spring Securityに関する定義を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/java/com/example/todo/config/web/SpringSecurityConfig.java`\ は、以下のような設定となっている。 | なお、本チュートリアルではSpring Securityの設定ファイルの説明は割愛する。Spring Securityの設定ファイルについては、「\ :doc:`./TutorialSecurity`\ 」を参照されたい。 .. code-block:: Java package com.example.todo.config.web; import java.util.LinkedHashMap; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.access.AccessDeniedException; import org.springframework.security.config.Customizer; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer; import org.springframework.security.web.SecurityFilterChain; import org.springframework.security.web.access.AccessDeniedHandler; import org.springframework.security.web.access.AccessDeniedHandlerImpl; import org.springframework.security.web.access.DelegatingAccessDeniedHandler; import org.springframework.security.web.access.expression.DefaultWebSecurityExpressionHandler; import org.springframework.security.web.authentication.AnonymousAuthenticationFilter; import org.springframework.security.web.csrf.InvalidCsrfTokenException; import org.springframework.security.web.csrf.MissingCsrfTokenException; import org.springframework.security.web.util.matcher.AntPathRequestMatcher; import org.terasoluna.gfw.security.web.logging.UserIdMDCPutFilter; /** * Bean definition to configure SpringSecurity. */ @Configuration @EnableWebSecurity public class SpringSecurityConfig { /** * Configure ignore security pattern. * @return Bean of configured {@link WebSecurityCustomizer} */ @Bean public WebSecurityCustomizer webSecurityCustomizer() { return web -> web.ignoring().requestMatchers( new AntPathRequestMatcher("/resources/**")); } /** * Configure {@link SecurityFilterChain} bean. * @param http Builder class for setting up authentication and authorization * @return Bean of configured {@link SecurityFilterChain} * @throws Exception Exception that occurs when setting HttpSecurity */ @Bean public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http.formLogin(Customizer.withDefaults()); http.logout(Customizer.withDefaults()); http.exceptionHandling(ex -> ex.accessDeniedHandler( accessDeniedHandler())); http.addFilterAfter(userIdMDCPutFilter(), AnonymousAuthenticationFilter.class); http.sessionManagement(Customizer.withDefaults()); http.authorizeHttpRequests(authz -> authz.requestMatchers( new AntPathRequestMatcher("/**")).permitAll()); return http.build(); } /** * Configure {@link AccessDeniedHandler} bean. * @return Bean of configured {@link AccessDeniedHandler} */ @Bean("accessDeniedHandler") public AccessDeniedHandler accessDeniedHandler() { LinkedHashMap, AccessDeniedHandler> errorHandlers = new LinkedHashMap<>(); // Invalid CSRF authenticator error handler AccessDeniedHandlerImpl invalidCsrfTokenErrorHandler = new AccessDeniedHandlerImpl(); invalidCsrfTokenErrorHandler.setErrorPage( "/WEB-INF/views/common/error/invalidCsrfTokenError.jsp"); errorHandlers.put(InvalidCsrfTokenException.class, invalidCsrfTokenErrorHandler); // Missing CSRF authenticator error handler AccessDeniedHandlerImpl missingCsrfTokenErrorHandler = new AccessDeniedHandlerImpl(); missingCsrfTokenErrorHandler.setErrorPage( "/WEB-INF/views/common/error/missingCsrfTokenError.jsp"); errorHandlers.put(MissingCsrfTokenException.class, missingCsrfTokenErrorHandler); // Default error handler AccessDeniedHandlerImpl defaultErrorHandler = new AccessDeniedHandlerImpl(); defaultErrorHandler.setErrorPage( "/WEB-INF/views/common/error/accessDeniedError.jsp"); return new DelegatingAccessDeniedHandler(errorHandlers, defaultErrorHandler); } /** * Configure {@link DefaultWebSecurityExpressionHandler} bean. * @return Bean of configured {@link DefaultWebSecurityExpressionHandler} */ @Bean("webSecurityExpressionHandler") public DefaultWebSecurityExpressionHandler webSecurityExpressionHandler() { return new DefaultWebSecurityExpressionHandler(); } /** * Configure {@link UserIdMDCPutFilter} bean. * @return Bean of configured {@link UserIdMDCPutFilter} */ @Bean("userIdMDCPutFilter") public UserIdMDCPutFilter userIdMDCPutFilter() { return new UserIdMDCPutFilter(); } } .. group-tab:: XML Config \ :file:`spring-security.xml`\ には、Spring Securityに関する定義を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/resources/META-INF/spring/spring-security.xml`\ は、以下のような設定となっている。 | なお、本チュートリアルではSpring Securityの設定ファイルの説明は割愛する。Spring Securityの設定ファイルについては、「\ :doc:`./TutorialSecurity`\ 」を参照されたい。 .. code-block:: xml | logback.xml ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ :file:`logback.xml`\ には、ログ出力に関する定義を行う。 | 作成したブランクプロジェクトの\ :file:`src/main/resources/logback.xml`\ は、以下のような設定となっている。 | なお、チュートリアルで使用しないログ設定についての説明は割愛する。 .. code-block:: xml ${app.log.dir:-log}/todo-application.log ${app.log.dir:-log}/todo-application-%d{yyyyMMdd}.log 7 UTF-8 ${app.log.dir:-log}/todo-monitoring.log ${app.log.dir:-log}/todo-monitoring-%d{yyyyMMdd}.log 7 UTF-8 .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 標準出力でログを出力するアペンダを設定。 * - | (2) - | com.example.todoパッケージ以下はdebugレベル以上を出力するように設定。 * - | (3) - | spring-mvc.xmlまたはSpringMvcConfig.javaに設定した\ ``TraceLoggingInterceptor``\ に出力されるようにtraceレベルで設定。 .. note:: O/R Mapperを使用するブランクプロジェクトを作成した場合は、それぞれのO/R Mapperのログを出力するロガーが有効な状態となっている。 * JPA用のブランクプロジェクト .. code-block:: xml * MyBatis3用のブランクプロジェクト .. code-block:: xml .. raw:: latex \newpage