SpringMvc拦截器基础

兆兆啦

于 2022-06-22 11:36:25 发布

阅读量128

点赞数

文章标签： java 前端开发语言

本文链接：https://blog.csdn.net/weixin_67696142/article/details/125405855

版权

1：拦截器的介绍

2：入门案例

3：多连接器

4：开发示例

1：拦截器的介绍

什么是拦截器？

SpringMVC的处理器拦截器,类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。依赖于web框架，在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个 controller生命周期之内可以多次调用。

拦截器和web过滤器的区别有哪些？

过滤器：

依赖与servlet容器，基于在实现上基于函数回调，可以对几乎所有请求进行过滤
基于servlet标准，只要是web工程即可使用，通用性强
过滤器的出现早已拦截器

拦截器：

属于springmvc技术，必须依赖于springmvc环境采用使用
springmvc拦截器通常对处理器（controller）进行拦截
拦截器只能拦截dispatcherServlet处理的请求
可以使用spring提供的容器，及强大的依赖注入

拦截器的应用场景

1）日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
2）权限检查：如登录检测，进入处理器检测是否登录，如果没有直接返回到登录页面；
3）性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；
4）通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个Controller中的处理方法都需要的，我们就可以使用拦截器实现。

2：入门案例

创建自定义拦截器

package com.zking.mabatisdemo.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class CustomInterceptor implements HandlerInterceptor {


    @Override //拦截器处理之前
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("CustomInterceptor  preHandle，拦截器处理之前");
        return true;//这里要返回true如果返回的false就不能调用处理器（拦截器被阻断）
    }


    @Override //拦截器处理当中
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("CustomInterceptor  postHandle，拦截器处理之中");
    }


    @Override //拦截器处理之后
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("CustomInterceptor  afterCompletion，拦截器处理之后");
    }
}

关于拦截器接口中定义的方法的说明：

preHandle方法
作用：用于对拦截到的请求进行预处理，方法接收布尔(true,false)类型的返回值，返回true：放行，false：不放行。
执行时机：在处理器方法执行前执行
方法参数：
1）request请求对象
2）response响应对象
3）handler拦截到的方法处理
postHandle方法
作用：用于对拦截到的请求进行后处理，可以在方法中对模型数据和视图进行修改
执行时机：在处理器的方法执行后，视图渲染之前
方法参数：
1）request请求对象
2）response响应对象
3）handler拦截到的处理器方法
4）ModelAndView处理器方法返回的模型和视图对象，可以在方法中修改模型和视图
afterCompletion方法
作用：用于在整个流程完成之后进行最后的处理，如果请求流程中有异常，可以在方法中获取对象
执行时机：视图渲染完成后(整个流程结束之后)
方法参数：
1）request请求参数
2）response响应对象
3）handler拦截到的处理器方法
4）ex异常对象

配置文件

在spring-mvc.xml文件中配置拦截器

 <mvc:interceptors>
        <mvc:interceptor>
            <!-- 该拦截器会拦截所有的请求 -->
            <mvc:mapping path="/**"/>
            <bean class="com.zking.mabatisdemo.interceptor.CustomInterceptor"/>
        </mvc:interceptor>

    </mvc:interceptors>

创建一个Controller

如果已经有Controller可以不创建，只是为了测试。例如下面的运行输出：

3.多连接器

拦截器链的概念：如果多个拦截器能够对相同的请求进行拦截，则多个拦截器会形成一个拦截器链，主要理解拦截器链中各个拦截器的执行顺序。拦截器链中多个拦截器的执行顺序，根拦截器的配置顺序有关，先配置的先执行。

创建多链接

public class CustomInterceptor02 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("CustomInterceptor02 preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("CustomInterceptor02 postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("CustomInterceptor02 afterCompletion");
    }
}

配置spring-mvc.xml文件

<mvc:interceptors>
        <mvc:interceptor>
            <!-- 该拦截器会拦截所有的请求 -->
            <mvc:mapping path="/**"/>
            <bean class="com.zking.mabatisdemo.interceptor.CustomInterceptor"/>
        </mvc:interceptor>

        <mvc:interceptor>
            <!-- 该拦截器会拦截指定的请求 -->
            <mvc:mapping path="/addBook/**"/>
            <bean class="com.zking.mabatisdemo.interceptor.CustomInterceptor02"/>
        </mvc:interceptor>

    </mvc:interceptors>

查看执行结果

4.开发示例

登录验证，开发步骤：

开发登录功能，当用户登录成功，将用户记入session
开发拦截器，如果用户访问除登录功能之外的其他资源，则验证是否登录，否则不允许访问

1）登录页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <c:if test="${not empty error}">
        <div>
            ${error}
        </div>
    </c:if>
    <form action="<%=request.getContextPath()%>/user/login" method="post">
        用户名: <input type="text" name="name"> <br data-tomark-pass>        密码: <input type="password" name="password"><br data-tomark-pass>        <input type="submit" value="提交">
    </form>
</body>
</html>

2）登录Controller

@Controller
public class LoginController {

    @RequestMapping("/")
    public String loginPage() {
        return "login";
    }

    @PostMapping("/user/login")
    public String login(String name, String password, HttpSession session, Model model) {

        if("admin".equals(name) && "123".equals(password)) {
            session.setAttribute("user", name);
            return "index";
        }
        model.addAttribute("error", "用户名或密码错误");
        return "login";
    }

    @GetMapping("/user/logout")
    public String logout(HttpSession session) {
        session.removeAttribute("user");
        return "redirect:/";
    }
}

3）编写index.jsp页面，可以是任何内容，可用于演示即可。在index中加入退出系统的代码（也是为方便演示）

<a href="<%=request.getContextPath()%>/user/logout">退出</a>

测试可以登录后，可以进行拦截器的编写了

4）拦截器的编写，参考代码

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        //获取页面路径
        String uri = request.getRequestURI();
        String contextPath = request.getContextPath();

        //登录页面，放行判断是否为登陆界面，如果是登陆界面或者执行登录校验的就放行
        if (uri.endsWith(contextPath+"/") || uri.indexOf("/user/login") >= 0) {
            return true;
        }

        //其他情况需要验证登录，如果我们登录成功将会把登录的user放入session中判断是否登录
        HttpSession session = request.getSession();
        Object user = session.getAttribute("user");

        //已登录，放行判断user是否为空如果不为空就放行（说明已经登录session中保存了记录）
        if (Objects.nonNull(user)) {
            return true;
        }
        //如果是session中是空的就是提示请先登录并且重定向到登陆界面
        session.setAttribute("error", "请先登录");
        //request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
        response.sendRedirect(contextPath+"/");

        //不再处理其他拦截器，直接返回
        return false;
    }

5）将拦截器配置到spring-mvc.xml

  <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.zking.mybatisdemo.interceptor.LoginInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

实例就完成啦，以上就是拦截器的基础使用啦