Java三大器之拦截器(Interceptor)的实现原理及代码示例

前言:前面2篇博客,我们分析了Java中过滤器和监听器的实现原理,今天我们来看看拦截器。

 


1,拦截器的概念
    java里的拦截器是动态拦截Action调用的对象,它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码,也可以在一个Action
执行前阻止其执行,同时也提供了一种可以提取Action中可重用部分代码的方式。在AOP中,拦截器用于在某个方法或者字段被访问之前,进行拦截
然后再之前或者之后加入某些操作。目前,我们需要掌握的主要是Spring的拦截器,Struts2的拦截器不用深究,知道即可。

2,拦截器的原理
    大部分时候,拦截器方法都是通过代理的方式来调用的。Struts2的拦截器实现相对简单。当请求到达Struts2的ServletDispatcher时,Struts2
会查找配置文件,并根据配置实例化相对的拦截器对象,然后串成一个列表(List),最后一个一个的调用列表中的拦截器。Struts2的拦截器是可
插拔的,拦截器是AOP的一个实现。Struts2拦截器栈就是将拦截器按一定的顺序连接成一条链。在访问被拦截的方法或者字段时,Struts2拦截器链
中的拦截器就会按照之前定义的顺序进行调用。

3,自定义拦截器的步骤
    第一步:自定义一个实现了Interceptor接口的类,或者继承抽象类AbstractInterceptor。
    第二步:在配置文件中注册定义的拦截器。
    第三步:在需要使用Action中引用上述定义的拦截器,为了方便也可以将拦截器定义为默认的拦截器,这样在不加特殊说明的情况下,所有的
Action都被这个拦截器拦截。

4,过滤器与拦截器的区别
    过滤器可以简单的理解为“取你所想取”,过滤器关注的是web请求;拦截器可以简单的理解为“拒你所想拒”,拦截器关注的是方法调用,比如拦截
敏感词汇。
4.1,拦截器是基于java反射机制来实现的,而过滤器是基于函数回调来实现的。(有人说,拦截器是基于动态代理来实现的)
4.2,拦截器不依赖servlet容器,过滤器依赖于servlet容器。
4.3,拦截器只对Action起作用,过滤器可以对所有请求起作用。
4.4,拦截器可以访问Action上下文和值栈中的对象,过滤器不能。
4.5,在Action的生命周期中,拦截器可以多次调用,而过滤器只能在容器初始化时调用一次。

5,Spring拦截器
5.1,抽象类HandlerInterceptorAdapter
    我们如果在项目中使用了Spring框架,那么,我们可以直接继承HandlerInterceptorAdapter.java这个抽象类,来实现我们自己的拦截器。

Spring框架,对java的拦截器概念进行了包装,这一点和Struts2很类似。HandlerInterceptorAdapter继承了抽象接口HandlerInterceptor。

 

 
  1. package org.springframework.web.servlet.handler;

  2. import javax.servlet.http.HttpServletRequest;

  3. import javax.servlet.http.HttpServletResponse;

  4. import org.springframework.web.servlet.HandlerInterceptor;

  5. import org.springframework.web.servlet.ModelAndView;

  6. public abstract class HandlerInterceptorAdapter implements HandlerInterceptor{

  7. // 在业务处理器处理请求之前被调用

  8. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception{

  9. return true;

  10. }

  11. // 在业务处理器处理请求完成之后,生成视图之前执行

  12. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)

  13. throws Exception{

  14. }

  15. // 在DispatcherServlet完全处理完请求之后被调用,可用于清理资源

  16. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

  17. throws Exception{

  18. }

  19. }


    接下来我们看一下Spring框架实现的一个简单的拦截器UserRoleAuthorizationInterceptor,UserRoleAuthorizationInterceptor继承了
