springMVC系列（四）——springMVC拦截器

曾经终败给现在 2022-06-16 14:55 213阅读 0赞

springMVC拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

常见应用场景

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。

2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

5、接口访问拦截，当同一ip一段时间访问次数过多就对其进行拦截。

springMVC中通过实现HandlerInterceptor接口来使用拦截器。HandlerInterceptor源码

public interfaceHandlerInterceptor {
     
        booleanpreHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
               throws Exception;
     
        void postHandle(
               HttpServletRequestrequest,HttpServletResponse response,Object handler,ModelAndView modelAndView)
               throws Exception;
     
        void afterCompletion(
               HttpServletRequestrequest,HttpServletResponse response,Object handler,Exception ex)
               throws Exception;
    }

preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器。

返回值：true表示继续流程（如调用下一个拦截器或处理器）；

false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；

postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

我们还可以继承org.springframework.web.servlet.handler.HandlerInterceptorAdapter类，我们只需要重写需要的方法，而不是preHandle、postHandle、afterCompletion三个方法都去实现。

对于路径不存在的url请求，不会走拦截器。

新建项目study\_ssmvc

项目结构

![Center][]

准备jar包

![Center 1][]

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" xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
       <display-name>study_ssmvc</display-name>
       <welcome-file-list>
           <welcome-file>index.jsp</welcome-file>
       </welcome-file-list>
       <servlet>
          <servlet-name>SpringMVC</servlet-name>
          <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
          <init-param>
              <param-name>contextConfigLocation</param-name>
              <param-value>/WEB-INF/spring-servlet.xml</param-value>
          </init-param>
          <load-on-startup>1</load-on-startup>
       </servlet>
       <servlet-mapping>
          <servlet-name>SpringMVC</servlet-name>
          <url-pattern>/</url-pattern>
       </servlet-mapping>
    </web-app>

Spring-servlet.xml配置文件，配置mvc:interceptors，mvc:mappingpath是要拦截的地址，bean class是拦截器的实现类。

<?xml version="1.0"encoding="UTF-8"?>
    <beansxmlns="http://www.springframework.org/schema/beans" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:task="http://www.springframework.org/schema/task"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="
           http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-4.2.xsd
           http://www.springframework.org/schema/mvc
           http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
           http://www.springframework.org/schema/task
           http://www.springframework.org/schema/task/spring-task-4.2.xsd
           http://www.springframework.org/schema/aop
                       http://www.springframework.org/schema/aop/spring-aop-4.0.xsd">
            
             
             <context:component-scanbase-package="com.lc.controller" >
                       
                       
             </context:component-scan>
            
             <mvc:interceptors>
                 <mvc:interceptor >
                           <mvc:mappingpath="/test"/>
                           <beanclass="com.lc.interceptor.IndexInterceptor" />
                 </mvc:interceptor>
       </mvc:interceptors>
            
             
             <mvc:annotation-driven/>
            
             
       <beanclass="org.springframework.web.servlet.view.InternalResourceViewResolver">
           <property name="prefix"value="/WEB-INF/jsp/"/>
           <property name="suffix" value=".jsp"/>
       </bean>
    </beans>

IndexInterceptor过滤类

public classIndexInterceptor extends HandlerInterceptorAdapter{
       
        public IndexInterceptor() {
           System.out.println("拦截器注入");
        }
     
        public booleanpreHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throwsException {
           System.out.println("=================拦截器，controller代码执行前");
           Enumeration<String>s = request.getParameterNames();
           StringBuffersb = new StringBuffer();
           while(s.hasMoreElements()) {
               sb.append(s.nextElement() + ",");
           }
           System.out.println("参数有:" + sb);
           return true;
        }
       
        @Override
        public void postHandle(
               HttpServletRequestrequest,HttpServletResponse response,Object handler,ModelAndView modelAndView)
               throws Exception {
           System.out.println("==================拦截器，生成响应后");
           request.setAttribute("name", "响应后参数");
        }
       
        @Override
        public void afterCompletion(
               HttpServletRequestrequest,HttpServletResponse response,Object handler,Exception ex)
               throws Exception {
           System.out.println("=================拦截器，页面渲染成功");
        }
    }

TestController

@Controller
    @RequestMapping("")
    public classTestController {
     
        @RequestMapping("test")
        public String test() {
           return "test";
        }
    }

test.jsp

<%@ page language="java"contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html>
    <html>
    <head>
    <meta http-equiv="Content-Type"content="text/html; charset=UTF-8">
    <title>Insert title here</title>
    </head>
    <body>
        springMVC框架搭建测试页面
    </body>
    </html>

访问地址： [http://localhost:8080/study\_ssmvc/test?name=1][http_localhost_8080_study_ssmvc_test_name_1]。

结果

![Center 2][]

![Center 3][]

[Center]: /images/20220616/26c6f943ac0445aab086aa0f78eef4e1.png
[Center 1]: /images/20220616/e7752be230a24fffbb6bf1c86769e9d3.png
[http_localhost_8080_study_ssmvc_test_name_1]: http://localhost:8080/study_ssmvc/test?name=1
[Center 2]: /images/20220616/51d118676d2d43b59710cd85abd7aa85.png
[Center 3]: /images/20220616/8a8800f0a57b4b25a09440517b22a94e.png