2021-05-03 10:14  阅读(172)
文章分类:Spring MVC 教程 文章标签:SpringSpring MVC
©  原文作者:一点教程 原文地址:http://www.yiidian.com/springmvc/

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");
        }
    }
    

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

一个拦截器的执行顺序:
202105031014397281.png

多个拦截器的执行顺序:

202105031014399192.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

控制台输出效果如下:

202105031014400903.png

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

点赞(0)
版权归原创作者所有,任何形式转载请联系作者; Java 技术驿站 >> Spring MVC 拦截器
上一篇
Spring MVC 文件下载
下一篇
Spring MVC 异常处理机制