程序包 cn.taketoday.web.handler

类 SimpleHandlerExceptionHandler

java.lang.Object

cn.taketoday.core.OrderedSupport

cn.taketoday.web.handler.AbstractHandlerExceptionHandler

cn.taketoday.web.handler.SimpleHandlerExceptionHandler

所有已实现的接口:

cn.taketoday.core.Ordered, HandlerExceptionHandler

public class SimpleHandlerExceptionHandler
extends AbstractHandlerExceptionHandler
implements HandlerExceptionHandler

The default implementation of the HandlerExceptionHandler interface, resolving standard Framework MVC exceptions and translating them to corresponding HTTP status codes.

This exception handler is enabled by default in the common Framework DispatcherHandler.

Supported Exceptions

Exception	HTTP Status Code
HttpRequestMethodNotSupportedException	405 (SC_METHOD_NOT_ALLOWED)
HttpMediaTypeNotSupportedException	415 (SC_UNSUPPORTED_MEDIA_TYPE)
HttpMediaTypeNotAcceptableException	406 (SC_NOT_ACCEPTABLE)
MissingPathVariableException	500 (SC_INTERNAL_SERVER_ERROR)
MissingServletRequestParameterException	400 (SC_BAD_REQUEST)
MissingRequestPartException	400 (SC_BAD_REQUEST)
ServletRequestBindingException	400 (SC_BAD_REQUEST)
ConversionNotSupportedException	500 (SC_INTERNAL_SERVER_ERROR)
TypeMismatchException	400 (SC_BAD_REQUEST)
HttpMessageNotReadableException	400 (SC_BAD_REQUEST)
HttpMessageNotWritableException	500 (SC_INTERNAL_SERVER_ERROR)
MethodArgumentNotValidException	400 (SC_BAD_REQUEST)
BindException	400 (SC_BAD_REQUEST)
HandlerNotFoundException	404 (SC_NOT_FOUND)
AsyncRequestTimeoutException	503 (SC_SERVICE_UNAVAILABLE)

从以下版本开始:

2020-03-29 21:01

作者:

Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller, Harry Yang

另请参阅:

• ResponseEntityExceptionHandler

字段概要

字段

修饰符和类型	字段	说明
protected static final cn.taketoday.logging.Logger	pageNotFoundLogger	Additional logger to use when no mapped handler is found for a request.

从类继承的字段 cn.taketoday.web.handler.AbstractHandlerExceptionHandler

logger

从类继承的字段 cn.taketoday.core.OrderedSupport

order

从接口继承的字段 cn.taketoday.web.HandlerExceptionHandler

BEAN_NAME, NONE_RETURN_VALUE

从接口继承的字段 cn.taketoday.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
SimpleHandlerExceptionHandler()	Sets the order to Ordered.LOWEST_PRECEDENCE.

方法概要

修饰符和类型	方法	说明
protected Object	handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, RequestContext request, Object handler)	Handle the case where an async request timed out.
protected Object	handleBindException(cn.taketoday.validation.BindException ex, RequestContext request, Object handler)	Handle the case where an argument has binding or validation errors and is not followed by another method argument of type BindingResult.
protected Object	handleConversionNotSupported(cn.taketoday.beans.ConversionNotSupportedException ex, RequestContext request, Object handler)	Handle the case when a WebDataBinder conversion cannot occur.
protected Object	handleErrorResponse(ErrorResponse errorResponse, RequestContext request, Object handler)	Handle an ErrorResponse exception.
protected Object	handleHandlerNotFoundException(HandlerNotFoundException ex, RequestContext request, Object handler)	Handle the case where no handler was found during the dispatch.
protected Object	handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, RequestContext request, Object handler)	Handle the case where no message converters were found that were acceptable for the client (expressed via the Accept header.
protected Object	handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, RequestContext request, Object handler)	Handle the case where no message converters were found for PUT or POSTed content.
protected Object	handleHttpMessageNotReadable(HttpMessageNotReadableException ex, RequestContext request, Object handler)	Handle the case where a message converter cannot read from an HTTP request.
protected Object	handleHttpMessageNotWritable(HttpMessageNotWritableException ex, RequestContext request, Object handler)	Handle the case where a message converter cannot write to an HTTP request.
protected Object	handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, RequestContext request, Object handler)	Handle the case where no handler was found for the HTTP method.
protected Object	handleInternal(RequestContext request, Object handler, Throwable ex)	Actually handle the given exception that got thrown during handler execution, returning a result that represents a specific error page if appropriate.
protected Object	handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, RequestContext request, Object handler)	Handle the case where an argument annotated with @Valid such as an RequestBody or RequestPart argument fails validation.
protected Object	handleMissingPathVariable(MissingPathVariableException ex, RequestContext request, Object handler)	Handle the case when a declared path variable does not match any extracted URI variable.
protected Object	handleMissingRequestPartException(MissingRequestPartException ex, RequestContext request, Object handler)	Handle the case where an @RequestPart, a MultipartFile, or a jakarta.servlet.http.Part argument is required but is missing.
protected Object	handleMissingServletRequestParameter(MissingRequestParameterException ex, RequestContext request, Object handler)	Handle the case when a required parameter is missing.
protected Object	handleRequestBindingException(RequestBindingException ex, RequestContext request, Object handler)	Handle the case when an unrecoverable binding exception occurs - e.g.
protected Object	handleTypeMismatch(cn.taketoday.beans.TypeMismatchException ex, RequestContext request, Object handler)	Handle the case when a WebDataBinder conversion error occurs.
protected void	sendServerError(Exception ex, RequestContext request)	Invoked to send a server error.

