ResponseEntityExceptionHandler (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

```
public abstract class ResponseEntityExceptionHandler
extends ObjectSE
```
@ExceptionHandler メソッドから @RequestMapping メソッドまでのすべての @RequestMapping メソッドで一元化された例外処理を提供したい @ControllerAdvice クラスの便利な基本クラス。
この基本クラスは、内部 Spring MVC 例外を処理するための @ExceptionHandler メソッドを提供します。このメソッドは、ModelAndView を返す DefaultHandlerExceptionResolver とは対照的に、message converter でレスポンスに書き込むために ResponseEntity を返します。
エラーコンテンツをレスポンス本文に書き込む必要がない場合、または（ContentNegotiatingViewResolver などを介して）ビューリゾルバーを使用する場合は、DefaultHandlerExceptionResolver で十分です。
@ControllerAdvice サブクラスを検出するには、ExceptionHandlerExceptionResolver を構成する必要があることに注意してください。
導入:
3.2
作成者:
Rossen Stoyanchev
関連事項:
handleException(Exception, WebRequest), DefaultHandlerExceptionResolver

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger` サブクラスで使用する共通のロガー。
`static StringSE`	`PAGE_NOT_FOUND_LOG_CATEGORY` リクエストに対してマップされたハンドラーが見つからない場合に使用するログカテゴリ。
`protected static Log`	`pageNotFoundLogger` リクエストに対してマッピングされたハンドラーが見つからない場合に使用する特定のロガー。

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
ResponseEntityExceptionHandler()

コンストラクター
コンストラクターと説明
`ResponseEntityExceptionHandler()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ResponseEntity<ObjectSE>`	`handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatus status, WebRequest webRequest)` AsyncRequestTimeoutException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleBindException(BindException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` BindException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleConversionNotSupported(ConversionNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` ConversionNotSupportedException のレスポンスをカスタマイズします。
`ResponseEntity<ObjectSE>`	`handleException(ExceptionSE ex, WebRequest request)` 標準 Spring MVC 例外の処理を提供します。
`protected ResponseEntity<ObjectSE>`	`handleExceptionInternal(ExceptionSE ex, ObjectSE body, HttpHeaders headers, HttpStatus status, WebRequest request)` すべての例外型のレスポンス本文をカスタマイズする単一の場所。
`protected ResponseEntity<ObjectSE>`	`handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` HttpMediaTypeNotAcceptableException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` HttpMediaTypeNotSupportedException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` HttpMessageNotReadableException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` HttpMessageNotWritableException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` HttpRequestMethodNotSupportedException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` MethodArgumentNotValidException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` MissingPathVariableException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` MissingServletRequestParameterException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleMissingServletRequestPart(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` MissingServletRequestPartException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` NoHandlerFoundException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleServletRequestBindingException(ServletRequestBindingException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` ServletRequestBindingException のレスポンスをカスタマイズします。
`protected ResponseEntity<ObjectSE>`	`handleTypeMismatch(TypeMismatchException ex, HttpHeaders headers, HttpStatus status, WebRequest request)` TypeMismatchException のレスポンスをカスタマイズします。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

フィールドの詳細
- PAGE_NOT_FOUND_LOG_CATEGORY
```
public static final StringSE PAGE_NOT_FOUND_LOG_CATEGORY
```
  リクエストに対してマップされたハンドラーが見つからない場合に使用するログカテゴリ。
  関連事項:
  pageNotFoundLogger, 定数フィールド値
- pageNotFoundLogger
```
protected static final Log pageNotFoundLogger
```
  リクエストに対してマッピングされたハンドラーが見つからない場合に使用する特定のロガー。
  関連事項:
  PAGE_NOT_FOUND_LOG_CATEGORY
- logger
```
protected final Log logger
```
  サブクラスで使用する共通のロガー。

コンストラクターの詳細
- ResponseEntityExceptionHandler
```
public ResponseEntityExceptionHandler()
```

メソッドの詳細

handleException

@ExceptionHandler(value={HttpRequestMethodNotSupportedException.class,HttpMediaTypeNotSupportedException.class,HttpMediaTypeNotAcceptableException.class,MissingPathVariableException.class,MissingServletRequestParameterException.class,ServletRequestBindingException.class,ConversionNotSupportedException.class,TypeMismatchException.class,HttpMessageNotReadableException.class,HttpMessageNotWritableException.class,MethodArgumentNotValidException.class,MissingServletRequestPartException.class,BindException.class,NoHandlerFoundException.class,AsyncRequestTimeoutException.class})
 @Nullable
public final ResponseEntity<ObjectSE> handleException(ExceptionSE ex,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WebRequest request)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ExceptionSE

標準 Spring MVC 例外の処理を提供します。

パラメーター:: ex - ターゲット例外; request - 現在のリクエスト
例外:: ExceptionSE

handleHttpRequestMethodNotSupported
```
protected ResponseEntity<ObjectSE> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex,
                                                                     HttpHeaders headers,
                                                                     HttpStatus status,
                                                                     WebRequest request)
```
HttpRequestMethodNotSupportedException のレスポンスをカスタマイズします。
このメソッドは警告をログに記録し、"Allow" ヘッダーを設定し、handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleHttpMediaTypeNotSupported
```
protected ResponseEntity<ObjectSE> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
                                                                 HttpHeaders headers,
                                                                 HttpStatus status,
                                                                 WebRequest request)
```
HttpMediaTypeNotSupportedException のレスポンスをカスタマイズします。
このメソッドは、"Accept" ヘッダーを設定し、デリゲートを handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に設定します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleHttpMediaTypeNotAcceptable

protected ResponseEntity<ObjectSE> handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex,
                                                                  HttpHeaders headers,
                                                                  HttpStatus status,
                                                                  WebRequest request)

HttpMediaTypeNotAcceptableException のレスポンスをカスタマイズします。

このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。

パラメーター:: ex - 例外; headers - レスポンスに書き込まれるヘッダー; status - 選択したレスポンスステータス; request - 現在のリクエスト
戻り値:: ResponseEntity インスタンス

handleMissingPathVariable
```
protected ResponseEntity<ObjectSE> handleMissingPathVariable(MissingPathVariableException ex,
                                                           HttpHeaders headers,
                                                           HttpStatus status,
                                                           WebRequest request)
```
MissingPathVariableException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス
導入:
4.2

handleMissingServletRequestParameter

protected ResponseEntity<ObjectSE> handleMissingServletRequestParameter(MissingServletRequestParameterException ex,
                                                                      HttpHeaders headers,
                                                                      HttpStatus status,
                                                                      WebRequest request)

MissingServletRequestParameterException のレスポンスをカスタマイズします。

パラメーター:: ex - 例外; headers - レスポンスに書き込まれるヘッダー; status - 選択したレスポンスステータス; request - 現在のリクエスト
戻り値:: ResponseEntity インスタンス

handleServletRequestBindingException

protected ResponseEntity<ObjectSE> handleServletRequestBindingException(ServletRequestBindingException ex,
                                                                      HttpHeaders headers,
                                                                      HttpStatus status,
                                                                      WebRequest request)

ServletRequestBindingException のレスポンスをカスタマイズします。

パラメーター:: ex - 例外; headers - レスポンスに書き込まれるヘッダー; status - 選択したレスポンスステータス; request - 現在のリクエスト
戻り値:: ResponseEntity インスタンス

handleConversionNotSupported
```
protected ResponseEntity<ObjectSE> handleConversionNotSupported(ConversionNotSupportedException ex,
                                                              HttpHeaders headers,
                                                              HttpStatus status,
                                                              WebRequest request)
```
ConversionNotSupportedException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleTypeMismatch
```
protected ResponseEntity<ObjectSE> handleTypeMismatch(TypeMismatchException ex,
                                                    HttpHeaders headers,
                                                    HttpStatus status,
                                                    WebRequest request)
```
TypeMismatchException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleHttpMessageNotReadable
```
protected ResponseEntity<ObjectSE> handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
                                                              HttpHeaders headers,
                                                              HttpStatus status,
                                                              WebRequest request)
