zoukankan      html  css  js  c++  java
  • 【SpringMVC学习11】SpringMVC中的拦截器

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

    1. springmvc拦截器的定义和配置

    1.1 springmvc拦截器的定义

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

    //测试拦截器1
    public class HandlerInterceptor1 implements HandlerInterceptor{
    
        @Override
        public boolean preHandle(HttpServletRequest request,
                HttpServletResponse response, Object handler) throws Exception {
    
            System.out.println("HandlerInterceptor1....preHandle");
    
            //false表示拦截,不向下执行;true表示放行
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request,
                HttpServletResponse response, Object handler,
                ModelAndView modelAndView) throws Exception {
    
            System.out.println("HandlerInterceptor1....postHandle");
    
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request,
                HttpServletResponse response, Object handler, Exception ex)
                throws Exception {
    
            System.out.println("HandlerInterceptor1....afterCompletion");
        }
    }

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

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

    1.2 springmvc拦截器的配置

      在springmvc中,拦截器是针对具体的HandlerMapping进行配置的,也就是说如果在某个HandlerMapping中配置拦截,经过该 HandlerMapping映射成功的handler最终使用该拦截器。比如,假设我们在配置文件中配置了的映射器是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="ssm.intercapter.HandlerInterceptor1"/>
    <bean id="handlerInterceptor2" class="ssm.intercapter.HandlerInterceptor2"/>

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

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <!-- 多个拦截器,按顺序执行 -->        
        <mvc:interceptor>
            <mvc:mapping path="/**"/> <!-- 表示拦截所有的url包括子url路径 -->
            <bean class="ssm.interceptor.HandlerInterceptor1"/>
        </mvc:interceptor>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="ssm.interceptor.HandlerInterceptor2"/>
        </mvc:interceptor>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="ssm.interceptor.HandlerInterceptor3"/>
        </mvc:interceptor>
    </mvc:interceptors>

     一般我们都用这种配置,<mvc:mapping>中指定要拦截的url即可。

    2. springmvc拦截器的执行测试

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

    2.1 三个拦截器都放行

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

    HandlerInterceptor1….preHandle 
    HandlerInterceptor2….preHandle 
    HandlerInterceptor3….preHandle
    
    HandlerInterceptor3….postHandle 
    HandlerInterceptor2….postHandle 
    HandlerInterceptor1….postHandle
    
    HandlerInterceptor3….afterCompletion 
    HandlerInterceptor2….afterCompletion 
    HandlerInterceptor1….afterCompletion

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

    2.2 有一个拦截器不放行

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

    HandlerInterceptor1….preHandle 
    HandlerInterceptor2….preHandle 
    HandlerInterceptor3….preHandle
    
    HandlerInterceptor2….afterCompletion 
    HandlerInterceptor1….afterCompletion

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

    2.3 三个拦截器都不放行

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

    HandlerInterceptor1….preHandle

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

    3. 拦截器的使用

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

    3.1 需求

      首先看一下需求:我们要拦截啥,拦截到了要干啥。思路如下:

    1、用户请求url 
    2、拦截器进行拦截校验 
    如果请求的url是公开地址(无需登陆即可访问的url),让放行。 
    如果用户session不存在,则跳转到登陆页面。 
    如果用户session存在则放行,继续操作。

    3.2 实现登陆的Controller方法

    //登陆
    @RequestMapping("/login")
    public String login(HttpServletRequest request, String username, String password) throws Exception {
    
        //实际中要去和数据库匹配的
        //....
        //这里就假设登陆成功了
        HttpSession session = request.getSession();
        session.setAttribute("username", username);
        return "redirect:queryItems.action";
    }
    
    //退出
    @RequestMapping("/logout")
    public String logout(HttpServletRequest request) throws Exception {
    
        HttpSession session = request.getSession();
        session.invalidate();
        return "redirect:queryItems.action";
    }

    3.2 登陆验证拦截器的实现

    //测试拦截器1
    public class LoginInterceptor implements HandlerInterceptor{
    
        //进入Handler方法之前执行
        //可以用于身份认证、身份授权。如果认证没有通过表示用户没有登陆,需要此方法拦截不再往下执行,否则就放行
        @Override
        public boolean preHandle(HttpServletRequest request,
                HttpServletResponse response, Object handler) throws Exception {
    
            //获取请求的url
            String url = request.getRequestURI();
            //判断url是否公开地址(实际使用时将公开地址配置到配置文件中)
            //这里假设公开地址是否登陆提交的地址
            if(url.indexOf("login.action") > 0) {
                //如果进行登陆提交,放行
                return true;
            }
    
            //判断session
            HttpSession session = request.getSession();
            //从session中取出用户身份信息
            String username = (String) session.getAttribute("username");
            if(username != null) {
                return true;
            }
    
            //执行到这里表示用户身份需要验证,跳转到登陆页面
            request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
    
            return false;
        }
        //节省空间,省略另外两个方法不写了,也不用处理
    }

    然后配置该拦截器:

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <!-- 多个拦截器,按顺序执行 -->    
        <mvc:interceptor>
            <mvc:mapping path="/**"/> <!-- 拦截所有的url包括子url路径 -->
            <bean class="ssm.interceptor.LoginInterceptor"/>
        </mvc:interceptor>
        <!-- 其他拦截器 -->
    </mvc:interceptors>

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

    <form action="${pageContext.request.contextPath }/login.action" method="post">
        用户名:<input type="text" name="username" /><br>
        密码:<input type="password" name="password" /><br>
        <input type="submit" name="提交" />
    </form>

    拦截器的使用基本上就总结到这了。 

  • 相关阅读:
    结对第一次—原型设计(文献摘要热词统计)
    第一次作业-准备篇
    201771010135杨蓉庆《面向对象程序设计(java)》第二周学习总结
    杨蓉庆201771010135《面向对象程序设计(java)》第一周学习总结
    2019 SDN阅读作业
    第01组 Alpha冲刺 (2/4)
    2019 SDN上机第3次作业
    第01组 ALPHA冲刺(1/4)
    2019SDN上机第二次作业
    2019 SDN上机第1次作业
  • 原文地址:https://www.cnblogs.com/shanheyongmu/p/5884217.html
Copyright © 2011-2022 走看看