从类继承的方法 cn.taketoday.web.handler.AbstractHandlerExceptionHandler

addMappedHandlerClass, buildLogMessage, getMappedHandlerClasses, handleException, hasHandlerMappings, logException, logResultedInException, prepareResponse, preventCaching, setMappedHandlerClasses, setMappedHandlers, setPreventResponseCaching, setWarnLogCategory, shouldApplyTo

从类继承的方法 cn.taketoday.core.OrderedSupport

getOrder, setOrder

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.taketoday.web.HandlerExceptionHandler

handleException

字段详细资料

pageNotFoundLogger

protected static final cn.taketoday.logging.Logger pageNotFoundLogger

Additional logger to use when no mapped handler is found for a request.

另请参阅:

• NotFoundHandler.PAGE_NOT_FOUND_LOG_CATEGORY

构造器详细资料

SimpleHandlerExceptionHandler

public SimpleHandlerExceptionHandler()

Sets the order to Ordered.LOWEST_PRECEDENCE.

方法详细资料

handleInternal

@Nullable
protected Object handleInternal(RequestContext request,
 @Nullable
 Object handler,
 Throwable ex)

从类复制的说明: AbstractHandlerExceptionHandler

Actually handle the given exception that got thrown during handler execution, returning a result that represents a specific error page if appropriate.

May be overridden in subclasses, in order to apply specific exception checks. Note that this template method will be invoked after checking whether this resolved applies ("mappedHandlers" etc), so an implementation may simply proceed with its actual exception handling.

指定者:

handleInternal 在类中 AbstractHandlerExceptionHandler

参数:

request - current HTTP request context

handler - the executed handler, or null if none chosen at the time of the exception (for example, if lookup handler failed)

ex - the exception that got thrown during handler execution

返回:

a corresponding Object view to forward to, or null for default processing in the resolution chain

handleHttpRequestMethodNotSupported

@Nullable
protected Object handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                              throws IOException

Handle the case where no handler was found for the HTTP method.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the HttpRequestMethodNotSupportedException to be handled

request - current HTTP request

handler - the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleHttpMediaTypeNotSupported

@Nullable
protected Object handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                          throws IOException

Handle the case where no message converters were found for PUT or POSTed content.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the HttpMediaTypeNotSupportedException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleHttpMediaTypeNotAcceptable

@Nullable
protected Object handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                           throws IOException