```
HttpMessageNotReadableException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleHttpMessageNotWritable
```
protected ResponseEntity<ObjectSE> handleHttpMessageNotWritable(HttpMessageNotWritableException ex,
                                                              HttpHeaders headers,
                                                              HttpStatus status,
                                                              WebRequest request)
```
HttpMessageNotWritableException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleMethodArgumentNotValid
```
protected ResponseEntity<ObjectSE> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
                                                              HttpHeaders headers,
                                                              HttpStatus status,
                                                              WebRequest request)
```
MethodArgumentNotValidException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleMissingServletRequestPart

protected ResponseEntity<ObjectSE> handleMissingServletRequestPart(MissingServletRequestPartException ex,
                                                                 HttpHeaders headers,
                                                                 HttpStatus status,
                                                                 WebRequest request)

MissingServletRequestPartException のレスポンスをカスタマイズします。

パラメーター:: ex - 例外; headers - レスポンスに書き込まれるヘッダー; status - 選択したレスポンスステータス; request - 現在のリクエスト
戻り値:: ResponseEntity インスタンス

handleBindException
```
protected ResponseEntity<ObjectSE> handleBindException(BindException ex,
                                                     HttpHeaders headers,
                                                     HttpStatus status,
                                                     WebRequest request)
```
BindException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス

handleNoHandlerFoundException
```
protected ResponseEntity<ObjectSE> handleNoHandlerFoundException(NoHandlerFoundException ex,
                                                               HttpHeaders headers,
                                                               HttpStatus status,
                                                               WebRequest request)
