SpringMVC 拦截器开发详解

向右看齐 2024-04-01 14:19 54阅读 0赞

#### SpringMVC 拦截器开发 ####

*  一、拦截器介绍
 *   *  1、拦截器的应用场景
     *  2、拦截器的执行原理
     *  3、拦截器执行的时机
     *  4、拦截器实现的两种方式
 *  二、HandlerInterceptor接口分析
 *   *  1、preHandle
     *  2、postHandle
     *  3、afterCompletion
 *  三、自定义拦截器实现权限验证
 *  四、拦截器总结陈述

## 一、拦截器介绍 ##

### 1、拦截器的应用场景 ###

*  1、日志记录：记录请求信息的日志
 *  2、权限检查，如登录检查
 *  3、性能检测：检测方法的执行时间

### 2、拦截器的执行原理 ###

![在这里插入图片描述][cad22bd9a1a4457e95a0687a1658a51e.png]

### 3、拦截器执行的时机 ###

*  (1)preHandle():在请求被处理之前进行操作
 *  (2)postHandle():在请求被处理之后,但结果还没有渲染前进行操作,可以改变响应结果
 *  (3)afterCompletion:所有的请求响应结束后执行善后工作,清理对象,关闭资源

### 4、拦截器实现的两种方式 ###

*  (1)继承HandlerInterceptorAdapter的父类
 *  (2)实现HandlerInterceptor接口,实现的接口,推荐使用实现接口的方式

## 二、HandlerInterceptor接口分析 ##

自定义拦截器，需要实现 HandlerInterceptor 接口。而该接口中含有三个方法：

### 1、preHandle ###

该方法在处理器方法执行之前执行。其返回值为 boolean，若为 true，则紧接着会执行处理器方法，且会将 afterCompletion()方法放入到一个专门的方法栈中等待执行。  
**总结一句话就是：在请求被处理之前进行操作,预处理.**

### 2、postHandle ###

该方法在处理器方法执行之后执行。处理器方法若最终未被执行，则该方法不会执行。由于该方法是在处理器方法执行完后执行，且该方法参数中包含 ModelAndView，所以该方法可以修改处理器方法的处理结果数据，且可以修改跳转方向。  
**总结一句话就是：在请求被处理之后,但结果还没有渲染前进行操作,可以改变响应结果,后处理.**

### 3、afterCompletion ###

当preHandle()方法返回 true 时，会将该方法放到专门的方法栈中，等到对请求进行响应的所有工作完成之后才执行该方法。即该方法是在中央调度器渲染（数据填充）了响应页面之后执行的，此时对 ModelAndView 再操作也对响应无济于事。afterCompletion 最后执行的方法，清除资源，例如在 Controller 方法中加入数据等。  
**总结一句话就是：所有的请求响应结束后执行善后工作,清理对象,关闭资源 ,最终处理.**

## 三、自定义拦截器实现权限验证 ##

实现一个权限验证拦截器。

**1.改造登录方法,在session中存储用户信息,用于进行权限验证**

@Controller
    public class LoginController {
        
    
        @RequestMapping("/showLogin")
        public String showLogin(){
        
            return "login";
        }
    
        @RequestMapping("/login")
        public String login(String name,String password,HttpServletRequest request){
        
            if("admin".equals(name) && "admin".equals(password)){
        
                request.getSession().setAttribute("users",name);
                return "index";
            }
            request.setAttribute("msg","用户名或者密码错误");
            return "login";
        }
    }

**2.开发拦截器的功能.实现HandlerInterceptor接口,重写preHandle()方法**

public class LoginHandlerInterceptor implements HandlerInterceptor {
        
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            if(request.getSession().getAttribute("users") == null){
        
                request.setAttribute("msg","您还没有登录哦");
                request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
                return false;
            }
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
        }
    }

**3.在springmvc.xml文件中注册拦截器**

<mvc:interceptors>
            <mvc:interceptor>
                <mvc:mapping path="/**"/>
                <mvc:exclude-mapping path="/login"/>
                <mvc:exclude-mapping path="/showLogin"/>
                <bean class="com.bjpowernode.interceptor.LoginHandlerInterceptor"/>
            </mvc:interceptor>
        </mvc:interceptors>

## 四、拦截器总结陈述 ##

SpringMVC 中的 Interceptor 拦截器，它的主要作用是拦截指定的用户请求，并进行相应的预处理与后处理。其拦截的时间点在“处理器映射器根据用户提交的请求映射出了所要执行的处理器类，并且也找到了要执行该处理器类的处理器适配器，在处理器适配器执行处理器之前”。当然，在处理器映射器映射出所要执行的处理器类时，已经将拦截器与处理器组合为了一个处理器执行链，并返回给了中央调度器。

[cad22bd9a1a4457e95a0687a1658a51e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/dd0326e6528d4c07be12c0ae45f71a67.png