SpringMVC 拦截器

文章源码

拦截器的作用

SpringMVC 的处理器拦截器类似于 Servlet 开发中的过滤器 Filter，用于对处理器进行预处理和后处理。

谈到拦截器，还有另外一个概念 —— 拦截器链（Interceptor Chain）。拦截器链就是将拦截器按一定的顺序联结成一条链，在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

处理器拦截器和过滤器的异同：

  • 过滤器是 Servlet 规范中的一部分，任何 JavaWeb 工程都可以使用。而拦截器是 SpringMVC 框架独有的，只有使用了 SpringMVC 框架的工程才能使用。
  • 过滤器在 url-pattern 中配置了 /* 之后，可以对所有要访问的资源拦截。而拦截器它是只会拦截访问的控制器方法，如果访问的是静态资源则不会进行拦截。

自定义拦截器，要求必须实现 HandlerInterceptor 接口。

自定义拦截器

第一步 编写一个普通类实现 HandlerInterceptor 接口：

/**

 * @Author : parzulpan

 * @Time : 2020-12

 * @Desc : 自定义拦截器

 */

public class CustomInterceptor1 implements HandlerInterceptor {

    /**

     * 预处理，Controller 方法执行前

     * 可以使用转发或者重定向直接跳转到指定的页面

     * @param request

     * @param response

     * @param handler

     * @return true 代表放行，执行下一个拦截器，如果没有则执行 Controller 中的方法；false 代表不放行

     * @throws Exception

     */

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("called CustomInterceptor1 preHandle...");

//        request.getRequestDispatcher("/WEB_INF/views/error.jsp").forward(request, response);

        return true;

    }

    /**

     * 后处理，Controller 方法执行后，success.jsp 执行前

     * @param request

     * @param response

     * @param handler

     * @param modelAndView

     * @throws Exception

     */

    @Override

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

        System.out.println("called CustomInterceptor1 postHandle...");

//        request.getRequestDispatcher("/WEB_INF/views/error.jsp").forward(request, response);

    }

    /**

     * success.jsp 执行后

     * @param request

     * @param response

     * @param handler

     * @param ex

     * @throws Exception

     */

    @Override

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        System.out.println("called CustomInterceptor1 afterCompletion...");

    }

}

第二步 配置拦截器：

    <!-- 配置 处理器拦截器 -->

    <mvc:interceptors>

        <mvc:interceptor>

            <mvc:mapping path="/**"/>   <!-- 要拦截的方法 -->

            <!-- <mvc:exclude-mapping path="/**"/>  不要拦截的方法 -->

            <bean id="customInterceptor1" class="cn.parzulpan.interceptor.CustomInterceptor1"/>

        </mvc:interceptor>

    </mvc:interceptors>

第三步 测试结果：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<html>

<head>

    <title>拦截器的使用</title>

</head>

<body>

    <a href="user/testInterceptor">拦截器的使用</a>

</body>

</html>

输出：

called CustomInterceptor1 preHandle...

called testInterceptor...

called CustomInterceptor1 postHandle...

called success.jsp ...

called CustomInterceptor1 afterCompletion...

拦截器的细节

  • preHandle 方法：

    • 按拦截器定义顺序调用
    • 只要配置了就会调用
    • 如果决定该拦截器对请求进行拦截处理后还要调用其他的拦截器，或者是业务处理器去进行处理，则返回 true。如果决定不需要再调用其他的组件去处理请求，则返回 false。
  • postHandle 方法：
    • 按拦截器定义逆序调用
    • 在拦截器链内所有拦截器返回 true 就会调用
    • 在业务处理器处理完请求后，但是 DispatcherServlet 向客户端返回响应前被调用，可以在该方法中对用户请求 request 进行处理
  • afterCompletion 方法：
    • 按拦截器定义逆序调用
    • 只有 preHandle 返回 true 才调用
    • 在 DispatcherServlet 完全处理完请求后被调用，可以在该方法中进行一些资源清理的操作

多个拦截器的执行顺序：

假设多个拦截器配置为：

    <mvc:interceptors>

        <mvc:interceptor>

            <mvc:mapping path="/**"/>

            <bean id="customInterceptor1" class="cn.parzulpan.interceptor.CustomInterceptor1"/>

        </mvc:interceptor>

        <mvc:interceptor>

            <mvc:mapping path="/**"/>

            <bean id="customInterceptor2" class="cn.parzulpan.interceptor.CustomInterceptor2"/>

        </mvc:interceptor>

    </mvc:interceptors>

则 执行顺序为：

拦截器的简单使用

需求：

验证用户是否登录