```
NoHandlerFoundException のレスポンスをカスタマイズします。
このメソッドは handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest) に委譲します。
パラメーター:
ex - 例外
headers - レスポンスに書き込まれるヘッダー
status - 選択したレスポンスステータス
request - 現在のリクエスト
戻り値:
ResponseEntity インスタンス
導入:
4.0

handleAsyncRequestTimeoutException

@Nullable
protected ResponseEntity<ObjectSE> handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
                                                                              HttpHeaders headers,
                                                                              HttpStatus status,
                                                                              WebRequest webRequest)

AsyncRequestTimeoutException のレスポンスをカスタマイズします。

パラメーター:: ex - 例外; headers - レスポンスに書き込まれるヘッダー; status - 選択したレスポンスステータス; webRequest - 現在のリクエスト
戻り値:: ResponseEntity インスタンス
導入:: 4.2.8

handleExceptionInternal

protected ResponseEntity<ObjectSE> handleExceptionInternal(ExceptionSE ex,
                                                         @Nullable
                                                         ObjectSE body,
                                                         HttpHeaders headers,
                                                         HttpStatus status,
                                                         WebRequest request)

すべての例外型のレスポンス本文をカスタマイズする単一の場所。

デフォルトの実装では、WebUtils.ERROR_EXCEPTION_ATTRIBUTE リクエスト属性を設定し、指定された本文、ヘッダー、ステータスから ResponseEntity を作成します。

パラメーター:: ex - 例外; body - レスポンスの本文; headers - レスポンスのヘッダー; status - レスポンスステータス; request - 現在のリクエスト

クラス ResponseEntityExceptionHandler

フィールドサマリー

コンストラクターのサマリー

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

PAGE_NOT_FOUND_LOG_CATEGORY

pageNotFoundLogger

logger

コンストラクターの詳細

ResponseEntityExceptionHandler

メソッドの詳細

handleException

handleHttpRequestMethodNotSupported

handleHttpMediaTypeNotSupported

handleHttpMediaTypeNotAcceptable

handleMissingPathVariable

handleMissingServletRequestParameter

handleServletRequestBindingException

handleConversionNotSupported

handleTypeMismatch

handleHttpMessageNotReadable

handleHttpMessageNotWritable

handleMethodArgumentNotValid

handleMissingServletRequestPart

handleBindException

handleNoHandlerFoundException

handleAsyncRequestTimeoutException

handleExceptionInternal