异常

如果在请求映射期间发生异常,或者从请求处理程序(例如 @Controller)抛出异常,DispatcherServlet 会委托给一连串的 HandlerExceptionResolver bean 来解析异常并提供替代处理,通常是错误响应。

下表列出了可用的 HandlerExceptionResolver 实现

表 1. HandlerExceptionResolver 实现
HandlerExceptionResolver 描述

SimpleMappingExceptionResolver

异常类名和错误视图名之间的映射。对于在浏览器应用程序中渲染错误页面很有用。

DefaultHandlerExceptionResolver

解析由 Spring MVC 抛出的异常,并将它们映射到 HTTP 状态代码。另请参见替代的 ResponseEntityExceptionHandler错误响应

ResponseStatusExceptionResolver

解析带有@ResponseStatus注解的异常,并根据注解中的值将其映射到 HTTP 状态码。

ExceptionHandlerExceptionResolver

通过调用@Controller@ControllerAdvice类中的@ExceptionHandler方法来解析异常。参见@ExceptionHandler 方法

解析器链

可以通过在 Spring 配置中声明多个HandlerExceptionResolver Bean 并根据需要设置它们的order属性来形成异常解析器链。order属性值越高,异常解析器的位置越靠后。

HandlerExceptionResolver的契约规定它可以返回

  • 指向错误视图的ModelAndView

  • 如果异常在解析器中得到处理,则返回一个空的ModelAndView

  • 如果异常仍然未解决,则返回null,以便后续解析器尝试解决,如果异常在最后仍然存在,则允许其冒泡到 Servlet 容器。

MVC 配置会自动声明用于默认 Spring MVC 异常、带有@ResponseStatus注解的异常以及支持@ExceptionHandler方法的内置解析器。可以自定义该列表或替换它。

容器错误页面

如果任何HandlerExceptionResolver都无法解决异常,因此该异常被传播,或者响应状态被设置为错误状态(即 4xx、5xx),则 Servlet 容器可以使用 HTML 渲染默认错误页面。要自定义容器的默认错误页面,可以在web.xml中声明错误页面映射。以下示例展示了如何执行此操作

<error-page>
	<location>/error</location>
</error-page>

鉴于上述示例,当异常冒泡或响应具有错误状态时,Servlet 容器将在容器内执行 ERROR 分派到配置的 URL(例如,/error)。然后,DispatcherServlet会处理它,可能将其映射到一个@Controller,该控制器可以实现为返回带有模型的错误视图名称或渲染 JSON 响应,如下例所示

  • Java

  • Kotlin

@RestController
public class ErrorController {

	@RequestMapping(path = "/error")
	public Map<String, Object> handle(HttpServletRequest request) {
		Map<String, Object> map = new HashMap<>();
		map.put("status", request.getAttribute("jakarta.servlet.error.status_code"));
		map.put("reason", request.getAttribute("jakarta.servlet.error.message"));
		return map;
	}
}
@RestController
class ErrorController {

	@RequestMapping(path = ["/error"])
	fun handle(request: HttpServletRequest): Map<String, Any> {
		val map = HashMap<String, Any>()
		map["status"] = request.getAttribute("jakarta.servlet.error.status_code")
		map["reason"] = request.getAttribute("jakarta.servlet.error.message")
		return map
	}
}
Servlet API 不提供在 Java 中创建错误页面映射的方法。但是,可以使用WebApplicationInitializer和最小的web.xml