SpringMVC中的拦截器详解及代码示例

本文研究的主要是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.3 登陆验证拦截器的实现

//测试拦截器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>

拦截器的使用基本上就介绍到这了。

总结

以上就是本文关于SpringMVC中的拦截器详解及代码示例的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!

时间: 2018-02-04

SpringMVC拦截器实现单点登录

单点登录的功能在实际的应用场景中还是很重要的,逻辑上我们也不允许一个用户同时在进行着两个操作,下面就来了解一下SpringMVC的单点登录实现 SpringMVC的拦截器不同于Spring的拦截器,SpringMVC具有统一的入口DispatcherServlet,所有的请求都通过DispatcherServlet,所以只需要在DispatcherServlet上做文章即可,DispatcherServlet也没有代理,同时SpringMVC管理的Controller也不有代理. 1,先探究一个

详解SpringMVC拦截器配置及使用方法

本文介绍了SpringMVC拦截器配置及使用方法,分享给大家,具体如下: 常见应用场景 1.日志记录:记录请求信息的日志,以便进行信息监控.信息统计.计算PV(Page View)等. 2.权限检查:如登录检测,进入处理器检测检测是否登录,如果没有直接返回到登录页面: 3.性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录): 4.通用行为:读取cookie得到用户信

springMVC拦截器HandlerInterceptor用法代码示例

摘要:很多时候我们都会去修改其他同事的bug,甚至是已经离职的同事的bug,有时候我们点击页面去不着到后台对应的是哪个controller,针对这个问题,其实我们可以通过sprngmvc的拦截器来拦击用户的请求从而知道页面请求的是哪个class的哪个方法,当然这些打印日志信息肯能并不适合放在生产环境,或者这个拦截器也是非必要的.... 一.HandlerInterceptor用法 第一步:注册拦截器 <!-- 注册拦截器 --> <mvc:interceptors> <bea

springmvc用于方法鉴权的注解拦截器的解决方案代码

最近在用SpringMvc写项目的时候,遇到一个问题,就是方法的鉴权问题,这个问题弄了一天了终于解决了,下面看下解决方法 项目需求:需要鉴权的地方,我只需要打个标签即可,比如只有用户登录才可以进行的操作,一般情况下我们会在执行方法时先对用户的身份进项校验,这样无形中增加了非常大的工作量,重复造轮子,有了java注解只需要在需要鉴权的方法上面打个标签即可: 解决方案: 1.首先创建一个注解类: @Documented @Inherited @Target({ElementType.METHOD,E

防止SpringMVC拦截器拦截js等静态资源文件的解决方法

SpringMVC提供<mvc:resources>来设置静态资源,但是增加该设置如果采用通配符的方式增加拦截器的话仍然会被拦截器拦截,可采用如下方案进行解决: 方案一.拦截器中增加针对静态资源不进行过滤(涉及spring-mvc.xml) <mvc:resources location="/" mapping="/**/*.js"/> <mvc:resources location="/" mapping=&quo

SpringMVC拦截器实现监听session是否过期详解

本文主要向大家介绍了SpringMVC拦截器实现:当用户访问网站资源时,监听session是否过期的代码,具体如下: 一.拦截器配置 <mvc:interceptors> <mvc:interceptor> <mvc:mapping path="/**"/> <mvc:exclude-mapping path="/user/login"/> <!-- 不拦截登录请求 --> <mvc:exclude-

springmvc实现简单的拦截器

SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的.在SpringMVC 中定义一个Interceptor 非常简单,主要有两种方式,第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口,或者是这个类继承实现了HandlerInterceptor 接口的类,比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAda

springmvc限流拦截器的示例代码

限流器算法 目前常用限流器算法为两种:令牌桶算法和漏桶算法,主要区别在于:漏桶算法能够强行限制请求速率,平滑突发请求,而令牌桶算法在限定平均速率的情况下,允许一定量的突发请求 下面是从网上找到的两张算法图示,就很容易区分这两种算法的特性了 漏桶算法 令牌桶算法 针对接口来说,一般会允许处理一定量突发请求,只要求限制平均速率,所以令牌桶算法更加常见. 令牌桶算法工具RateLimiter 目前本人常用的令牌桶算法实现类当属google guava的RateLimiter,guava不仅实现了令牌桶

SpringMVC拦截器——实现登录验证拦截器的示例代码

本例实现登陆时的验证拦截,采用SpringMVC拦截器来实现 当用户点击到网站主页时要进行拦截,用户登录了才能进入网站主页,否则进入登陆页面 核心代码 首先是index.jsp,显示链接 <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <% String path = request.getContextPath(); String bas

微信小程序之页面拦截器的示例代码

场景 小程序有52个页面,其中13个页面无需任何身份,另外39个页面需要系统角色.对于这39个页面,如果微信用户没有系统角色,则跳转到登录页. 是否有系统角色信息需要通过异步请求来获取. 需求分析&实现 对需求进行抽象,其实要的就是一个过滤器,对小程序页面的访问进行过滤,符合条件的通过,不符合条件进行其他处理. 使用过php的laravel框架的童鞋,肯定一下子就联想到了laravel框架的http中间件: HTTP 中间件提供一个方便的机制来过滤进入应用程序的 HTTP 请求,例如,Larav

小程序如何自主实现拦截器的示例代码

在一些框架中发现会提供一个很实用的功能:拦截器(interceptor).例如要实现这个需求:小程序每次获取到定位后都存到 globalData 里: wx.getLocation({ // .. success(res) { getApp().globalData.location = res // ... } }) 如果每一处使用 wx.getLocation 的地方都这么写也没啥大问题,但总显得不够"智能",一方面是多了重复代码,另一方面如果需求变动,获取到定位后存到别的地方,那

struts2自定义拦截器的示例代码

题目:使用struts2自定义拦截器,完成用户登陆才能访问权限的实现 在session中存放user变量表示用户登陆,若user为空则用户没有登陆,反之登陆 显示提示信息(请先登录) 定义拦截器 在struts.xml中定义拦截器使用标签<Intercaptors>.<Intercapter>. <interceptors> <interceptor name="test" class="Intercaptor.Intercaptor

SpringMVC 限流的示例代码

在使用SpringBoot做接口访问如何做接口的限流,这里我们可以使用google的Guava包来实现,当然我们也可以自己实现限流,Guava中的限流是久经考验的我们没必需重新再去写一个,如果想了解限流原理的同学可以自己查阅一下相关的资料,本文不作过来说明噢. 使用说明 在项目中引入Guava相关包 http://mvnrepository.com/artifact/com.google.guava/guava/21.0 maven项目 <!-- https://mvnrepository.co

Springmvc中的转发重定向和拦截器的示例

本文介绍了Springmvc中的转发重定向和拦截器的示例,分享给大家,具体如下: 可变参数在设计方法时,使用 数据类型... 来声明参数类型,例如: public static void function(int... numbers) 在实现方法体时,可变参数是作为数组来处理 public class Test{ public static void main(String[] args){ System.out.println(Test.sum(1,2,3)); System.out.pri