springmvc拦截器
1. 拦截器定义
定义拦截器,实现HandlerInterceptor接口。接口中提供三个方法。
public class MyHandlerInterceptor1 implements HandlerInterceptor {
//进入 Handler方法之前执行
//应用场景:用于身份认证(登录认证)、身份授权(权限校验)
//比如说身份认证,若认证不通过则当前用户未登陆,需要此方法拦截不再向下执行
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
//return false表示拦截,不向下执行
//return true表示放行
return false;
}
//进入Handler方法之后,返回modelAndView之前执行
//应用场景从ModelAndView出发:将公用的模型数据(比如菜单导航栏)在这里传到视图,也可以在这里统一指定视图
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
}
//执行Handler完成执行此方法
//应用场景:统一异常处理,统一日志处理
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
}
}
2.拦截器配置
2.1 针对HandlerMapping配置
springmvc拦截器针对HandlerMapping进行拦截设置,如果在某个HandlerMapping中配置拦截,经过该 HandlerMapping映射成功的handler最终使用该拦截器。
一般不推荐使用:
<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="springmvc.intercapter.HandlerInterceptor1"/>
<bean id="handlerInterceptor2" class="springmvc.intercapter.HandlerInterceptor2"/>
2.2 全局的拦截器
XML版本 - 在dispatcher-servlet.xml中配置全局的拦截器
springmvc框架将配置的类似全局的拦截器注入到每个HandlerMapping中
<!--拦截器 -->
<mvc:interceptors>
<!--多个拦截器,顺序执行 -->
<mvc:interceptor>
<!-- /**表示所有url包括子url路径 -->
<mvc:mapping path="/**"/>
<bean
class="com.etc.ssm.interceptor.MyHandlerInterceptor1"></bean>
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean
class="com.etc.ssm.interceptor.MyHandlerInterceptor2"></bean>
</mvc:interceptor>
</mvc:interceptors>
JavaConfig配置类版本 - 在SpringMVCConfig中配置全局的拦截器
//拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
//创建登录拦截器
LoginHandlerInterceptor loginHandlerInterceptor = new LoginHandlerInterceptor();
//将登录拦截器注册进来
InterceptorRegistration interceptor = registry.addInterceptor(loginHandlerInterceptor);
//设置拦截器的拦截路径
interceptor.addPathPatterns("/**");
//设置拦截器的排除路径
interceptor.excludePathPatterns("/login.jsp");
//简化
//registry.addInterceptor(new LoginHandlerInterceptor()).addPathPatterns("/**").excludePathPatterns("/login.jsp");
}
3.拦截测试
3.1测试需求
测试多个拦截器各各方法执行时机。
3.2 编写两个拦截
HandlerInterceptor1
HandlerInterceptor2
3.3 两个拦截器都放行
HandlerInterceptor1…preHandle
HandlerInterceptor2…preHandle
HandlerInterceptor2…postHandle
HandlerInterceptor1…postHandle
HandlerInterceptor2…afterCompletion
HandlerInterceptor1…afterCompletion
总结:
preHandle方法按配置顺序执行,
postHandle和afterCompletion按拦截器配置的逆向顺序执行。
3.4 拦截器1放行,拦截器2不放行
HandlerInterceptor1…preHandle
HandlerInterceptor2…preHandle
HandlerInterceptor1…afterCompletion
总结:
拦截器1放行,拦截器2 preHandle才会执行。
拦截器2 preHandle不放行,拦截器2 postHandle和afterCompletion不会执行。
只要有一个拦截器不放行,postHandle不会执行。
3.5 拦截器1不放行,拦截器2不放行
HandlerInterceptor1…preHandle
总结:
拦截器1 preHandle不放行,postHandle和afterCompletion不会执行。
拦截器1 preHandle不放行,拦截器2不执行。
3.6 小结
根据测试结果,对拦截器应用。
比如:统一日志处理拦截器,需要该拦截器preHandle一定要放行,且将它放在拦截器链接中第一个位置。
比如:登陆认证拦截器,放在拦截器链接中第一个位置(放在统一日志处理拦截器之后)。权限校验拦截器,放在登陆认证拦截器之后。(因为登陆通过后才校验权限)
4.拦截器应用(实现登陆认证)
4.1 需求
1、用户请求url
2、拦截器进行拦截校验
如果请求的url是公开地址(无需登陆即可访问的url),如系统首页让放行
如果用户session 不存在跳转到登陆页面;如果用户session存在放行,继续操作。
4.2登陆controller方法
@Controller
public class LoginController {
// 登陆
@RequestMapping("/login.action")
public String login(HttpSession session, String username, String password) throws Exception {
// 调用service进行用户身份验证
// ...
// 在session中保存用户身份信息
session.setAttribute("username", username);
// 重定向到商品列表页面
return"redirect:/items/queryItemsList.action";
}
// 退出
@RequestMapping("/logout.action")
public String logout(HttpSession session) throws Exception {
// 清除session
session.invalidate();
// 重定向到商品列表页面
return"redirect:/items/queryItemsList.action";
}
}
4.3 JSP
login.jsp页面
itemsList.jsp页面
4.4 登陆认证拦截实现
4.4.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,从session中取出用户身份信息
HttpSession session = request.getSession();
String username = (String) session.getAttribute("username");
if(username != null){
//身份存在,放行
return true;
}
//执行这里表示用户身份需要认证,跳转登陆页面
request.getRequestDispatcher("/login.jsp").forward(request,response);
//return false表示拦截,不向下执行
return false;
}
}
4.4.2拦截器配置
PS:将之前配置的拦截器注释掉或者放行,以便测试