SpringMVC学习笔记之拦截器

最新推荐文章于 2022-07-19 00:47:59 发布

孤独的偷学者

最新推荐文章于 2022-07-19 00:47:59 发布

阅读量375

点赞数

分类专栏： SSM框架学习文章标签： java 后端 springmvc

本文链接：https://blog.csdn.net/qq_48238787/article/details/122385352

版权

SSM框架学习专栏收录该内容

9 篇文章 0 订阅

订阅专栏

文章目录

- 9 拦截器

9 拦截器

9.1 什么是拦截器

Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。要想写一个自己定义的拦截器，我们需要实现HandlerInterceptor接口（推荐）或者继承HandlerInterceptorAdapter类。
一个浏览器的请求发送到服务器历经的流程如下：
单个拦截器示意图：
在这里插入图片描述
多个拦截器示意图(注意每个Handler的执行顺序,前后顺序相反)

9.2 拦截器的配置

SpringMVC中的拦截器需要实现HandlerInterceptor,也就是上面所推荐的方式
SpringMVC的拦截器必须在SpringMVC的配置文件中添加以下配置：

<bean class="com.atguigu.interceptor.FirstInterceptor"></bean>
<ref bean="firstInterceptor"></ref>
<!-- 以上两种配置方式都是对DispatcherServlet所处理的所有的请求进行拦截 -->
<mvc:interceptor>
    <mvc:mapping path="/**"/>
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor"></ref>
</mvc:interceptor>
<!-- 
	以上配置方式可以通过ref或bean标签设置拦截器，通过mvc:mapping设置需要拦截的请求，通过mvc:exclude-mapping设置需要排除的请求，即不需要拦截的请求
-->

9.3 拦截器的三个抽象方法

SpringMVC中的拦截器有三个抽象方法：

preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法

postHandle：控制器方法执行之后执行postHandle()

afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()

9.4 多个拦截器的执行顺序

若每个拦截器的preHandle()都返回true

此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：

preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行
若某个拦截器的preHandle()返回了false

preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行

9.5 案例实操拦截器

9.5.1 项目的搭建

首先，我们新建一个Moodle，然后配置我们的pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zjw</groupId>
    <artifactId>demo3</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <packaging>war</packaging>

    <dependencies>
        <!--SpringMVC-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.9</version>
        </dependency>

        <!--ServletAPI-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>

        <!--Spring5和Thymeleaf整合包-->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
    </dependencies>

</project>

然后配置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">

    <!--配置编码过滤器，解决中文乱码问题-->
    <filter>
        <filter-name>CharacterEncodingFilter</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>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--配置SpringMVC的前端控制器，对浏览器发送的请求进行统一处理-->
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--配置SpringMVC配置文件的位置和名称-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--将前端控制器DispatcherServlet的初始化时间提前到服务器启动时-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <!--
            使用/可以拦截 /login、 .html、 .js 、.css方式的请求
            但是不能拦截 .jsp的请求，如果要把.jsp文件也拦下来，那么就得用/*
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

再配置我们的springMVC.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="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"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--扫描组件-->
    <context:component-scan base-package="com.example"/>

    <!--配置Thymeleaf视图解析器(针对h5文件，抄就完了)-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

    <!--
        处理静态资源，如html、js、css、jpg
        若只设置该标签，则只访问静态资源，其他请求无法访问
        此时必须设置<mvc:annotation-driven/>解决问题
    -->
    <mvc:default-servlet-handler/>

    <!--开启mvc注解驱动-->
    <mvc:annotation-driven>
        <mvc:message-converters>
            <!--处理响应中文乱码问题-->
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/html</value>
                        <value>application/json</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
</beans>

最后给我们的项目编写一个简单的首页index.html和一个成功跳转的页面success.html
index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
    <h1>首页</h1>
</body>
</html>

success.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>成功</title>
</head>
<body>
    <h1>跳转成功</h1>
</body>
</html>

9.5.2 配置拦截器拦截所有的控制器方法

编写我们的控制器类:
InterceptorController.java

@Controller
public class InterceptorController {

    @RequestMapping("/")
    public String index(){
        return "index";
    }
    @RequestMapping("/success")
    public String success(){
        return "success";
    }

    @RequestMapping("/testInterceptor")
    public ModelAndView testInterceptor(ModelAndView modelAndView){
        System.out.println("Controller方法被执行");
        modelAndView.setViewName("success");
        return modelAndView;
    }
}

再写我们的拦截器方法：
MyInterceptor.java

public class MyInterceptor implements HandlerInterceptor {
    /*控制器方法执行前执行*/
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor ----> preHandle");
        /*
            返回true表示放行
            返回false表示拦截，会阻止控制器方法的执行
        */
        return true;
    }

    /*控制器方法执行后执行*/
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor ----> postHandle");
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    /*视图渲染后执行*/
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor ----> afterCompletion");
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