抽象类HandlerInterceptorAdapter,实现了用户登录认证的拦截功能,如果当前用户没有通过认证,会报403错误。

 

 

 
  1. package org.springframework.web.servlet.handler;

  2. import java.io.IOException;

  3. import javax.servlet.ServletException;

  4. import javax.servlet.http.HttpServletRequest;

  5. import javax.servlet.http.HttpServletResponse;

  6. public class UserRoleAuthorizationInterceptor extends HandlerInterceptorAdapter{

  7. // 字符串数组,用来存放用户角色信息

  8. private String[] authorizedRoles;

  9. public final void setAuthorizedRoles(String[] authorizedRoles){

  10. this.authorizedRoles = authorizedRoles;

  11. }

  12. public final boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

  13. throws ServletException, IOException{

  14. if (this.authorizedRoles != null) {

  15. for (int i = 0; i < this.authorizedRoles.length; ++i) {

  16. if (request.isUserInRole(this.authorizedRoles[i])) {

  17. return true;

  18. }

  19. }

  20. }

  21. handleNotAuthorized(request, response, handler);

  22. return false;

  23. }

  24. protected void handleNotAuthorized(HttpServletRequest request, HttpServletResponse response, Object handler)

  25. throws ServletException, IOException{

  26. // 403表示资源不可用。服务器理解用户的请求,但是拒绝处理它,通常是由于权限的问题

  27. response.sendError(403);

  28. }

  29. }


    下面,我们利用Spring框架提供的HandlerInterceptorAdapter抽过类,来实现一个自定义的拦截器。我们这个拦截器叫做
UserLoginInterceptorBySpring,进行登录拦截控制。工作流程是这样的:如果当前用户没有登录,则跳转到登录页面;登录成功后,跳转到
之前访问的URL页面。

 

 

 
  1. import java.util.HashMap;

  2. import java.util.Map;

  3. import javax.servlet.http.HttpServletRequest;

  4. import javax.servlet.http.HttpServletResponse;

  5. import org.springframework.web.servlet.ModelAndView;

  6. import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

  7. /**

  8. * @description 利用spring框架提供的HandlerInterceptorAdapter,实现自定义拦截器

  9. */

  10. public class UserLoginInterceptorBySpring extends HandlerInterceptorAdapter{

  11. // 在业务处理器处理请求之前被调用

  12. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception{

  13. // equalsIgnoreCase 与 equals的区别?

  14. if("GET".equalsIgnoreCase(request.getMethod())){

  15. //RequestUtil.saveRequest();

  16. }

  17. System.out.println("preHandle...");

  18. String requestUri = request.getRequestURI();

  19. String contextPath = request.getContextPath();

  20. String url = requestUri.substring(contextPath.length());

  21. System.out.println("requestUri" + requestUri);

  22. System.out.println("contextPath" + contextPath);

  23. System.out.println("url" + url);

  24. String username = (String) request.getSession().getAttribute("username");

  25. if(null == username){

  26. // 跳转到登录页面

  27. request.getRequestDispatcher("/WEB-INF/login.jsp").forward(request, response);

  28. return false;

  29. }

  30. else{

  31. return true;

  32. }

  33. }

  34. // 在业务处理器处理请求完成之后,生成视图之前执行

  35. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception{

  36. System.out.println("postHandle...");

  37. if(modelAndView != null){

  38. Map<String, String> map = new HashMap<String, String>();

  39. modelAndView.addAllObjects(map);

  40. }

  41. }

  42. // 在DispatcherServlet完全处理完请求之后被调用,可用于清理资源

  43. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception{

  44. System.out.println("afterCompletion...");

  45. }

  46. }


    拦截器是依赖Java反射机制来实现的。拦截器的实现,用到的是JDK实现的动态代理,我们都知道,JDK实现的动态代理,需要依赖接口。拦截器
是在面向切面编程中应用的,就是在你的service或者一个方法前调用一个方法,或者在方法后调用一个方法。拦截器不是在web.xml,比如struts在
struts.xml中配置。

 

 

 
  1. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

  2. Object result = null;

  3. System.out.println("方法调用前,可以执行一段代码" + method.getName());

  4. result = method.invoke(this.targetObj, args);

  5. System.out.println("方法调用后,可以执行一段代码 " + method.getName());

  6. return result;

  7. }


总结:
    1.过滤器(Filter):所谓过滤器顾名思义是用来过滤的,Java的过滤器能够为我们提供系统级别的过滤,也就是说,能过滤所有的web请求,
