SpringMVC学习(十二)——SpringMVC中的拦截器

SpringMVC学习(十二)——SpringMVC中的拦截器

SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。本文主要总结一下SpringMVC中拦截器是如何定义的,以及测试拦截器的执行情况和使用方法。

SpringMVC中拦截器的定义和配置

SpringMVC中拦截器的定义

在SpringMVC中,定义拦截器要实现HandlerInterceptor接口,并实现该接口中提供的三个方法,如下:

public class Interceptor1 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("Interceptor1 preHandle........");
        // 执行的时机是在Handler执行之前执行此方法
        // 返回值:如果返回true,就放行,不拦截,正常执行Handler进行处理
        // 返回值:如果返回false,那就拦截,Handler就不能正常处理了
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // Handler执行之后,在返回ModelAndView之前,对modelAndView做些手脚
        System.out.println("Interceptor1 postHandle........");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        // 返回ModelAndView之后
        // Handler执行过程中出现异常,可以在此处理异常
        System.out.println("Interceptor1 afterCompletion........");
    }

}

针对这三个方法,我做一下简单的分析:

  1. preHandle方法:该方法执行的时机是在Handler执行之前执行。可以用于身份认证、身份授权等。比如如果认证没有通过表示用户没有登录,需要此方法拦截不再往下执行(return false),否则就放行(return true)。
  2. postHandle方法:该方法执行的时机是在Handler执行之后,在返回ModelAndView之前执行,可以看到该方法中有个modelAndView的形参。应用场景:从modelAndView出发,将公用的模型数据(比如菜单导航之类的)在这里传到视图,也可以在这里统一指定视图。
  3. afterCompletion方法:返回ModelAndView之后执行。应用场景:统一异常处理(即Handler执行过程中出现异常,可以在此处理异常),统一日志处理等。

SpringMVC中拦截器的配置

针对某种HandlerMapping配置拦截器

在SpringMVC中,拦截器是针对具体的HandlerMapping进行配置的,也就是说如果在某个HandlerMapping中配置拦截,经过该HandlerMapping映射成功的Handler最终会使用该拦截器。比如,假设我们在springmvc.xml配置文件中配置的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,那么我们可以这样来配置拦截器:

<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
    <property name="interceptors">
        <list>
            <ref bean="handlerInterceptor1"/>
            <ref bean="handlerInterceptor2"/>
        </list>
    </property>
</bean>
<bean id="handlerInterceptor1" class="com.itheima.springmvc.interceptor.HandlerInterceptor1"/>
<bean id="handlerInterceptor2" class="com.itheima.springmvc.interceptor.HandlerInterceptor2"/>

针对所有HandlerMapping配置全局拦截器

那么在SpringMVC中,如何配置类似于全局的拦截器呢?上面也说了,SpringMVC中的拦截器是针对具体的映射器而言的,为了解决这个问题,SpringMVC框架将配置的类似全局的拦截器注入到每个HandlerMapping中,这样就可以成为全局的拦截器了。配置如下:

<!-- 配置拦截器 -->
<mvc:interceptors>
    <!-- 按照配置的顺序执行拦截器 -->
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="com.itheima.springmvc.interceptor.Interceptor1"></bean>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="com.itheima.springmvc.interceptor.Interceptor2"></bean>
    </mvc:interceptor>
</mvc:interceptors>

