Spring MVC 教程
首页 死磕 Java 优质系列 Java 技术总览 Java 面试宝典 关于我

Spring MVC 拦截器

转
 2022-08-20  阅读(6)
©版权

Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。

要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。

  1. 通过实现HandlerInterceptor接口
  2. 继承HandlerInterceptor接口的实现类（如：HandlerInterceptorAdapter）来定义。

1 编写目标控制器

首先，为了演示Spring MVC拦截器的效果，我们先定义一个目标控制器

HelloController目标控制器：

            
            package com.yiidian.controller;
            import org.springframework.stereotype.Controller;
            import org.springframework.ui.Model;
            import org.springframework.ui.ModelMap;
            import org.springframework.web.bind.annotation.RequestBody;
            import org.springframework.web.bind.annotation.RequestMapping;
            import org.springframework.web.bind.annotation.ResponseBody;
            import org.springframework.web.multipart.MultipartFile;
            
            import javax.servlet.http.HttpServletRequest;
            import javax.servlet.http.HttpServletResponse;
            import javax.servlet.http.HttpSession;
            import java.io.*;
            import java.util.UUID;
            
            /**
             * 目标控制器
             * 一点教程网 - www.yiidian.com
             */
            @Controller
            public class HelloController {
            
                @RequestMapping("/hello")
                public String upload(HttpSession session, HttpServletResponse response) throws Exception {
                    System.out.println("3.目标控制器-HelloController");
                    return "success";
                }
            }

2 编写自定义拦截器

这里我们定义2个Spring MVC拦截器，而且这2个拦截器同时拦截器一个目标控制器，大家注意看最后的执行顺序。

Demo1Interceptor第一个拦截器：

            
            package com.yiidian.interceptor;
            
            import org.springframework.web.servlet.HandlerInterceptor;
            import org.springframework.web.servlet.ModelAndView;
            import javax.servlet.http.HttpServletRequest;
            import javax.servlet.http.HttpServletResponse;
            /**
             *  自定义拦截器
             *一点教程网 - www.yiidian.com
             */
            public class Demo1Interceptor implements HandlerInterceptor{
                /**
                 *preHandle: 在控制器(目标）的方法之前被执行
                 *   返回值：控制afterCompletion方法是否被执行
                 *       true: 执行afterCompletion
                 *       false: 不执行afterCompletion
                 */
                @Override
                public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
                    System.out.println("1.Demo1Interceptor的preHandle");
                    return true;
                }
            
                /**
                 * postHandle: 在控制器（目标）的方法成功执行完成之后（注意：控制器方法失败不执行）
                 */
                @Override
                public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
                    System.out.println("5.Demo1Interceptor的postHandle");
                }
            
                /**
                 *  afterCompletion: 在执行完前面所有（拦截器和目标）的方法之后执行（注意: 不管控制器方法执行成功与否都会被执行 ）
                 */
                @Override
                public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
                    System.out.println("7.Demo1Interceptor的afterCompletion");
                }
            }

Demo2interceptor第二个拦截器：

            
            package com.yiidian.interceptor;
            
            import org.springframework.web.servlet.HandlerInterceptor;
            import org.springframework.web.servlet.ModelAndView;
            
            import javax.servlet.http.HttpServletRequest;
            import javax.servlet.http.HttpServletResponse;
            
            /**
             *  自定义拦截器
             *一点教程网 - www.yiidian.com
             */
            public class Demo2Interceptor implements HandlerInterceptor{
                /**
                 *preHandle: 在控制器(目标）的方法之前被执行
                 *   返回值：控制afterCompletion方法是否被执行
                 *       true: 执行afterCompletion
                 *       false: 不执行afterCompletion
                 */
                @Override
                public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
                    System.out.println("2.Demo2Interceptor的preHandle");
                    return true;
                }
            
                /**
                 * postHandle: 在控制器（目标）的方法成功执行完成之后（注意：控制器方法失败不执行）
                 */
                @Override
                public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
                    System.out.println("4.Demo2Interceptor的postHandle");
                }
            
                /**
                 *  afterCompletion: 在执行完前面所有（拦截器和目标）的方法之后执行（注意: 不管控制器方法执行成功与否都会被执行 ）
                 */
                @Override
                public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
                    System.out.println("6.Demo2Interceptor的afterCompletion");
                }
            }

注意：一个拦截器和多个拦截器的执行顺序看下图。

一个拦截器的执行顺序：

202202131335062371.png

多个拦截器的执行顺序：

202202131335067492.png

3 springmvc.xml配置拦截器

            
            <!-- 配置拦截器 -->
            <mvc:interceptors>
                <!-- 配置2个拦截器 -->
                <mvc:interceptor>
                    <mvc:mapping path="/hello"/>
                    <bean class="com.yiidian.interceptor.Demo1Interceptor"/>
                </mvc:interceptor>
            
                <mvc:interceptor>
                    <mvc:mapping path="/hello"/>
                    <bean class="com.yiidian.interceptor.Demo2Interceptor"/>
                </mvc:interceptor>
            </mvc:interceptors>

注意：拦截器配置的顺序决定了拦截器的执行顺序，先配置会先被执行！

4 运行测试

访问：http://localhost:8080/hello

控制台输出效果如下：

202202131335073143.png

源码下载：https://pan.baidu.com/s/1myzqCpvlhVb4aJkb5aucdQ

Java 面试宝典是大明哥全力打造的 Java 精品面试题，它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题，而是一套完整的 Java 知识体系，一套你 Java 知识点的扫盲贴。

它的内容包括：

  • 大厂真题：Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
  • 原创内容：Java 面试宝典内容全部都是大明哥原创，内容全面且通俗易懂，回答部分可以直接作为面试回答内容。
  • 持续更新：一次购买，永久有效。大明哥会持续更新 3+ 年，累计更新 1000+，宝典会不断迭代更新，保证最新、最全面。
  • 覆盖全面：本宝典累计更新 1000+，从 Java 入门到 Java 架构的高频面试题，实现 360° 全覆盖。
  • 不止面试：内容包含面试题解析、内容详解、知识扩展，它不仅仅只是一份面试题，更是一套完整的 Java 知识体系。
  • 宝典详情：https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
  • 宝典总览：https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
  • 宝典进展：https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw

目前 Java 面试宝典累计更新 400+ 道，总字数 42w+。大明哥还在持续更新中，下图是大明哥在 2024-12 月份的更新情况：

想了解详情的小伙伴，扫描下面二维码加大明哥微信【daming091】咨询

同时，大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ，回复【面试题】 即可免费领取。

阅读全文
文章标签： Spring MVCSpring MVC 实战Spring MVC 入门