Handle the case where no message converters were found that were acceptable for the client (expressed via the Accept header.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the HttpMediaTypeNotAcceptableException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleMissingPathVariable

@Nullable
protected Object handleMissingPathVariable(MissingPathVariableException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                    throws IOException

Handle the case when a declared path variable does not match any extracted URI variable.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the MissingPathVariableException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleMissingServletRequestParameter

@Nullable
protected Object handleMissingServletRequestParameter(MissingRequestParameterException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                               throws IOException

Handle the case when a required parameter is missing.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the MissingServletRequestParameterException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleMissingRequestPartException

@Nullable
protected Object handleMissingRequestPartException(MissingRequestPartException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                            throws IOException

Handle the case where an @RequestPart, a MultipartFile, or a jakarta.servlet.http.Part argument is required but is missing.

By default, an HTTP 400 error is sent back to the client.

参数:

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleRequestBindingException

@Nullable
protected Object handleRequestBindingException(RequestBindingException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                        throws IOException

Handle the case when an unrecoverable binding exception occurs - e.g. required header, required cookie.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the exception to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleMethodArgumentNotValidException

@Nullable
protected Object handleMethodArgumentNotValidException(MethodArgumentNotValidException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                                throws IOException

Handle the case where an argument annotated with @Valid such as an RequestBody or RequestPart argument fails validation.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleHandlerNotFoundException

@Nullable
protected Object handleHandlerNotFoundException(HandlerNotFoundException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                         throws IOException

Handle the case where no handler was found during the dispatch.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the HandlerNotFoundException to be handled

request - current HTTP request

handler - the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleAsyncRequestTimeoutException

@Nullable
protected Object handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                             throws IOException

Handle the case where an async request timed out.

The default implementation returns null in which case the exception is handled in handleErrorResponse(cn.taketoday.web.ErrorResponse, cn.taketoday.web.RequestContext, java.lang.Object).

参数:

ex - the AsyncRequestTimeoutException to be handled

request - current HTTP request

handler - the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleErrorResponse

protected Object handleErrorResponse(ErrorResponse errorResponse,
 RequestContext request,
 @Nullable
 Object handler)
                              throws IOException

Handle an ErrorResponse exception.

The default implementation sets status and the headers of the response to those obtained from the ErrorResponse. If available, the ProblemDetail.getDetail() is used as the message for RequestContext.sendError(int, String).

参数:

errorResponse - the exception to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleConversionNotSupported

protected Object handleConversionNotSupported(cn.taketoday.beans.ConversionNotSupportedException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                       throws IOException

Handle the case when a WebDataBinder conversion cannot occur.

The default implementation sends an HTTP 500 error, and returns an empty Object. Alternatively, a fallback view could be chosen, or the ConversionNotSupportedException could be rethrown as-is.

参数:

ex - the ConversionNotSupportedException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleTypeMismatch

protected Object handleTypeMismatch(cn.taketoday.beans.TypeMismatchException ex,
 RequestContext request,
 @Nullable
 Object handler)
                             throws IOException

Handle the case when a WebDataBinder conversion error occurs.

The default implementation sends an HTTP 400 error, and returns an empty Object. Alternatively, a fallback view could be chosen, or the TypeMismatchException could be rethrown as-is.

参数:

ex - the TypeMismatchException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleHttpMessageNotReadable

protected Object handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                       throws IOException

Handle the case where a message converter cannot read from an HTTP request.

The default implementation sends an HTTP 400 error, and returns an empty Object. Alternatively, a fallback view could be chosen, or the HttpMessageNotReadableException could be rethrown as-is.

参数:

ex - the HttpMessageNotReadableException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleHttpMessageNotWritable

protected Object handleHttpMessageNotWritable(HttpMessageNotWritableException ex,
 RequestContext request,
 @Nullable
 Object handler)
                                       throws IOException

Handle the case where a message converter cannot write to an HTTP request.

The default implementation sends an HTTP 500 error, and returns an empty Object. Alternatively, a fallback view could be chosen, or the HttpMessageNotWritableException could be rethrown as-is.

参数:

ex - the HttpMessageNotWritableException to be handled

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

handleBindException

protected Object handleBindException(cn.taketoday.validation.BindException ex,
 RequestContext request,
 @Nullable
 Object handler)
                              throws IOException

Handle the case where an argument has binding or validation errors and is not followed by another method argument of type BindingResult.

By default, an HTTP 400 error is sent back to the client.

参数:

request - current HTTP request

handler - the executed handler

返回:

an empty Object indicating the exception was handled

抛出:

IOException - potentially thrown from RequestContext.sendError(cn.taketoday.http.HttpStatusCode)

从以下版本开始:

4.0

sendServerError

protected void sendServerError(Exception ex,
 RequestContext request)
                        throws IOException

Invoked to send a server error. Sets the status to 500 and also sets the request attribute WebUtils.ERROR_EXCEPTION_ATTRIBUTE to the Exception.

抛出:

IOException

从以下版本开始:

4.0

另请参阅:

• WebUtils.ERROR_EXCEPTION_ATTRIBUTE