这一点,是拦截器无法做到的。在Java Web中,你传入的request,response提前过滤掉一些信息,或者提前设置一些参数,然后再传入servlet或
者struts的action进行业务逻辑,比如过滤掉非法url(不是login.do的地址请求,如果用户没有登陆都过滤掉),或者在传入servlet或者struts
的action前统一设置字符集,或者去除掉一些非法字符(聊天室经常用到的,一些骂人的话)。filter 流程是线性的,url传来之后,检查之后,
可保持原来的流程继续向下执行,被下一个filter, servlet接收。
    2.监听器(Listener):Java的监听器,也是系统级别的监听。监听器随web应用的启动而启动。Java的监听器在c/s模式里面经常用到,它
会对特定的事件产生产生一个处理。监听在很多模式下用到,比如说观察者模式,就是一个使用监听器来实现的,在比如统计网站的在线人数。
又比如struts2可以用监听来启动。Servlet监听器用于监听一些重要事件的发生,监听器对象可以在事情发生前、发生后可以做一些必要的处理。
    3.拦截器(Interceptor):java里的拦截器提供的是非系统级别的拦截,也就是说,就覆盖面来说,拦截器不如过滤器强大,但是更有针对性。
Java中的拦截器是基于Java反射机制实现的,更准确的划分,应该是基于JDK实现的动态代理。它依赖于具体的接口,在运行期间动态生成字节码。
拦截器是动态拦截Action调用的对象,它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码,也可以在一个Action执行前阻止其
执行,同时也提供了一种可以提取Action中可重用部分代码的方式。在AOP中,拦截器用于在某个方法或者字段被访问之前,进行拦截然后再之前或
者之后加入某些操作。java的拦截器主要是用在插件上,扩展件上比如 Hibernate Spring Struts2等,有点类似面向切片的技术,在用之前先要在
配置文件即xml,文件里声明一段的那个东西。

拦截器类 需要两个配合使用这里只有一个 @Configuration public class ServletContextConfig extends WebMvcConfigurerAdapter { public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/"); registry.addResourceHandler("/templates/**").addResourceLocations("classpath:/templates/"); super.addResourceHandlers(registry); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new HandlerMyInterceptorAdapter()).addPathPatterns("/**") .excludePathPatterns("/") // .excludePathPatterns("/expressions/getExpressionsList") .excludePathPatterns("/loginInfo/getCordByIsPhone") .excludePathPatterns("/loginInfo/login11") //token失效跳轉 .excludePathPatterns("/loginInfo/insertLoginInfo") //注册 .excludePathPatterns("/loginInfo/login") //登录 .excludePathPatterns("/upload") //上传文件 .excludePathPatterns("/uploadListen") //上传文件 .excludePathPatterns("/admin/user/goLogin") //后台跳转登录 .excludePathPatterns("/admin/user/login") //后台登录 .excludePathPatterns("/loginInfo/getLoginInfo") //忘记密码 .excludePathPatterns("/loginInfo/getCord") //短信验证码 .excludePathPatterns("/loginInfo/getIsLoginInfo") //判断验证码&&登录 .excludePathPatterns("/loginInfo/getIsLoginInfo1") //判断验证码 .excludePathPatterns("/loginInfo/setPassWord") //设置密码 ; } @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { configurer.enable(); } } @Component public class HandlerMyInterceptorAdapter implements HandlerInterceptor { @Autowired private HeartbeatServiceImpl heartbeatService; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException { String url = request.getRequestURI(); if (url.contains("admin")) { User user = (User) request.getSession().getAttribute("user"); try { if (user.equals(null)) { response.sendRedirect(serverConfig.SERVER + "admin/user/goLogin"); return false; } else { return true; } }catch (Exception e){ response.sendRedirect(serverConfig.SERVER + "admin/user/goLogin"); return false; } }else { String token = request.getHeader("token"); if (token != null) { Jedis jedis = new Jedis(com.sevenSteps.util.RedisConfig.HOST, RedisConfig.PORT); String s = jedis.get(token); if(token.equals(s)) { heartbeatService = SpringUtil.getBean(HeartbeatServiceImpl.class); return heartbeatService.setOutDate(token); }else { response.sendRedirect(serverConfig.SERVER + "loginInfo/login11"); return true; } }else { response.sendRedirect(serverConfig.SERVER + "loginInfo/login11"); return true; } } } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object o, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { } }
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值