然后，在springMVC配置文件中，修改我们的拦截器配置如下
在这里插入图片描述

    <!--配置拦截器-->
       <mvc:interceptors>
           <bean id="myInterceptor" class="com.zjw.interceptor.MyInterceptor"></bean>
       </mvc:interceptors>

在index.html页面加上超链接,方便我们测试

<a th:href="@{/testInterceptor}">测试拦截器</a><br>

最后就可以启动服务器,开始我们的测试了:
在这里插入图片描述
点击链接后实现跳转:

此时根据控制台输出,可以看出它们的执行顺序:

9.5.3 使用注解来配置拦截器

在springMVC中除了用bean标签设置我们自定义的拦截器的类，我们还可以用ref标签设置。用法如下：
首先，在我们的拦截器类上添加注解@Component 在这里插入图片描述
然后，在springMVC配置文件中，修改我们的拦截器配置如下(注意：使用注解来注册bean的名字默认是首字母小写，就像这里我的类名是MyInterceptor但是beanname为myInterceptor)：

    <!--配置拦截器-->
    <mvc:interceptors>
    	<!--<bean id="myInterceptor" class="com.example.interceptor.MyInterceptor"></bean>-->
        <ref bean="myInterceptor"></ref>
    </mvc:interceptors>

重启服务器,效果跟之前的一样

9.5.4 配置拦截器拦截指定的控制器方法

只需要在springMVC配置文件中用mvc:interceptor标签配置即可。
然后内嵌使用
在这里插入图片描述
具体配置方式如下：
在SprngMVC.xml配置文件中配置以下内容，达到除了首页以外，拦截所有的第一层目录的控制器方法

    <!--配置拦截器-->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--拦截所有只有一层目录的控制器方法-->
            <mvc:mapping path="/*"/>
            <!--不拦截/ 也就是首页index-->
            <mvc:exclude-mapping path="/"/>
            <!--配置我们的拦截器-->
            <ref bean="myInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

然后加上几个控制器方法来对比实验一下：

    @RequestMapping("/a/a1")
    public String test1(){
        return "success";
    }
    @RequestMapping("/a")
    public String test2(){
        return "success";
    }

然后在index.html中加入以下超链接方便我们测试：

<a th:href="@{/a}">测试拦截某个请求---->/a</a><br>
<a th:href="@{/a/a1}">测试拦截某个请求---->/a/a1</a><br>

重启服务器，开始测试。
测试效果就是进入首页并不会拦截，而当我们点击 /a链接，控制台打印拦截的信息，而点击双层目录 /a/a1 也不会出现拦截现象。

9.5.5 多个拦截器的执行顺序

我们现在再建两个SecondInterceptor、ThirdInterceptor类，让他们也实现HandlerInterceptor接口，然后把springMVC配置文件的内容改为：

 <mvc:interceptors>
        <ref bean="myInterceptor"/>
        <ref bean="secondInterceptor"/>
        <ref bean="thirdInterceptor"/>
    </mvc:interceptors>

情况一：针对我们所有拦截器都放行的情况，也就是pre都返回true。
在这里插入图片描述
总结一下：拦截器的执行顺序
1、pre是先配置，先执行（从第一个开始）
2、post和after是后配置，先执行（从最后一个开始）

情况二：如果中间有某个拦截器的pre返回false
这里我们让SecondInterceptor的pre返回false
在这里插入图片描述
并且地址实现了跳转，但是页面并没有进行渲染

如果多个拦截器中有某个拦截器的preHandler返回false，那么
1、在他后边执行的拦截器的preHandle都不执行。
2、控制器方法和所有拦截器的post方法不执行
3、返回false的拦截器之前的拦截器的after方法都会执行

孤独的偷学者

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringMVC学习笔记之拦截器

9 拦截器9.1 什么是拦截器Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。要想写一个自己定义的拦截器，我们需要实现HandlerInterceptor接口（推荐）或者继承HandlerInterceptorAdapter类。一个浏览器的请求发送到服务器历经的流程如下：单个拦截器示意图：多个拦截器示意图(注意每个Handler的执
复制链接

扫一扫