SpringMVC中的处理器拦截器类似于Servlet开发中的Filter过滤器,用于对处理器进行预处理和后处理。本文主要介绍SpringMVC中的拦截器是如何定义的,以及测试拦截器的执行情况和使用方法。
SpringMVC中拦截器的定义和配置
SpringMVC中拦截器的定义
在SpringMVC中,自定义拦截器需要实现HandlerInterceptor接口,并实现该接口中提供的三个方法。
package com.meimeixia.springmvc.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 自定义拦截器
* @author liayun
*
*/
public class MyInterceptor implements HandlerInterceptor {
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之后。注意,只要拦截器放行了,那么该方法就会被执行
*
* 适用场景:Handler执行过程中出现异常,可以在此处理异常,或者是清理资源,或者是记录日志等等
*/
@Override
public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
throws Exception {
System.out.println("MyInterceptor.afterCompletion......");
}
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之前
*
* 适用场景:可以对ModelAndView做些手脚,例如设置页面的共用参数等等
*/
@Override
public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
throws Exception {
System.out.println("MyInterceptor.postHandle......");
}
/**
* 该方法执行的时机是在Controller类方法执行之前,也就是说是在Handler执行之前
*
* 返回值:
* 如果返回true,那么就放行,不拦截,拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
* 如果返回false,那么就拦截,Handler就不能被正常执行了
*
* 适用场景:进行登录拦截或者权限校验等等
*/
@Override
public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
System.out.println("MyInterceptor.preHandle......");
//true:放行,false:拦截
return true;//拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
}
}
针对这三个方法,我做一下简单的分析:
- preHandle方法:该方法执行的时机是在Controller类方法执行之前,也就是说是在Handler执行之前。其应用场景:可以用于身份认证、身份授权等,比如如果认证没有通过表示用户没有登录,那么需要此方法拦截到不再往下执行(return false),否则就放行(return true);
- postHandle方法:该方法执行的时机是在Handler执行之后,在返回ModelAndView之前,可以看到该方法中有个ModelAndView类型的形参。其应用场景:从ModelAndView出发,将公用的模型数据(比如菜单导航之类的)在这里传到视图,也可以在这里统一指定视图;
- afterCompletion方法:该方法执行的时机是在Handler执行之后,在返回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.meimeixia.springmvc.interceptor.MyInterceptor"/>
<bean id="handlerInterceptor2" class="com.meimeixia.springmvc.interceptor.MyInterceptor2"/>
针对所有HandlerMapping配置全局拦截器
在SpringMVC中,如何配置类似于全局的拦截器呢?上面也说了,SpringMVC中的拦截器是针对具体的映射器而言的,为了解决这个问题,SpringMVC框架将配置的类似全局的拦截器注入到每个HandlerMapping中,这样就可以成为全局的拦截器了。配置如下所示:
<!-- 配置拦截器 -->
<mvc:interceptors>
<!-- 按照配置的顺序执行拦截器 -->
<mvc:interceptor>
<!-- /**:拦截所有请求,包括二级以上目录;/*:拦截所有请求,但不包括二级以上目录 -->
<mvc:mapping path="/**"/>
<bean class="com.meimeixia.springmvc.interceptor.MyInterceptor" />
</mvc:interceptor>
<mvc:interceptor>
<!-- /**:拦截所有请求,包括二级以上目录;/*:拦截所有请求,但不包括二级以上目录 -->
<mvc:mapping path="/**"/>
<bean class="com.meimeixia.springmvc.interceptor.MyInterceptor2" />
</mvc:interceptor>
</mvc:interceptors>
温馨提示:path="/**"
表示拦截所有的请求url(包括子url路径)。在实际开发中,一般我们都用这种配置,在<mvc:mapping>
标签中指定要拦截的url。
SpringMVC拦截器的执行测试
仿照上面的MyInterceptor再写一个拦截器,即MyInterceptor2,配置是按照上面的配置来的,然后我们就来测试一下这两个拦截器的执行情况,并做相关总结。
两个拦截器都放行
也就是说,我们将两个拦截器的preHandle方法中的返回值都改成true,来测试一下拦截器的执行情况,访问任何一个url,测试结果都将是下面这样子的。
根据打印的结果,我们可以做一个总结:当所有拦截器都放行的时候,preHandle方法是按照配置的顺序执行的;而另外两个方法是按照配置的顺序逆向执行的。
有一个拦截器不放行
我们将第二个拦截器的preHandle方法中的返回值改成false,前一个还是true,来测试一下拦截器的执行情况,访问任何一个url,测试结果都将是下面这样子的。
根据打印的结果,我们可以做一个总结:
- 由于拦截器1放行,所以拦截器2的preHandle方法才能执行。也就是说前面的拦截器放行了,后面的拦截器才能执行preHandle方法;
- 拦截器2不放行,所以其另外两个方法没有被执行。即如果某个拦截器不放行,那么它的另外两个方法就不会被执行;
- 只要有一个拦截器不放行,所有拦截器的postHandle方法都不会执行,但是只要执行过preHandle方法并且放行的,就会执行afterCompletion方法。
两个拦截器都不放行
这种情况其实可以参考上面的情况了,是一个特例,也看一下拦截器的执行情况。
很明显,就只执行了第一个拦截器的preHandle方法,因为都不放行,所以没有一个执行postHandle方法和afterCompletion方法。
总结
- preHandle方法是按拦截器定义顺序调用的;
- postHandler方法是按拦截器定义逆序调用的;
- afterCompletion方法也是按拦截器定义逆序调用;
- postHandler方法在拦截器链内所有拦截器返回true才调用;
- afterCompletion方法只有在preHandle方法返回true时才调用。
拦截器的应用
从第二种情况来看,比如现在要写一个统一异常处理的逻辑,那么要将该拦截器放在拦截器链的第一个位置,且一定要放行,因为只有放行了,才会去执行afterCompletion方法,而且放在拦截器链的第一个位置的话,afterCompletion方法会最后执行,这样才能在里面执行统一异常处理的逻辑。再比如,登录认证拦截器要放在拦截器链接中的第一个位置(如果有统一异常处理,那么应该放在统一异常处理的后面);权限校验拦截器要放在登录认证拦截器之后(因为只有登录通过后才进行权限校验)。但在这里我就只以登录验证的拦截器为例来说明如何使用SpringMVC的拦截器。
处理流程
- 先得有一个登录页面,然后需要编写一个Controller类来访问该页面;
- 登录页面中有一个提交表单的动作,也即需要在Controller类中进行处理:
- a) 判断用户名密码是否正确;
- b) 如果正确,向Session对象中写入用户信息;
- c) 返回登录成功页面,或者跳转到商品列表页面。
- 拦截器的处理:
- 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>用户登录</title>
</head>
<body>
<form action="${pageContext.request.contextPath }/user/login.action">
用户名:<input type="text" name="username" /><br>
密码:<input type="password" name="password" /><br>
<input type="submit">
</form>
</body>
</html>
编写实现用户登录的Controller
在com.meimeixia.springmvc.controller包下编写一个实现用户登录的Controller,即UserController.java。
package com.meimeixia.springmvc.controller;
import javax.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* 用户请求处理器
* @author liayun
*
*/
@Controller
@RequestMapping("user")
public class UserController {
@RequestMapping("toLogin")
public String toLogin() {
return "login";
}
@RequestMapping("login")
public String login(String username, String password, HttpSession session) {
//a) 判断用户是否登录,即判断用户名和密码是否正确
if (username.equals("admin")) {
//b) 如果正确,向session中写入用户信息
session.setAttribute("username", username);
//c) 跳转到商品列表页面
//不写/,默认是当前目录(即user目录),而user目录下并没有itemList.action请求
return "redirect:/itemList.action";
}
return "login";
}
}
登录验证拦截器的实现
在com.meimeixia.springmvc.interceptor包下编写一个登录验证的拦截器,即LoginInterceptor.java。
package com.meimeixia.springmvc.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 登录拦截器
* @author liayun
*
*/
public class LoginInterceptor implements HandlerInterceptor {
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之后。注意,只要拦截器放行了,那么该方法就会被执行
*
* 适用场景:Handler执行过程中出现异常,可以在此处理异常,或者是清理资源,或者是记录日志等等
*/
@Override
public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
throws Exception {
}
/**
* 该方法执行的时机是在Handler执行之后,在返回ModelAndView之前
*
* 适用场景:可以对ModelAndView做些手脚,例如设置页面的共用参数等等
*/
@Override
public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
throws Exception {
}
/**
* 该方法执行的时机是在Controller类方法执行之前,也就是说是在Handler执行之前
*
* 返回值:
* 如果返回true,那么就放行,不拦截,拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
* 如果返回false,那么就拦截,Handler就不能被正常执行了
*
* 适用场景:进行登录拦截或者权限校验等等
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object arg2) throws Exception {
//判断用户有没有登录
Object object = request.getSession().getAttribute("username");
if (object == null) {
response.sendRedirect(request.getContextPath() + "/user/toLogin.action");//用户没有登录,则直接重定向到登录页面
}
//true:放行,false:拦截
return true;//拦截器放行之后,就会处理Controller类里面的方法,正常执行Handler
}
}
然后在springmvc.xml文件中配置以上登录验证拦截器。
<!-- 配置拦截器 -->
<mvc:interceptors>
<!-- 按照配置的顺序执行拦截器 -->
<mvc:interceptor>
<!-- /**:拦截所有请求,包括二级以上目录;/*:拦截所有请求,但不包括二级以上目录 -->
<mvc:mapping path="/**"/>
<bean class="com.meimeixia.springmvc.interceptor.MyInterceptor" />
</mvc:interceptor>
<mvc:interceptor>
<!-- /**:拦截所有请求,包括二级以上目录;/*:拦截所有请求,但不包括二级以上目录 -->
<mvc:mapping path="/**"/>
<bean class="com.meimeixia.springmvc.interceptor.MyInterceptor2" />
</mvc:interceptor>
<mvc:interceptor>
<!-- /**:拦截所有请求,包括二级以上目录;/*:拦截所有请求,但不包括二级以上目录 -->
<mvc:mapping path="/**"/>
<!-- 配置不拦截目录 -->
<mvc:exclude-mapping path="/user/**"/>
<bean class="com.meimeixia.springmvc.interceptor.LoginInterceptor" />
</mvc:interceptor>
</mvc:interceptors>
这样当我们任意请求一个url的时候,就会被刚刚我们定义的拦截器给捕获到,然后会判断session中是否有用户信息,没有的话就会跳到登录页面让我们登录。