cn.taketoday.web.handler.ResponseEntityExceptionHandler

public class ResponseEntityExceptionHandler extends Object

A convenient base class for @ControllerAdvice classes that wish to provide centralized exception handling across all @RequestMapping methods through @ExceptionHandler methods.

This base class provides an @ExceptionHandler method for handling internal Framework MVC exceptions. This method returns a ResponseEntity for writing to the response with a message converter, in contrast to SimpleHandlerExceptionHandler which returns a ModelAndView.

If there is no need to write error content to the response body, or when using view resolution (e.g., via ContentNegotiatingViewResolver), then DefaultHandlerExceptionHandler is good enough.

Note that in order for an @ControllerAdvice subclass to be detected, HandlerExceptionHandler must be configured.

从以下版本开始:

4.0 2022/3/2 18:12

作者:

Rossen Stoyanchev, Harry Yang

另请参阅:

字段概要

字段

修饰符和类型

字段

说明

protected final cn.taketoday.logging.Logger

logger

Common logger for use in subclasses.

static final String

PAGE_NOT_FOUND_LOG_CATEGORY

Log category to use when no mapped handler is found for a request.

protected static final cn.taketoday.logging.Logger

pageNotFoundLogger

Specific logger to use when no mapped handler is found for a request.
构造器概要

构造器

构造器

说明

ResponseEntityExceptionHandler()
方法概要

修饰符和类型

方法

说明

protected ResponseEntity<Object>

createResponseEntity(Object body, HttpHeaders headers, HttpStatusCode statusCode, RequestContext request)

Create the ResponseEntity to use from the given body, headers, and statusCode.

protected ResponseEntity<Object>

handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of AsyncRequestTimeoutException.

protected ResponseEntity<Object>

