【Spring】(16)Spring MVC 拦截器

【Spring】(16)Spring MVC 拦截器

一、拦截器

SpringMVC的处理拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现拦截器实现特定的功能。

  • 拦截器是AOP思想的具体应用
  • 拦截器是SpringMVC框架自己的,只有使用了SpringMVC架构的过程才能使用
  • 拦截只会拦截访问的控制器方法,如果访问的是jsp/html/css/image/js是不会拦截的

1.项目结构

不用关注我resources下的rebel.xml。这只是我项目用插件时候生成的。

在这里插入图片描述

2.配置文件

pom.xml依赖就一个

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.5.RELEASE</version>
        </dependency>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--配置DispatcherServlet-->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--关联一个SpringMVC的配置文件-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <!--服务器启动的时候就启动-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <!--  "/"匹配所有的请求不包括.jsp。"/*"匹配所有的请求包括.jsp -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!-- 配置Spring MVC编码过滤器(解决乱码) -->
    <filter>
        <filter-name>encoding</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encoding</filter-name>
        <!--  "/"匹配所有的请求不包括.jsp。"/*"匹配所有的请求包括.jsp -->
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

springmvc-servlet.xml

注意:==拦截器配置==

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

    <!-- 扫描包,让指定包下的注解生效,有IoC容器统一管理 -->
    <context:component-scan base-package="com.shengjava.web"/>
    <!--开启注解扫描-->
    <mvc:annotation-driven/>
    <!--在web开发中,我们一般存在静态资源css,js,img。。。-->
    <mvc:default-servlet-handler/>

    <!--视图解析器-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--前缀-->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!--后缀-->
        <property name="suffix" value=".jsp"/>
    </bean>

    <!-- 拦截器配置 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!-- "/**"代表"/"下面的所有请求 -->
            <mvc:mapping path="/**"/>
            <!-- 拦截器bean -->
            <bean class="com.shengjava.web.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

</beans>

注意:拦截器中还可以增加排除拦截的资源,例如:

 
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <!--被排除拦截的资源-->
            <mvc:exclude-mapping path="/css/**"/>
            <mvc:exclude-mapping path="/fonts/**"/>
            <mvc:exclude-mapping path="/images/**"/>
            <mvc:exclude-mapping path="/img/**"/>
            <mvc:exclude-mapping path="/js/**"/>
        </mvc:interceptor>

3.拦截器类

MyInterceptor类

主要是preHandle方法。我们可以用这个方法实现,例如,登录拦截。

  • preHandle(..):在执行实际的处理程序之前

  • postHandle(..):执行处理程序后

  • afterCompletion(..):完成完整的请求后

public class MyInterceptor implements HandlerInterceptor {
    /** true代表放行(可以进入下一个拦截器)、false代表拦截 */
    @Override
    public boolean preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler) throws Exception {
        System.out.println("----- 执行 preHandle -----");
        return true;
    }

    /** 下面两个方法可以用来做日志记录() */
    @Override
    public void postHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("----- 执行 postHandle -----");
    }

    @Override
    public void afterCompletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("----- 执行 afterCompletion -----");
    }
}

4.测试

TestController类。用于测试访问

@RestController
public class TestController {
    @GetMapping("/test")
    public String test(ModelMap mp) {
        System.out.println("执行test()方法...");
        return "test";
    }

}

访问/test接口。

控制台输出:可以看到执行了拦截器的方法。

----- 执行 preHandle -----
执行test()方法...
----- 执行 postHandle -----
----- 执行 afterCompletion -----

备注:可以使用注解实现。详情参考下面两篇文章:

1.1.6. Interception

1.11.5. Interceptors