`` とその配下の要素が実行される。
* - | (3)
- | SystemExceptionResolverで設定した属性名のオブジェクトに格納された ``message`` 変数を、Thymeleafのメッセージ式 ``#messages`` を使用して繰り返し取得し、出力する。
例外コード(メッセージID)の属性名
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
| デフォルトの属性名をアプリケーションコードで使用している場合は、重複を避けるために、別の値を設定すること。重複がない場合は、デフォルト値を変更する必要はない。
| 下記は、デフォルト値から、「exceptionCodeForExceptionResolver」に変更する場合の、設定&実装例である。
- **spring-mvc.xml**
.. code-block:: xml
- **html**
.. code-block:: html
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (1)
- | 例外コード(メッセージID)の属性名(exceptionCodeAttribute)に、"exceptionCodeForExceptionResolver"を指定する。
* - | (2)
- | SystemExceptionResolverに設定した値(exceptionCodeForExceptionResolver)を、テスト対象(空チェック対応)の変数名として指定する。
| 例外コード(メッセージID)が存在する場合の出力時に、SystemExceptionResolverに設定した値(exceptionCodeForExceptionResolver)を、出力対象の変数名として指定する。
例外コード(メッセージID)のヘッダ名
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
| デフォルトのヘッダ名が使用されている場合、重複を避けるために、別の値を設定すること。重複がない場合は、デフォルト値を変更する必要はない。
| 下記は、デフォルト値から「X-Exception-Code-ForExceptionResolver」に変更する場合の、設定&実装例である。
- **spring-mvc.xml**
.. code-block:: xml
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (1)
- | 例外コード(メッセージID)のヘッダ名(exceptionCodeHeader)に、"X-Exception-Code-ForExceptionResolver"を指定する。
例外オブジェクトの属性名
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
| デフォルトの属性名をアプリケーションコードで使用している場合は、重複を避けるために、別の値を設定すること。重複がない場合は、デフォルト値を変更する必要はない。
| 下記は、デフォルト値から「exceptionForExceptionResolver」に変更する場合の、設定&実装例である。
- **spring-mvc.xml**
.. code-block:: xml
- **html**
.. code-block:: html
[Exception Message]
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (1)
- | 例外オブジェクトの属性名(exceptionAttribute)に、"exceptionForExceptionResolver"を指定する。
* - | (2)
- | SystemExceptionResolverに設定した値(exceptionForExceptionResolver)を、例外オブジェクトからメッセージを取得するための変数名として、指定する。
.. _exception-handling-http-response-cache:
HTTPレスポンスのキャッシュ制御有無
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
| HTTPレスポンスに、キャッシュ制御用のヘッダを追加したい場合は、true:有を指定する。
- **spring-mvc.xml**
.. code-block:: xml
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (1)
- | HTTPレスポンスのキャッシュ制御有無(preventResponseCaching)に、true:有を指定する。
.. note:: **有を指定した場合のHTTPレスポンスヘッダ**
HTTPレスポンスのキャッシュ制御有無を有にすると、以下のHTTPレスポンスヘッダが出力される。
| Cache-Control:no-store
\ ``SystemExceptionResolver``\によるキャッシュ制御用のヘッダ追加はブラウザキャッシュによる意図しないエラー画面の表示を抑止するためのオプションであるが、Spring Securityの機能を使用してセキュリティの観点からキャッシュ制御用のヘッダを追加することも可能である。
Spring Securityの機能については、:ref:`SpringSecurityLinkageWithBrowser`\を参照されたい。
.. warning:: **SpringSecurityのCache-Controlヘッダを利用する場合の注意点**
\ ``SystemExceptionResolver``\のキャッシュ制御とSpring SecurityのCache-Controlヘッダを有効にした場合、\ ``SystemExceptionResolver``\のキャッシュ制御が優先される。
これにより、正常時はSpring Securityでは\ ``no-store``\以外も付与されるが、例外時は\ ``no-store``\のみ付与されるため、意図したとおりにキャッシュを制御できない恐れがあることに注意されたい。
.. _exception-handling-about-handlerexceptionresolverlogginginterceptor:
HandlerExceptionResolverLoggingInterceptorの設定項目について
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
本編で説明していない設定項目について、説明する。
要件に応じて、設定を行うこと。
.. tabularcolumns:: |p{0.05\linewidth}|p{0.15\linewidth}|p{0.15\linewidth}|p{0.45\linewidth}|p{0.20\linewidth}|
.. list-table:: **本編で説明していない設定項目一覧**
:header-rows: 1
:widths: 5 15 15 45 20
* - 項番
- 項目名
- プロパティ名
- 説明
- デフォルト値
* - | (1)
- | ログ出力対象から除外する例外クラスの一覧
- | ignoreExceptions
- | ``HandlerExceptionResolver`` によってハンドリングされた例外のうち、ログ出力しない例外クラスをリスト形式で指定する。
| 指定した例外クラス及びサブクラスの例外が発生した場合、 本クラスでログの出力は行われない。
| 本項目に指定する例外クラスは、別の場所(別の仕組み)でログ出力される例外のみ指定すること。
- | ``ResultMessagesNotificationException.class``
|
| ``ResultMessagesNotificationException.class`` 及びサブクラスの例外は、 ``ResultMessagesLoggingInterceptor`` でログ出力されるため、デフォルト設定として除外している。
ログ出力対象から除外する例外クラスの一覧
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
プロジェクトで用意した例外クラスをログ出力対象から除外したい場合は、以下のような設定となる。
- **spring-mvc.xml**
.. code-block:: xml
org.terasoluna.gfw.common.exception.ResultMessagesNotificationException
com.example.common.XxxException
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (1)
- | 共通ライブラリのデフォルト設定で指定されている ``ResultMessagesNotificationException`` を除外対象に指定する。
* - | (2)
- | プロジェクトで用意した例外クラスを除外対象に指定する。
|
全ての例外クラスをログ出力対象とする場合は、以下のような設定となる。
- **spring-mvc.xml**
.. code-block:: xml
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 90
* - 項番
- 説明
* - | (3)
- | ignoreExceptionsプロパティに ``null`` を指定する。
| ``null`` を指定すると、全ての例外クラスがログ出力対象となる。
.. _exception-handling-appendix-defaulthandlerexceptionresolver-label:
DefaultHandlerExceptionResolverで設定されるHTTPレスポンスコードについて
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
DefaultHandlerExceptionResolverでハンドリングされるフレームワーク例外と、HTTPステータスコードのマッピングを、以下に記載する。
.. tabularcolumns:: |p{0.10\linewidth}|p{0.60\linewidth}|p{0.20\linewidth}|
.. list-table::
:header-rows: 1
:widths: 10 60 20
:class: longtable
* - 項番
- ハンドリングされるフレームワーク例外
- HTTPステータスコード
* - | (1)
- | org.springframework.web.servlet.mvc.multiaction.NoSuchRequestHandlingMethodException
- | 404
* - | (2)
- | org.springframework.web.HttpRequestMethodNotSupportedException
- | 405
* - | (3)
- | org.springframework.web.HttpMediaTypeNotSupportedException
- | 415
* - | (4)
- | org.springframework.web.HttpMediaTypeNotAcceptableException
- | 406
* - | (5)
- | org.springframework.web.bind.MissingPathVariableException
- | 500
* - | (6)
- | org.springframework.web.bind.MissingServletRequestParameterException
- | 400
* - | (7)
- | org.springframework.web.bind.ServletRequestBindingException
- | 400
* - | (8)
- | org.springframework.beans.ConversionNotSupportedException
- | 500
* - | (9)
- | org.springframework.beans.TypeMismatchException
- | 400
* - | (10)
- | org.springframework.http.converter.HttpMessageNotReadableException
- | 400
* - | (11)
- | org.springframework.http.converter.HttpMessageNotWritableException
- | 500
* - | (12).
- | org.springframework.web.bind.MethodArgumentNotValidException
- | 400
* - | (13)
- | org.springframework.web.multipart.support.MissingServletRequestPartException
- | 400
* - | (14)
- | org.springframework.validation.BindException
- | 400
* - | (15)
- | org.springframework.web.servlet.NoHandlerFoundException
- | 404
* - | (16)
- | org.springframework.web.context.request.async.AsyncRequestTimeoutException
- | 503
.. raw:: latex
\newpage