Spring MVC Interceptor Handler InterceptorAdapter HandlerInterceptor示例

2023-09-06 阅读 30 评论 0

摘要：Spring MVC Interceptor HandlerInterceptorAdapter，HandlerInterceptor示例 Spring Interceptor用于拦截客户端请求并处理它们。有时我们想拦截HTTP请求并在将其交给控制器处理程序方法之前进行一些处理。这就是Spring MVC拦截器派上用场的地方。目录[隐藏] 1 Spr

Spring MVC Interceptor HandlerInterceptorAdapter，HandlerInterceptor示例

Spring Interceptor用于拦截客户端请求并处理它们。有时我们想拦截HTTP请求并在将其交给控制器处理程序方法之前进行一些处理。这就是Spring MVC拦截器派上用场的地方。

目录[ 隐藏 ]

1 Spring拦截器
2 Spring Interceptor - HandlerInterceptor
- 2.1弹簧拦截器 - 控制器类
- 2.2 Spring MVC Interceptor - HandlerInterceptorAdapter实现
- 2.3 Spring MVC拦截器配置
- 2.4 Spring MVC拦截器应用程序测试

Spring 拦截器

就像我们有Struts2拦截器一样，我们可以通过实现org.springframework.web.servlet.HandlerInterceptor接口或覆盖org.springframework.web.servlet.handler.HandlerInterceptorAdapter提供HandlerInterceptor接口基本实现的抽象类来创建自己的Spring拦截器。

Spring Interceptor - HandlerInterceptor

Spring HandlerInterceptor根据我们想拦截HTTP请求的位置声明三种方法。

boolean preHandle（HttpServletRequest请求，HttpServletResponse响应，对象处理程序）：此方法用于在请求移交给处理程序方法之前拦截请求。这个方法应该返回'true'让Spring知道通过另一个Spring拦截器处理请求，或者如果没有其他弹簧拦截器则将它发送到处理程序方法。
如果此方法返回'false'，则Spring框架假定请求已由spring拦截器本身处理，并且不需要进一步处理。在这种情况下，我们应该使用响应对象来向客户端请求发送响应。

对象处理程序是处理请求的选定处理程序对象。此方法也可以抛出异常，在这种情况下，Spring MVC异常处理对于将错误页面作为响应发送应该很有用。
void postHandle（HttpServletRequest请求，HttpServletResponse响应，Object处理程序，ModelAndView modelAndView）：当HandlerAdapter调用处理程序但DispatcherServlet尚未呈现视图时，将调用此HandlerInterceptor拦截器方法。此方法可用于向要在视图页面中使用的ModelAndView对象添加其他属性。我们可以使用这个spring拦截器方法来确定处理程序方法处理客户端请求所花费的时间。
void afterCompletion（HttpServletRequest请求，HttpServletResponse响应，对象处理程序，Exception ex）：这是一个HandlerInterceptor回调方法，一旦执行处理程序并呈现视图就会调用该方法。

如果配置了多个弹簧拦截器，则按配置顺序执行preHandle（）方法，而以相反顺序调用postHandle（）和afterCompletion（）方法。

让我们创建一个简单的Spring MVC应用程序，我们将配置一个Spring Interceptor来记录控制器处理程序方法的时序。

我们最终的Spring Interceptor示例项目将如下图所示，我们将研究我们感兴趣的组件。

Spring Interceptor - 控制器类


package com.journaldev.spring;import java.text.DateFormat;
import java.util.Date;
import java.util.Locale;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;/*** Handles requests for the application home page.*/
@Controller
public class HomeController {private static final Logger logger = LoggerFactory.getLogger(HomeController.class);@RequestMapping(value = "/home", method = RequestMethod.GET)public String home(Locale locale, Model model) {logger.info("Welcome home! The client locale is {}.", locale);//adding some time lag to check interceptor executiontry {Thread.sleep(1000);} catch (InterruptedException e) {e.printStackTrace();}Date date = new Date();DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);String formattedDate = dateFormat.format(date);model.addAttribute("serverTime", formattedDate );logger.info("Before returning view page");return "home";}}

我只是在执行处理程序方法时添加一些处理时间来检查我们的spring拦截器方法。

Spring MVC Interceptor - HandlerInterceptorAdapter实现

为简单起见，我正在扩展抽象类HandlerInterceptorAdapter。HandlerInterceptorAdapter是HandlerInterceptor接口的抽象适配器类，用于简化pre-only / post-only拦截器的实现。


package com.journaldev.spring;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 RequestProcessingTimeInterceptor extends HandlerInterceptorAdapter {private static final Logger logger = LoggerFactory.getLogger(RequestProcessingTimeInterceptor.class);@Overridepublic boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler) throws Exception {long startTime = System.currentTimeMillis();logger.info("Request URL::" + request.getRequestURL().toString()+ ":: Start Time=" + System.currentTimeMillis());request.setAttribute("startTime", startTime);//if returned false, we need to make sure 'response' is sentreturn true;}@Overridepublic void postHandle(HttpServletRequest request,HttpServletResponse response, Object handler,ModelAndView modelAndView) throws Exception {System.out.println("Request URL::" + request.getRequestURL().toString()+ " Sent to Handler :: Current Time=" + System.currentTimeMillis());//we can add attributes in the modelAndView and use that in the view page}@Overridepublic void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex)throws Exception {long startTime = (Long) request.getAttribute("startTime");logger.info("Request URL::" + request.getRequestURL().toString()+ ":: End Time=" + System.currentTimeMillis());logger.info("Request URL::" + request.getRequestURL().toString()+ ":: Time Taken=" + (System.currentTimeMillis() - startTime));}}

逻辑非常简单，我只是记录处理程序方法执行的时间和处理请求所花费的总时间，包括渲染视图页面。

Spring MVC拦截器配置

我们必须将spring拦截器连接到请求，我们可以使用mvc：interceptors元素来连接所有拦截器。在通过mapping元素包含请求的spring拦截器之前，我们还可以提供匹配的URI模式。

我们的最终spring bean配置文件（spring.xml）如下所示。


<?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.xsdhttp://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.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:beanclass="org.springframework.web.servlet.view.InternalResourceViewResolver"><beans:property name="prefix" value="/WEB-INF/views/" /><beans:property name="suffix" value=".jsp" /></beans:bean><!-- Configuring interceptors based on URI --><interceptors><interceptor><mapping path="/home" /><beans:bean class="com.journaldev.spring.RequestProcessingTimeInterceptor"></beans:bean></interceptor></interceptors><context:component-scan base-package="com.journaldev.spring" /></beans:beans>

我不会解释Web应用程序的所有其他组件，因为我们对它们不感兴趣，并且它们没有任何特定的弹簧拦截器相关配置。

Spring MVC拦截器应用程序测试

只需在servlet容器中部署应用程序并调用主控制器，您将看到如下所示的记录器输出。


INFO : com.journaldev.spring.RequestProcessingTimeInterceptor - Request URL::http://localhost:9090/SpringInterceptors/home:: Start Time=1396906442086
INFO : com.journaldev.spring.HomeController - Welcome home! The client locale is en_US.
INFO : com.journaldev.spring.HomeController - Before returning view page
Request URL::http://localhost:9090/SpringInterceptors/home Sent to Handler :: Current Time=1396906443098
INFO : com.journaldev.spring.RequestProcessingTimeInterceptor - Request URL::http://localhost:9090/SpringInterceptors/home:: End Time=1396906443171
INFO : com.journaldev.spring.RequestProcessingTimeInterceptor - Request URL::http://localhost:9090/SpringInterceptors/home:: Time Taken=1085