Помилки HTTP-протоколу в Spring MVC

У завершальній статті про обробку помилок в Spring MVC розглянемо обробку стандартних помилок HTTP. Стаття завершиться кодом проекту, який містить приклад з кожної з розглянутих у цій серії статей.

Нижче список можливих HTTP-помилок, який уже наводився в першій частині:

• 400 - Bad Request
• 401 - Unauthorized
• 402 - Payment Required
• 403 - Forbidden
• 404 - Not Found
• 405 - Method Not Allowed
• 406 - Not Acceptable
• 407 - Proxy Authentication Required
• 408 - Request Time-out
• 409 - Conflict
• 410 - Gone
• 411 - Length Required
• 412 - Precondition Failed
• 413 - Request Entity Too Large
• 414 - Request-URI Too Large
• 415 - Unsupported Media Type
• 416 - Requested range not satisfiable
• 417 - Expectation Failed
• 500 - Internal Server Error
• 501 - Not Implemented
• 502 - Bad Gateway
• 503 - Service Unavailable
• 504 - Gateway Time-out
• 505 - HTTP Version not supported

Обробка HTTP-помилок зроблена з використанням стандартного механізму контейнера сервлетов, але доповнюється потужністю фреймворку Spring MVC.

Для початку Вам знадобиться описати всі помилки, які Ви хочете обробляти, в файлі web.xml. Наприклад:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	version="2.5">
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>/WEB-INF/spring/root-context.xml</param-value>
	</context-param>
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>
	<servlet>
		<servlet-name>appServlet</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>appServlet</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>
	
	<error-page>
		<error-code>400</error-code>
		<location>/errors/400.html</location>
	</error-page>
	<error-page>
		<error-code>404</error-code>
		<location>/errors/404.html</location>
	</error-page>
	<error-page>
		<error-code>405</error-code>
		<location>/errors/405.html</location>
	</error-page>
	<error-page>
		<error-code>406</error-code>
		<location>/errors/406.html</location>
	</error-page>
	<error-page>
		<error-code>408</error-code>
		<location>/errors/408.html</location>
	</error-page>
	<error-page>
		<error-code>415</error-code>
		<location>/errors/415.html</location>
	</error-page>
	<error-page>
		<error-code>500</error-code>
		<location>/errors/500.html</location>
	</error-page>
	<error-page>
		<error-code>503</error-code>
		<location>/errors/503.html</location>
	</error-page>
	
</web-app>

Потім в контролері додати метод виду:

@RequestMapping(value = "/errors/400.html")
public ModelAndView handle400(Model model) {

	ModelAndView modelAndView = new ModelAndView("viewName");
	modelAndView.addObject("errorCode", "400");
	modelAndView.addObject("message", "Error 400 happens");

	return modelAndView;
}

Цей метод пов'язаний з наступним блоком в web.xml:

<error-page>
	<error-code>404</error-code>
	<location>/errors/404.html</location>
</error-page>

Аналогічні методи можна написати і для обробки інших помилок. Все досить просто тому далі зупинятися на цьому питанні не будемо.

Коротке резюме: розробники Spring радять використовувати SimpleMappingExceptionResolver для обробки винятків. Ми ж порадимо використовувати клас, успадкований від SimpleMappingExceptionResolver. Цей випадок більш гнучкий. Також не варто нехтувати обробкою HTTP-помилок - обробка виключень не позбавляє від них.

Вихідний код проекту можна завантажити за наступним посиланням - Завантажити spring-errorhandler.zip.