注意:path=”/**”表示拦截所有的url包括子url路径。在实际开发中,一般我们都用这种配置,<mvc:mapping>中指定要拦截的url即可。

SpringMVC拦截器的执行测试

仿照上面的HandlerInterceptor1再写两个拦截器,HandlerInterceptor2和HandlerInterceptor3,配置是按照上面这个配置,然后我们来测试一下三个拦截器的执行情况,并做相关总结。

三个拦截器都放行

也就是说,我们将三个拦截器的preHandle方法中的返回值都改成true,来测试一下拦截器的执行顺序,访问任何一个url,测试结果都将如下:

Interceptor1 preHandle........
Interceptor2 preHandle........
Interceptor3 preHandle........

Interceptor3 postHandle........
Interceptor2 postHandle........
Interceptor1 postHandle........

Interceptor3 afterCompletion........
Interceptor2 afterCompletion........
Interceptor1 afterCompletion........

根据打印的结果做一个总结:当所有拦截器都放行的时候,preHandle方法是按照配置的顺序执行的;而另外两个方法按照配置的顺序逆向执行。

有一个拦截器不放行

我们将第三个拦截器的preHandle方法中的返回值改成false,前两个还是true,来测试一下拦截器的执行顺序,访问任何一个url,测试结果都将如下:

Interceptor1 preHandle........
Interceptor2 preHandle........
Interceptor3 preHandle........
Interceptor2 afterCompletion........
Interceptor1 afterCompletion........

根据打印的结果做一个总结:

  1. 由于拦截器1和2放行,所以拦截器3的preHandle才能执行。也就是说前面的拦截器放行了,后面的拦截器才能执行preHandle方法。
  2. 拦截器3不放行,所以其另外两个方法没有被执行。即如果某个拦截器不放行,那么它的另外两个方法就不会被执行。
  3. 只要有一个拦截器不放行,所有拦截器的postHandle方法都不会执行,但是只要执行过preHandle并且放行的,就会执行afterCompletion方法。

三个拦截器都不放行

这种情况其实可以参考上面的情况了,是一个特例,也看一下运行结果:

Interceptor1 preHandle........

很明显,就只执行了第一个拦截器的preHandle方法,因为都不放行,所以没有一个执行postHandle方法和afterCompletion方法。

总结

  1. preHandle按拦截器定义顺序调用
  2. postHandler按拦截器定义逆序调用
  3. afterCompletion按拦截器定义逆序调用
  4. postHandler在拦截器链内所有拦截器返回true才调用
  5. afterCompletion只有preHandle返回true才调用

拦截器的应用

从第二种情况来看,比如现在要写一个统一异常处理的逻辑,那么要将该拦截器放在拦截器链的第一个位置,且一定要放行,因为只有放行了,才会去执行afterCompletion,而且放在拦截器链的第一个的话,afterCompletion方法会最后执行,才能在里面执行统一异常处理的逻辑。
再比如,登录认证拦截器,要放在拦截器链接中的第一个位置(如果有统一异常处理,那么应该放在统一异常处理的后面);权限校验拦截器,放在登录认证拦截器之后(因为登录通过后才校验权限)。但我在这里只写一个登录验证的拦截器来以示说明如何使用SpringMVC的拦截器。

处理流程

  1. 先得有一个登录页面,然后需要写一个Controller类访问该页面
  2. 登录页面有一个提交表单的动作,也即需要在Controller类中进行处理
    • a) 判断用户名密码是否正确
    • b) 如果正确,向Session中写入用户信息
    • c) 返回登录成功页面,或者跳转到商品列表页面
  3. 拦截器的处理
    • a) 拦截用户请求,判断用户是否登录
    • b) 如果用户已经登录,则放行
    • c) 如果用户未登录,则跳转到登录页面

提供一个登录页面

在/WEB-INF/jsp目录下编写一个login.jsp登录页面,如下:

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
    <form action="${pageContext.request.contextPath }/user/login" method="post">
        <label>用户名</label>
        <input type="text" name="username" />
        <br/>
        <label>密码</label>
        <input type="password" name="password" />
        <br/>
        <input type="submit" value="提交" />
    </form>
</body>
</html>

编写实现用户登录的Controller

在com.itheima.springmvc.controller包下编写实现用户登录的UserController,如下:

public class UserController {

    @RequestMapping("/user/showlogin")
    public String showLogin() {
        return "login";
    }

    @RequestMapping("/user/login")
    public String userLogin(String username, String password, HttpSession session) {
        // a)   判断用户名密码是否正确
        System.out.println(username);
        System.out.println(password);
        // b)   如果正确,向session中写入用户信息
        session.setAttribute("username", username);
        // c)   返回登录成功页面,或者跳转到商品列表页面
        return "redirect:/item/itemList.action";
    }

}

登录验证拦截器的实现

在com.itheima.springmvc.interceptor包下编写一个登录验证的拦截器——LoginInterceptor.java,如下:

public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        String uri = request.getRequestURL().toString();
        // 如果用户未登录,则跳转到登录页面,跳转的过程中有可能被拦截,所以得做一个判断
        if (uri.contains("login")) {
            return true;
        }
        System.out.println("Interceptor1 preHandle........");
        // a)   拦截用户请求,判断用户是否登录
        HttpSession session = request.getSession();
        Object username = session.getAttribute("username");
        if (username != null) {
            // b)   如果用户已经登录。放行
            return true;
        }
        // c)   如果用户未登录,跳转到登录页面,跳转的过程中有可能被拦截,所以得做一个判断
        response.sendRedirect(request.getContextPath() + "/user/showlogin");
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // Handler执行之后,在返回ModelAndView之前,对modelAndView做些手脚
        System.out.println("Interceptor1 postHandle........");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        // 返回ModelAndView之后
        // Handler执行过程中出现异常,可以在此处理异常
        System.out.println("Interceptor1 afterCompletion........");
    }

}

然后配置该拦截器:

<!-- 配置拦截器 -->
<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="com.itheima.springmvc.interceptor.LoginInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

这样当我们任意请求一个url的时候,就会被刚刚我们定义的拦截器给捕获到,然后会判断session中是否有用户信息,没有的话就会跳到登陆页面让我们登陆。

原文地址:https://www.cnblogs.com/zbdouble/p/9092830.html

时间: 2024-10-25 23:57:59

SpringMVC学习(十二)——SpringMVC中的拦截器的相关文章

【SpringMVC学习11】SpringMVC中的拦截器

Springmvc的处理器拦截器类似于Servlet 开发中的过滤器Filter,用于对处理器进行预处理和后处理.本文主要总结一下springmvc中拦截器是如何定义的,以及测试拦截器的执行情况和使用方法. 1. springmvc拦截器的定义和配置 1.1 springmvc拦截器的定义 在springmvc中,定义拦截器要实现HandlerInterceptor接口,并实现该接口中提供的三个方法,如下: //测试拦截器1 public class HandlerInterceptor1 im

SpringMVC的拦截器 —— SpringMVC(十二)

拦截器的作用 SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理. 用户可以自定义一些拦截器来实现特定的功能. 拦截器链(Interceptor Chain),拦截器链就是将拦截器按照一定的顺序联结成一条链.在访问被拦截的方法或者字段时,拦截器链中的拦截器就会按照其之前定义的顺序被调用. 拦截器和过滤器的区别 过滤器是Servlet规范中的一部分,任何Java Web工程都可以使用. 拦截器是SpringMVC框架自己的,只有使用了Sp

在SpringMVC中使用拦截器(interceptor)拦截CSRF攻击

关于什么是CSRF我这里就不多说了,以前转载的一篇文章(PS:https://www.zifangsky.cn/358.html)已经说得很清楚了.这里只是简单介绍如何在SpringMVC中使用拦截器拦截CSRF攻击.具体代码如下: (1)登录页面: <%@page import="java.security.SecureRandom"%> <%@ page language="java" contentType="text/html; 

SpringMVC中的拦截器

Spring MVC 的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理. 用户可以自己定义一些拦截器来实现特定的功能. 拦截器链(Interceptor Chain)就是将拦截器按一定的顺序联结成一条链. 在访问被拦截的方法或字段时,拦截器链中的拦截器就会按其之前定义的顺序被调用. 拦截器和过滤器的区别: 过滤器是servlet规范中的一部分,任何java web工程都可以使用. 拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的

Docker学习(十二)中遇到的一些问题汇总

Docker学习(十二)中遇到的一些问题汇总 标签(空格分隔): docker docker: Error response from daemon: Conflict. The container name "/myubuntu" is already in use docker container ls docker container rm 容器名 docker rm $(docker ps -a -q) 删除所有容器 centos无法上网 ifup ens33 // 启用网卡

springMVC3学习(十二)--文件上传优化CommonsMultipartResolver

基于上一篇文件上传发现效率很慢,我们应该对它进行优化  使用springMVC对文件上传的解析器 来处理文件上传的时候需要在spring的applicationContext里面加上springMVC提供的MultipartResolver的申明 这样客户端请求的时候 springMVC会检查request里面是否包含多媒体信息 如果包含了就会使用MultipartResolver进行解析, springMVC会使用一个支持文件  处理的MultipartHttpServletRequest来包

SpringMVC学习一:SpringMVC的配置

SpringMVC的配置主要分为两部分: 1.xml文件配置 2.注解的配置 SpringMVC配置的步骤如下: 1.在将SpringMVC的jar包导入到web项目中后,先配置web.xml 文件.配置分发器使得请求通过Spring来控制分发 <servlet> <servlet-name>springMVC</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherSe

springmvc学习笔记(8)-springmvc整合mybatis之service

springmvc学习笔记(8)-springmvc整合mybatis之service springmvc学习笔记8-springmvc整合mybatis之service 定义service接口 在spring容器配置service 事务控制 本文记录如何整合service,包括定义spring接口,在spring容器配置service以及事务控制.让spring管理service接口. 定义service接口 public interface ItemsService { //商品查询列表 L

springmvc学习笔记(13)-springmvc注解开发之集合类型參数绑定

springmvc学习笔记(13)-springmvc注解开发之集合类型參数绑定 springmvc学习笔记13-springmvc注解开发之集合类型參数绑定 数组绑定 需求 表现层实现 list绑定 需求 表现层实现 map绑定 本文主要介绍注解开发的集合类型參数绑定,包含数组绑定,list绑定以及map绑定 数组绑定 需求 商品批量删除,用户在页面选择多个商品.批量删除. 表现层实现 关键:将页面选择(多选)的商品id,传到controller方法的形參,方法形參使用数组接收页面请求的多个商