实现：

  • 1、有一个登录页面，需要写一个 controller 访问页面
  • 2、登录页面有一提交表单的动作，需要在 controller 中处理。
    • 2.1、判断用户名密码是否正确
    • 2.2、如果正确 向 session 中写入用户信息
    • 2.3、返回登录成功。
  • 3、拦截用户请求，判断用户是否登录
    • 3.1、如果用户已经登录。放行
    • 3.2、如果用户未登录，跳转到登录页面

用户登录控制器 LoginController.java

/**

 * @Author : parzulpan

 * @Time : 2020-12

 * @Desc : 用户登录控制器

 */

@Controller

public class LoginController {

    /**

     * 登录页面

     * @param model

     * @return

     * @throws Exception

     */

    @RequestMapping("/login")

    public String login(Model model) throws Exception {

        System.out.println("called login...");

        return "login";

    }

    /**

     * 提交登录

     * @param session

     * @param username

     * @param password

     * @return

     * @throws Exception

     */

    @RequestMapping("/loginSubmit")

    public String loginSubmit(HttpSession session, String username, String password) throws Exception {

        System.out.println("called loginSubmit...");

        System.out.println(username + " " + password);

        session.setAttribute("activeUser", username);   // 向 session 记录用户身份信息

        return "forward:/WEB-INF/views/main.jsp";

    }

    /**

     * 退出登录

     * @param session

     * @return

     * @throws Exception

     */

    @RequestMapping("logout")

    public String logout(HttpSession session) throws Exception {

        System.out.println("called logout...");

        session.invalidate();   // 设置 session 过期

        return "redirect:/index.jsp";

    }

    /**

     * 测试页面

     * @return

     * @throws Exception

     */

    @RequestMapping("/test")

    public String test() throws Exception {

        System.out.println("called test...");

        return "test";

    }

用户登录拦截器 LoginInterceptor.java

/**

 * @Author : parzulpan

 * @Time : 2020-12

 * @Desc : 用户登录拦截器

 */

public class LoginInterceptor implements HandlerInterceptor {

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("called LoginInterceptor preHandle...");

        //如果是登录页面则放行

        if (request.getRequestURI().contains("login")) {

            System.out.println("登录页面");

            return true;

        }

        // 如果用户已登录则放行

        HttpSession session = request.getSession();

        if (session.getAttribute("activeUser") != null) {

            System.out.println("用户已登录");

            return true;

        }

        // 用户没有登录跳转到登录页面

        System.out.println("用户没有登录");

        request.getRequestDispatcher("/WEB-INF/views/login.jsp").forward(request, response);

        return false;

    }

}

views 页面

src/main/webapp/WEB-INF/views/login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<html>

<head>

    <title>登录</title>

</head>

<body>

    欢迎登录～

    <br>

    <form action="loginSubmit" method="post">

        用户名：<input type="text" name="username"/><br>

        密码：<input type="password" name="password"><br>

        <input type="submit" value="登录">

    </form>

</body>

</html>

src/main/webapp/WEB-INF/views/main.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<html>

<head>

    <title>首页</title>

</head>

<body>

    恭喜您，登录成功～

    <br>

    <a href="logout">退出登录</a>

    <a href="test">进入测试页面</a>

</body>

</html>

src/main/webapp/WEB-INF/views/test.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<html>

<head>

    <title>Title</title>

</head>

<body>

    我已登录，可以进入测试页面～

    <br>

    <a href="logout">退出登录</a>

</body>

</html>

测试页面

src/main/webapp/index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

<html>

<head>

    <title>拦截器的使用</title>

</head>

<body>

    <a href="login">用户登录</a>

    <a href="test">测试页面</a>

</body>

</html>

练习和总结