handleBindException(cn.taketoday.validation.BindException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of BindException.

protected ResponseEntity<Object>

handleConversionNotSupported(cn.taketoday.beans.ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of ConversionNotSupportedException.

protected ResponseEntity<Object>

handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of any ErrorResponseException.

final ResponseEntity<Object>

handleException(Exception ex, RequestContext request)

Provides handling for standard Framework MVC exceptions.

protected ResponseEntity<Object>

handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatusCode statusCode, RequestContext request)

Internal handler method that all others in this class delegate to, for common handling, and for the creation of a ResponseEntity.

protected ResponseEntity<Object>

handleHandlerNotFoundException(HandlerNotFoundException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HandlerNotFoundException.

protected ResponseEntity<Object>

handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HttpMediaTypeNotAcceptableException.

protected ResponseEntity<Object>

handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HttpMediaTypeNotSupportedException.

protected ResponseEntity<Object>

handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HttpMessageNotReadableException.

protected ResponseEntity<Object>

handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HttpMessageNotWritableException.

protected ResponseEntity<Object>

handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of HttpRequestMethodNotSupportedException.

protected ResponseEntity<Object>

handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of MethodArgumentNotValidException.

protected ResponseEntity<Object>

handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of MissingPathVariableException.

protected ResponseEntity<Object>

handleMissingRequestParameter(MissingRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of MissingRequestParameterException.

protected ResponseEntity<Object>

handleMissingRequestPart(MissingRequestPartException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of MissingRequestPartException.

protected ResponseEntity<Object>

handleRequestBindingException(RequestBindingException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of RequestBindingException.

protected ResponseEntity<Object>

handleTypeMismatch(cn.taketoday.beans.TypeMismatchException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)

Customize the handling of TypeMismatchException.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料
- PAGE_NOT_FOUND_LOG_CATEGORY
  
  public static final String PAGE_NOT_FOUND_LOG_CATEGORY
  
  Log category to use when no mapped handler is found for a request.
  另请参阅:
  
  pageNotFoundLogger
  
  常量字段值
- pageNotFoundLogger
  
  protected static final cn.taketoday.logging.Logger pageNotFoundLogger
  
  Specific logger to use when no mapped handler is found for a request.
  另请参阅:
  
  PAGE_NOT_FOUND_LOG_CATEGORY
- logger
  
  protected final cn.taketoday.logging.Logger logger
  
  Common logger for use in subclasses.
构造器详细资料
- ResponseEntityExceptionHandler
  
  public ResponseEntityExceptionHandler()
方法详细资料
- handleException
  
  @ExceptionHandler({HttpRequestMethodNotSupportedException.class,HttpMediaTypeNotSupportedException.class,HttpMediaTypeNotAcceptableException.class,MissingPathVariableException.class,MissingRequestParameterException.class,MissingRequestPartException.class,RequestBindingException.class,MethodArgumentNotValidException.class,HandlerNotFoundException.class,AsyncRequestTimeoutException.class,ErrorResponseException.class,cn.taketoday.beans.ConversionNotSupportedException.class,cn.taketoday.beans.TypeMismatchException.class,HttpMessageNotReadableException.class,HttpMessageNotWritableException.class,cn.taketoday.validation.BindException.class}) @Nullable public final ResponseEntity<Object> handleException(Exception ex, RequestContext request) throws Exception
  
  Provides handling for standard Framework MVC exceptions.
  
  参数:
  
  ex - the target exception
  
  request - the current request
  
  抛出:
  
  Exception
- handleHttpRequestMethodNotSupported
  
  @Nullable protected ResponseEntity<Object> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HttpRequestMethodNotSupportedException.
  This method logs a warning and delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleHttpMediaTypeNotSupported
  
  @Nullable protected ResponseEntity<Object> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HttpMediaTypeNotSupportedException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleHttpMediaTypeNotAcceptable
  
  @Nullable protected ResponseEntity<Object> handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HttpMediaTypeNotAcceptableException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleMissingPathVariable
  
  @Nullable protected ResponseEntity<Object> handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of MissingPathVariableException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleMissingRequestParameter
  
  @Nullable protected ResponseEntity<Object> handleMissingRequestParameter(MissingRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of MissingRequestParameterException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleMissingRequestPart
  
  @Nullable protected ResponseEntity<Object> handleMissingRequestPart(MissingRequestPartException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of MissingRequestPartException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleRequestBindingException
  
  @Nullable protected ResponseEntity<Object> handleRequestBindingException(RequestBindingException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of RequestBindingException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleMethodArgumentNotValid
  
  @Nullable protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of MethodArgumentNotValidException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to be written to the response
  
  status - the selected response status
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleHandlerNotFoundException
  
  @Nullable protected ResponseEntity<Object> handleHandlerNotFoundException(HandlerNotFoundException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HandlerNotFoundException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
  
  从以下版本开始:
  
  4.0
- handleAsyncRequestTimeoutException
  
  @Nullable protected ResponseEntity<Object> handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of AsyncRequestTimeoutException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleErrorResponseException
  
  @Nullable protected ResponseEntity<Object> handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of any ErrorResponseException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleConversionNotSupported
  
  @Nullable protected ResponseEntity<Object> handleConversionNotSupported(cn.taketoday.beans.ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of ConversionNotSupportedException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleTypeMismatch
  
  @Nullable protected ResponseEntity<Object> handleTypeMismatch(cn.taketoday.beans.TypeMismatchException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of TypeMismatchException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleHttpMessageNotReadable
  
  @Nullable protected ResponseEntity<Object> handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HttpMessageNotReadableException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleHttpMessageNotWritable
  
  @Nullable protected ResponseEntity<Object> handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of HttpMessageNotWritableException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleBindException
  
  @Nullable protected ResponseEntity<Object> handleBindException(cn.taketoday.validation.BindException ex, HttpHeaders headers, HttpStatusCode status, RequestContext request)
  
  Customize the handling of BindException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, cn.taketoday.http.HttpHeaders, cn.taketoday.http.HttpStatusCode, cn.taketoday.web.RequestContext).
  
  参数:
  
  ex - the exception to handle
  
  headers - the headers to use for the response
  
  status - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- handleExceptionInternal
  
  @Nullable protected ResponseEntity<Object> handleExceptionInternal(Exception ex, @Nullable Object body, HttpHeaders headers, HttpStatusCode statusCode, RequestContext request)
  Internal handler method that all others in this class delegate to, for common handling, and for the creation of a ResponseEntity.
  The default implementation does the following:
  
  return null if response is already committed
  set the "jakarta.servlet.error.exception" request attribute if the response status is 500 (INTERNAL_SERVER_ERROR).
  extract the body from ErrorResponse exceptions, if the body is null.
  参数:
  
  ex - the exception to handle
  
  body - the body to use for the response
  
  headers - the headers to use for the response
  
  statusCode - the status code to use for the response
  
  request - the current request
  
  返回:
  
  a ResponseEntity for the response to use, possibly null when the response is already committed
- createResponseEntity
  
  protected ResponseEntity<Object> createResponseEntity(@Nullable Object body, HttpHeaders headers, HttpStatusCode statusCode, RequestContext request)
  
  Create the ResponseEntity to use from the given body, headers, and statusCode. Subclasses can override this method to inspect and possibly modify the body, headers, or statusCode, e.g. to re-create an instance of ProblemDetail as an extension of ProblemDetail.
  
  参数:
  
  body - the body to use for the response
  
  headers - the headers to use for the response
  
  statusCode - the status code to use for the response
  
  request - the current request
  
  返回:
  
  the ResponseEntity instance to use

类 ResponseEntityExceptionHandler

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

PAGE_NOT_FOUND_LOG_CATEGORY

pageNotFoundLogger

logger

构造器详细资料

ResponseEntityExceptionHandler

方法详细资料

handleException

handleHttpRequestMethodNotSupported

handleHttpMediaTypeNotSupported

handleHttpMediaTypeNotAcceptable

handleMissingPathVariable

handleMissingRequestParameter

handleMissingRequestPart

handleRequestBindingException

handleMethodArgumentNotValid

handleHandlerNotFoundException

handleAsyncRequestTimeoutException

handleErrorResponseException

handleConversionNotSupported

handleTypeMismatch

handleHttpMessageNotReadable

handleHttpMessageNotWritable

handleBindException

handleExceptionInternal

createResponseEntity