Interceptor. Перехоплення запитів в Spring MVC

В Spring MVC є можливість виконувати якісь дії перед обробкою запиту, відразу після його обробки і перед відправкою відповіді клієнту. Все це можна зробити за допомогою так званих Interceptor'ов.

Ці перехоплювачі (Interceptor) дозволяють виконувати завдання, які є загальними для кожного запиту або набору запитів, без необхідності копіювати код в кожному методі контролера. Наприклад, можна виконувати аутентифікацію користувача перш, ніж запит досягне Вашого контролера і, в разі успіху, отримати деякі додаткові дані користувача з бази даних, додавши їх в об'єкт HttpServletRequest. З іншого боку, якщо запит не пройшов встановлену Вами перевірку (наприклад, входить в список "небезпечних" запитів, схожих на хакерські) Ви можете перенаправити користувача на іншу сторінку.

Приступимо до практики. Для початку створимо клас, що обробляє згадані вище дії:

package com.seostella.spring.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

public class StatsInterceptor extends HandlerInterceptorAdapter {

	private static final Logger logger = LoggerFactory.getLogger(StatsInterceptor.class);
	
	@Override
	public boolean preHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler) throws Exception {
		
		logger.info("Client User-Agent: " + request.getHeader("User-Agent"));
		
		return super.preHandle(request, response, handler);
	}
	
	@Override
	public void postHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		super.postHandle(request, response, handler, modelAndView);
	}
	
	@Override
	public void afterCompletion(HttpServletRequest request,
			HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		super.afterCompletion(request, response, handler, ex);
	}
}

Метод preHandle викликається перед тим як Front-контролер передає управління контролеру. Якщо метод повертає значення true, обробка передається контролеру, відповідальному за цей запит. Якщо повертає false - виконання переривається. Наступним кодом ми перериваємо виконання обробки запиту і перенаправляємо клієнта на адресу google.com:

response.sendRedirect("http://google.com/");
return false;

Метод postHandle викликається після того як контролер відпрацював і повернув результат.

Метод afterCompletion викликається після того як відповідь сформована.

Тепер нам треба зареєструвати цей Interseptor. Робиться це в контексті сервлета додаванням наступних рядків:

<interceptors>
	<beans:bean class="com.seostella.spring.interceptor.StatsInterceptor" />
</interceptors>

Також є можливість "ловити" не всі запити, а обмежитися лише деякими. Робиться це так:

<interceptors>
	<interceptor>
		<mapping path="/weather/*" />
		<beans:bean
			class="com.seostella.spring.interceptor.ExecutionTimeInterceptor" />
	</interceptor>
</interceptors>

Перехоплювач ExecutionTimeInterceptor буде "ловити" тільки запити, URI яких починається с /weather/

Код ExecutionTimeInterceptor представлений нижче:

package com.seostella.spring.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

public class ExecutionTimeInterceptor extends HandlerInterceptorAdapter {

	private static final Logger logger = LoggerFactory.getLogger(ExecutionTimeInterceptor.class);
	
	@Override
	public boolean preHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler) throws Exception {
		
		request.setAttribute("startRequestTime", new Long( System.currentTimeMillis() ) );
		
		return super.preHandle(request, response, handler);
	}
	
	@Override
	public void postHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		
		logger.info( " execution time of " + request.getRequestURI() + ": "
				+ ( System.currentTimeMillis() - ((Long)request.getAttribute("startRequestTime")).longValue() ) 
				+ " ms" );
		
		super.postHandle(request, response, handler, modelAndView);
	}
}

Файл конфігурації контексту сервлета:

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/mvc"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:beans="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">

	<!-- DispatcherServlet Context: defines this servlet's request-processing 
		infrastructure -->

	<!-- Enables the Spring MVC @Controller programming model -->
	<annotation-driven />

	<!-- Handles HTTP GET requests for /resources/** by efficiently serving 
		up static resources in the ${webappRoot}/resources directory -->
	<resources mapping="/resources/**" location="/resources/" />

	<!-- Resolves views selected for rendering by @Controllers to .jsp resources 
		in the /WEB-INF/views directory -->
	<beans:bean
		class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<beans:property name="prefix" value="/WEB-INF/views/" />
		<beans:property name="suffix" value=".jsp" />
	</beans:bean>

	<interceptors>
		<beans:bean
			class="com.seostella.spring.interceptor.StatsInterceptor" />

		<interceptor>
			<mapping path="/weather/*" />
			<beans:bean
				class="com.seostella.spring.interceptor.ExecutionTimeInterceptor" />
		</interceptor>
	</interceptors>

	<context:component-scan base-package="com.seostella.spring" />

</beans:beans>

Код програми, що демонструє роботу Interceptor'ів Ви можете завантажити за наступним посиланням - Завантажити spring-interceptors.zip