【SpringMVC】SpringMVC 拦截器的更多相关文章

  1. springmvc的拦截器

    什么是拦截器                                                         java里的拦截器是动态拦截action调用的对象.它提供了一种机制可以使 ...

  2. SpringMVC利用拦截器防止SQL注入

    引言 随着互联网的发展,人们在享受互联网带来的便捷的服务的时候,也面临着个人的隐私泄漏的问题.小到一个拥有用户系统的小型论坛,大到各个大型的银行机构,互联网安全问题都显得格外重要.而这些网站的背后,则 ...

  3. SpringMVC经典系列-14自己定义SpringMVC的拦截器---【LinusZhu】

    注意:此文章是个人原创.希望有转载须要的朋友们标明文章出处.假设各位朋友们认为写的还好,就给个赞哈.你的鼓舞是我创作的最大动力,LinusZhu在此表示十分感谢,当然文章中如有纰漏,请联系linusz ...

  4. 基于注解风格的Spring-MVC的拦截器

    基于注解风格的Spring-MVC的拦截器 Spring-MVC如何使用拦截器,官方文档只给出了非注解风格的例子.那么基于注解风格如何使用拦截器呢? 基于注解基本上有2个可使用的定义类,分别是Defa ...

  5. SpringMVC 学习-拦截器 HandlerInterceptor 类

    一.拦截器 HandlerInterceptor 类的作用 SpringMVC 的拦截器类似于 Servlet 开发中的过滤器 Filter,用于对处理器进行预处理和后处理. 二.怎么使用呢? 1. ...

  6. springMVC的拦截器工作流程

    首先,springmvc的拦截器配置在这就不多说了.主要讲一下拦截器的三个方法的执行顺序. preHandle方法一定是最先执行的方法,如果它返回为false下面的方法均不执行. postHandle ...

  7. SpringMVC—Struts2拦截器学习网址整理

    引自:http://blog.csdn.net/wp1603710463/article/details/49982683 SpringMVC—Struts2拦截器学习网址整理 最近项目中遇到权限相关 ...

  8. 转 ：关于springmvc使用拦截器

    原博客: http://elim.iteye.com/blog/1750680 SpringMVC 中的Interceptor 拦截器也是相当重要和相当有用的,它的主要作用是拦截用户的请求并进行相应的 ...

  9. springmvc中拦截器与springmvc全局异常处理器的问题

    最近在做一个练手的小项目, 系统架构中用了springmvc的全局异常处理器, 做了系统的统一异常处理. 后来加入了springmvc的拦截器, 为了一些需求, 在拦截器中的 preHandle 方法 ...

  10. springMVC配置拦截器、过滤器、前端控制器时遇到的问题总结

    1.业务场景:使用vuejs+springMVC+spring框架搭建一个mis系统,集成SSO单点登录: 2.遇到问题:使用interceptor拦截器配置SSO单点登录,直接敲域名,或者ip+端口 ...

随机推荐

  1. k8s遇见的问题

    open /etc/docker/certs.d/registry.access.redhat.com/redhat-ca.crt: no such file or directory 解决方案   ...

  2. mysqldump: [ERROR] unknown variable 'database=test'.

    背景: 导出数据库test库的test表数据出现报错信息:mysqldump: [ERROR] unknown variable 'database=test'. 原来是my.cnf参数文件配置了以下 ...

  3. mysql 8.0 主从复制配置

    背景: 主库: 192.168.211.128 从库: 192.168.211.129 一.关闭防火墙 [root@node01 ~]# systemctl disable firewalld [ro ...

  4. c++ 解析yaml文件

    一直用c++操作ini做配置文件,想换成yaml,在全球最大的同性交友网站github上搜索,看有没有开源的库,功夫不负有心人,找到了yaml-cpp,用他解析了一个yaml的例子非常好使,分享一下如 ...

  5. flink安装及standalone模式启动、idea中项目开发

    安装 环境 Ubuntu 18 jdk8 flink-1.8.1 安装步骤 安装jdk(略) 下载flink-1.8.1-bin-scala_2.12.tgz,解压到指定目录 wget http:// ...

  6. [日常摸鱼]bzoj3083遥远的国度-树链剖分

    一无聊就找树剖写 题意:一颗带点权的树,三种操作:1.换根 2.链赋值 3.查询子树最小值 如果没有换根的话直接就是裸的树剖了,对于换根的操作我们可以分类讨论. 1.如果查询的$x$就是根,那答案就是 ...

  7. openstack高可用集群19-linuxbridge结合vxlan

    生产环境,假设我们的openstack是公有云,我们一般的linuxbridge结合vlan的模式相对于大量的用户来说是vlan是不够用的,于是我们引进vxlan技术解决云主机内网网络通讯的问题. 我 ...

  8. 企业微信JS-SDK实现会话聊天功能

    vue引入企业微信JS-SDK实现会话聊天功能 这两天在做一个对接企业微信实现会话聊天的功能, 发现企业微信文档这块儿做的不是特别详细,网上搜索也没找到特别完整的流程. 期间也踩了不少的坑, 在此进行 ...

  9. Java基础进阶:继承重点摘要,继承详解,方法重写注意事项,方法重载与重写的区别,抽象类,代码块, 附重难点,代码实现源码,课堂笔记,课后扩展及答案

    继承重点摘要 *继承的特点: 子类在初始化之前,一定要先完成父类数据的初始化 子类在初始化之前,一定要先访问父类构造,完成父类数据的初始化 系统在每一个构造方法中默认隐藏了一句super(); 如果我 ...

  10. Python操作PDF-文本和图片提取（使用PyPDF2和PyMuPDF）

    PDF文件格式 如今,可移植文档格式(PDF)属于最常用的数据格式.在1990年,PDF文档的结构由Adobe定义.PDF格式的思想是,对于通信过程中涉及的双方(创建者,作者或发送者以及接收者)而言, ...