类 AbstractHandlerExceptionResolver
- java.lang.Object
- org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver
- 所有已实现的接口:
Ordered
,HandlerExceptionResolver
- 直接已知子类:
AbstractHandlerMethodExceptionResolver
,DefaultHandlerExceptionResolver
,ResponseStatusExceptionResolver
,SimpleMappingExceptionResolver
public abstract class AbstractHandlerExceptionResolver extends Object implements HandlerExceptionResolver, Ordered
Abstract base class forHandlerExceptionResolver
implementations.Supports mapped handlers and handler classes that the resolver should be applied to and implements the
Ordered
interface.- 从以下版本开始:
- 3.0
- 作者:
- Arjen Poutsma, Juergen Hoeller, Sam Brannen
字段概要
从接口继承的字段 org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
构造器概要
构造器 构造器 说明 AbstractHandlerExceptionResolver()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 protected String
buildLogMessage(Exception ex, HttpServletRequest request)
Build a log message for the given exception, occurred during processing the given request.protected abstract ModelAndView
doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
Actually resolve the given exception that got thrown during handler execution, returning aModelAndView
that represents a specific error page if appropriate.int
getOrder()
Get the order value of this object.protected void
logException(Exception ex, HttpServletRequest request)
Log the given exception at warn level, provided that warn logging has been activated through the"warnLogCategory"
property.protected void
prepareResponse(Exception ex, HttpServletResponse response)
Prepare the response for the exceptional case.protected void
preventCaching(HttpServletResponse response)
Prevents the response from being cached, through setting corresponding HTTPCache-Control: no-store
header.ModelAndView
resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
Check whether this resolver is supposed to apply (i.e. if the supplied handler matches any of the configured handlers or handler classes), and then delegate to thedoResolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception)
template method.void
setMappedHandlerClasses(Class<?>... mappedHandlerClasses)
Specify the set of classes that this exception resolver should apply to.void
setMappedHandlers(Set<?> mappedHandlers)
Specify the set of handlers that this exception resolver should apply to.void
setOrder(int order)
void
setPreventResponseCaching(boolean preventResponseCaching)
Specify whether to prevent HTTP response caching for any view resolved by this exception resolver.void
setWarnLogCategory(String loggerName)
Set the log category for warn logging.protected boolean
shouldApplyTo(HttpServletRequest request, Object handler)
Check whether this resolver is supposed to apply to the given handler.
构造器详细资料
AbstractHandlerExceptionResolver
public AbstractHandlerExceptionResolver()
方法详细资料
setOrder
public void setOrder(int order)
getOrder
public int getOrder()
从接口复制的说明:Ordered
Get the order value of this object.Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet
load-on-startup
values).Same order values will result in arbitrary sort positions for the affected objects.
- 指定者:
getOrder
在接口中Ordered
- 返回:
- the order value
- 另请参阅:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
setMappedHandlers
public void setMappedHandlers(Set<?> mappedHandlers)
Specify the set of handlers that this exception resolver should apply to.The exception mappings and the default error view will only apply to the specified handlers.
If no handlers or handler classes are set, the exception mappings and the default error view will apply to all handlers. This means that a specified default error view will be used as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
setMappedHandlerClasses
public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses)
Specify the set of classes that this exception resolver should apply to.The exception mappings and the default error view will only apply to handlers of the specified types; the specified types may be interfaces or superclasses of handlers as well.
If no handlers or handler classes are set, the exception mappings and the default error view will apply to all handlers. This means that a specified default error view will be used as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
setWarnLogCategory
public void setWarnLogCategory(String loggerName)
Set the log category for warn logging. The name will be passed to the underlying logger implementation through Commons Logging, getting interpreted as a log category according to the logger's configuration. Ifnull
or empty String is passed, warn logging is turned off.By default there is no warn logging although subclasses like
DefaultHandlerExceptionResolver
can change that default. Specify this setting to activate warn logging into a specific category. Alternatively, override thelogException(java.lang.Exception, javax.servlet.http.HttpServletRequest)
method for custom logging.
setPreventResponseCaching
public void setPreventResponseCaching(boolean preventResponseCaching)
Specify whether to prevent HTTP response caching for any view resolved by this exception resolver.Default is
false
. Switch this totrue
in order to automatically generate HTTP response headers that suppress response caching.
resolveException
@Nullable public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex)
Check whether this resolver is supposed to apply (i.e. if the supplied handler matches any of the configured handlers or handler classes), and then delegate to thedoResolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception)
template method.- 指定者:
resolveException
在接口中HandlerExceptionResolver
- 参数:
request
- current HTTP requestresponse
- current HTTP responsehandler
- the executed handler, ornull
if none chosen at the time of the exception (for example, if multipart resolution failed)ex
- the exception that got thrown during handler execution- 返回:
- a corresponding
ModelAndView
to forward to, ornull
for default processing in the resolution chain
shouldApplyTo
protected boolean shouldApplyTo(HttpServletRequest request, @Nullable Object handler)
Check whether this resolver is supposed to apply to the given handler.The default implementation checks against the configured handlers and handler classes, if any.
- 参数:
request
- current HTTP requesthandler
- the executed handler, ornull
if none chosen at the time of the exception (for example, if multipart resolution failed)- 返回:
- whether this resolved should proceed with resolving the exception for the given request and handler
- 另请参阅:
setMappedHandlers(java.util.Set<?>)
,setMappedHandlerClasses(java.lang.Class<?>...)
logException
protected void logException(Exception ex, HttpServletRequest request)
Log the given exception at warn level, provided that warn logging has been activated through the"warnLogCategory"
property.Calls
buildLogMessage(java.lang.Exception, javax.servlet.http.HttpServletRequest)
in order to determine the concrete message to log.- 参数:
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)- 另请参阅:
setWarnLogCategory(java.lang.String)
,buildLogMessage(java.lang.Exception, javax.servlet.http.HttpServletRequest)
,Log.warn(Object, Throwable)
buildLogMessage
protected String buildLogMessage(Exception ex, HttpServletRequest request)
Build a log message for the given exception, occurred during processing the given request.- 参数:
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)- 返回:
- the log message to use
prepareResponse
protected void prepareResponse(Exception ex, HttpServletResponse response)
Prepare the response for the exceptional case.The default implementation prevents the response from being cached, if the
"preventResponseCaching"
property has been set to "true".- 参数:
ex
- the exception that got thrown during handler executionresponse
- current HTTP response- 另请参阅:
preventCaching(javax.servlet.http.HttpServletResponse)
preventCaching
protected void preventCaching(HttpServletResponse response)
Prevents the response from being cached, through setting corresponding HTTPCache-Control: no-store
header.- 参数:
response
- current HTTP response
doResolveException
@Nullable protected abstract ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex)
Actually resolve the given exception that got thrown during handler execution, returning aModelAndView
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.
- 参数:
request
- current HTTP requestresponse
- current HTTP responsehandler
- the executed handler, ornull
if none chosen at the time of the exception (for example, if multipart resolution failed)ex
- the exception that got thrown during handler execution- 返回:
- a corresponding
ModelAndView
to forward to, ornull
for default processing in the resolution chain