• JavaWeb中监听器+过滤器+拦截器区别、配置和实际应用

    JavaWeb中监听器+过滤器+拦截器区别、配置和实际应用

    1.前沿上一篇文章提到在web.xml中各个元素的执行顺序是这样的，context-param-->listener-->filter-->servlet； 而拦截器是在Spring MVC中配置的，如果从整个项目中看，一个servlet请求的执行过程就变成了这样context-param-->listener-->filter-->servlet-->interceptor(指的是拦截器)，为什么拦截器是在servlet执行之后，因为拦截器本身就是在servlet内部的，下面把所学和所总结的用自己的描述整理出来~。另外本文的项目框架是基于上篇文章http://blog.csdn.net/Jintao_Ma/article/details/52892625 讲述的框架，下载路径：http://download.csdn.net/download/jintao_ma/9661038。

    2.概念

    context-param：就是一些需要初始化的配置，放入context-param中，从而被监听器（这里特指org.springframework.web.context.ContextLoaderListener）监听，然后加载；

    监听器(listener)：就是对项目起到监听的作用，它能感知到包括request(请求域)，session(会话域)和applicaiton(应用程序)的初始化和属性的变化；

    过滤器(filter)：就是对请求起到过滤的作用，它在监听器之后，作用在servlet之前，对请求进行过滤；

    servlet：就是对request和response进行处理的容器，它在filter之后执行，servlet其中的一部分就是controller层（标记为servlet_2），还包括渲染视图层(标记为servlet_3)和进入controller之前系统的一些处理部分(servlet_1)，另外我们把servlet开始的时刻标记为servlet_0，servlet结束的时刻标记为servlet_4。

    拦截器(interceptor)：就是对请求和返回进行拦截，它作用在servlet的内部，具体来说有三个地方：

    1）servlet_1和servlet_2之间，即请求还没有到controller层

    2）servlet_2和servlet_3之间，即请求走出controller层次，还没有到渲染时图层

    3）servlet_3和servlet_4之间，即结束视图渲染，但是还没有到servlet的结束

    它们之间的关系，可以用一张图来表示：

    3.使用原则

    对整个流程清楚之后，然后就是各自的使用，在使用之前应该有一个使用规则，为什么这个说，因为有些功能比如判断用户是否登录，既可以用过滤器，也可以用拦截器，用哪一个才是合理的呢？那么如果有一个原则，使用起来就会更加合理。实际上这个原则是有的：

    把整个项目的流程比作一条河，那么监听器的作用就是能够听到河流里的所有声音，过滤器就是能够过滤出其中的鱼，而拦截器则是拦截其中的部分鱼，并且作标记。所以当需要监听到项目中的一些信息，并且不需要对流程做更改时，用监听器；当需要过滤掉其中的部分信息，只留一部分时，就用过滤器；当需要对其流程进行更改，做相关的记录时用拦截器。下面是具体的使用案例

    本文涉及到的jsp页面：

    index.jsp:

    [html] view plain copy
     
    1. <%@ page language="java"  import="com.mycompany.mvc.listener.*" contentType="text/html; charset=UTF-8"  
    2.     pageEncoding="UTF-8"%>  
    3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
    4. <html>  
    5. <head>  
    6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
    7. <title>index.jsp</title>  
    8. </head>  
    9. <body>  
    10. this is index jsp  
    11. <!-- 这里应该填入用户名和密码 -->  
    12. <a href="/myWebApp/system/login">login</a>  
    13. <br></br>  
    14. 测试servletcontext：  
    15. <%  
    16. application.setAttribute("app","app");  
    17. application.getAttribute("app");  
    18. application.removeAttribute("app");  
    19. %>  
    20. <br></br>  
    21. 测试httpsession:  
    22. <%  
    23. session.setAttribute("app3","app3");  
    24. session.getAttribute("app3");  
    25. session.removeAttribute("app3");  
    26. %>  
    27. <br></br>  
    28. 测试servletrequest:  
    29. <%  
    30. request.setAttribute("app3","app3");  
    31. request.getAttribute("app3");  
    32. request.removeAttribute("app3");  
    33. %>  
    34. <br></br>  
    35. 当前在线人数：  
    36. <%=session.getAttribute("peopleOnLine")%>  
    37. <br></br>  
    38. HttpSessionBindingListener测试：  
    39. <%  
    40. session.setAttribute("bean",new myHttpSessionBindingListener());  
    41. session.removeAttribute("bean");  
    42. %>  
    43. </body>  
    44. </html>  

    login.jsp:

    [html] view plain copy
     
    1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  
    2. <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>  
    3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
    4. <html>  
    5. <head>  
    6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
    7. <title>main.jsp</title>  
    8. </head>  
    9.   
    10. <c:set var="ctx"  value="${pageContext.request.scheme}://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}" />  
    11. <script type="text/javascript" src="${ctx}/plugins/jquery-3.0.0/jquery-3.0.0.js"></script>  
    12. <script type="text/javascript">  
    13. </script>  
    14.   
    15. <body>  
    16. This is has login jsp  
    17. <a href="/myWebApp/system/view">view</a>  
    18. </body>  
    19. </html>  

    view.jsp:

    [html] view plain copy
     
    1. <%@ page language="java" contentType="text/html; charset=UTF-8"  
    2.     pageEncoding="UTF-8"%>  
    3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
    4. <html>  
    5. <head>  
    6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
    7. <title>view jsp</title>  
    8. </head>  
    9. <body>  
    10. 用户已经登陆，欢迎来到登陆后系统主界面  
    11. </body>  
    12. </html>  

    4.监听器

    4.1listener具体分为八种，能够监听包括request域，session域，application域的产生，销毁和属性的变化；

    具体使用，可以看之前转载一篇文章（再次感谢"孤傲苍狼"，他的主页http://www.cnblogs.com/xdp-gacl/）：http://blog.csdn.net/Jintao_Ma/article/details/51464124

    在配置完然后我们在web.xml中诸如下面的配置即可：

    [html] view plain copy
     
    1. <listener> <listener-class>  
    2.         com.mycompany.mvc.listener.myServletContextListener  
    3.     </listener-class>  
    4. </listener>  
    5. <listener>  
    6.     <listener-class>  
    7.         com.mycompany.mvc.listener.myServletContextAttributeListener  
    8.     </listener-class>  
    9. </listener>  

    4.2  listener实际应用

    4.2.1 获取当前在线人数

    [java] view plain copy
     
    1. package com.mycompany.mvc.listener;  
    2.   
    3. import javax.servlet.http.HttpSessionEvent;  
    4. import javax.servlet.http.HttpSessionListener;  
    5.   
    6. public class myHttpSessionListener implements HttpSessionListener{  
    7.   
    8.     public static int peopleOnLine = 0;  
    9.       
    10.     @Override  
    11.     public void sessionCreated(HttpSessionEvent arg0) {  
    12.         System.out.println("myHttpSessionListener.sessionCreated():"+arg0);  
    13.         peopleOnLine++;  
    14.         arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);  
    15.     }  
    16.   
    17.     @Override  
    18.     public void sessionDestroyed(HttpSessionEvent arg0) {  
    19.         System.out.println("myHttpSessionListener.sessionDestroyed():"+arg0);  
    20.         peopleOnLine--;  
    21.         arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);  
    22.     }  
    23. }  

    在页面中就可以获取：

    [html] view plain copy
     
    1. 当前在线人数：  
    2. <%=session.getAttribute("peopleOnLine")%>  

    其实也可以获得历史所有在线人数，只需要把历史所有在线人数保存在文件中，然后每次项目启动读取这个文件，当前人数增加时，把历史所有人数也相应增加，项目关闭时，再保存起来。

    4.2.2 在系统初始化时，获取项目绝对路径

    如下，获得绝对路径后保存到系统变量System中：

    [java] view plain copy
     
    1. @Override  
    2. public void contextInitialized(ServletContextEvent servletContext) {  
    3.     System.out.println("myServletContextListener.contextInitialized()");  
    4.     System.setProperty("realPath", servletContext.getServletContext().getRealPath("/"));  
    5.     System.out.println("myServletContextListener.contextInitialized()");  
    6. }  

    5.过滤器(filter)

    5.1过滤器只需要继承javax.servlet.filter即可，一般来说我们只要添加tomcat运行时环境就能够包含javax.servlet的jar包，但是eclipse在tomcat8中没有找到，实际上tomcat8中确实没有，只有通过maven来添加了：

    [html] view plain copy
     
    1. <!-- https://mvnrepository.com/artifact/javax.servlet/servlet-api -->  
    2.     <dependency>  
    3.         <groupId>javax.servlet</groupId>  
    4.         <artifactId>servlet-api</artifactId>  
    5.         <version>2.5</version>  
    6.     </dependency>  
    7.   
    8. <!-- https://mvnrepository.com/artifact/javax.servlet/jsp-api -->  
    9.     <dependency>  
    10.         <groupId>javax.servlet</groupId>  
    11.         <artifactId>jsp-api</artifactId>  
    12.         <version>2.0</version>  
    13.     </dependency>  

    5.2 filter的实际应用

    5.2.1 请求编码转换

    [java] view plain copy
     
    1. package com.mycompany.mvc.filter;  
    2.   
    3. import java.io.IOException;  
    4. import java.util.HashMap;  
    5. import java.util.Map;  
    6.   
    7. import javax.servlet.Filter;  
    8. import javax.servlet.FilterChain;  
    9. import javax.servlet.FilterConfig;  
    10. import javax.servlet.ServletException;  
    11. import javax.servlet.ServletRequest;  
    12. import javax.servlet.ServletResponse;  
    13.   
    14. import org.slf4j.Logger;  
    15. import org.slf4j.LoggerFactory;  
    16.   
    17. public class urlEncodeFilter implements Filter{  
    18.       
    19.     Logger logger = LoggerFactory.getLogger(urlEncodeFilter.class);  
    20.     Map<String,Object> paramMap = new HashMap<String,Object>();   
    21.   
    22.     @Override  
    23.     public void destroy() {  
    24.     }  
    25.   
    26.     @Override  
    27.     public void doFilter(ServletRequest arg0, ServletResponse arg1,  
    28.             FilterChain arg2) throws IOException, ServletException {  
    29.         System.out.println("urlEncodeFilter doFilter..."+paramMap.get("urlEncode").toString());  
    30.         arg0.setCharacterEncoding(paramMap.get("urlEncode").toString());  
    31.         arg2.doFilter(arg0, arg1);  
    32.     }  
    33.   
    34.     @Override  
    35.     public void init(FilterConfig arg0) throws ServletException {  
    36.         String urlEncode = arg0.getInitParameter("urlEncode");  
    37.         paramMap.put("urlEncode",urlEncode);  
    38.     }  
    39.       
    40. }  

    web.xml配置：

    [html] view plain copy
     
    1. <filter>  
    2.     <filter-name>urlEncodeFilter</filter-name>  
    3.     <filter-class>com.mycompany.mvc.filter.urlEncodeFilter</filter-class>  
    4.     <init-param>  
    5.         <param-name>urlEncode</param-name>  
    6.         <param-value>UTF-8</param-value>  
    7.     </init-param>  
    8. </filter>  
    [html] view plain copy
     
    1. <filter-mapping>  
    2.     <filter-name>urlEncodeFilter</filter-name>  
    3.     <url-pattern>/*</url-pattern>  
    4. </filter-mapping>  

    5.2.2  日志记录，比如记录所有对网站发起请求的地址

    [java] view plain copy
     
    1. package com.mycompany.mvc.filter;  
    2.   
    3. import java.io.IOException;  
    4.   
    5. import javax.servlet.Filter;  
    6. import javax.servlet.FilterChain;  
    7. import javax.servlet.FilterConfig;  
    8. import javax.servlet.ServletException;  
    9. import javax.servlet.ServletRequest;  
    10. import javax.servlet.ServletResponse;  
    11. import javax.servlet.http.HttpServletRequest;  
    12.   
    13. import org.slf4j.Logger;  
    14. import org.slf4j.LoggerFactory;  
    15.   
    16. public class logFilter implements Filter{  
    17.   
    18.     Logger logger = LoggerFactory.getLogger(logFilter.class);  
    19.       
    20.     @Override  
    21.     public void destroy() {  
    22.           
    23.     }  
    24.   
    25.     @Override  
    26.     public void doFilter(ServletRequest arg0, ServletResponse arg1,  
    27.             FilterChain arg2) throws IOException, ServletException {  
    28.         HttpServletRequest request = (HttpServletRequest)arg0;  
    29.         System.out.println("logFilter doFilter servletPath:"+request.getRemoteHost());  
    30.         arg2.doFilter(arg0, arg1);  
    31.     }  
    32.   
    33.     @Override  
    34.     public void init(FilterConfig arg0) throws ServletException {  
    35.     }  
    36.       
    37. }  

    web.xml:

    [html] view plain copy
     
    1. <filter>  
    2.     <filter-name>logFilter</filter-name>  
    3.     <filter-class>com.mycompany.mvc.filter.logFilter</filter-class>  
    4. </filter>  
    [html] view plain copy
     
    1. <filter-mapping>  
    2.     <filter-name>logFilter</filter-name>  
    3.     <url-pattern>/*</url-pattern>  
    4. </filter-mapping>  

    5.2.3  对未登陆用户的判断

    [java] view plain copy
     
    1. package com.mycompany.mvc.filter;  
    2.   
    3. import java.io.IOException;  
    4.   
    5. import javax.servlet.Filter;  
    6. import javax.servlet.FilterChain;  
    7. import javax.servlet.FilterConfig;  
    8. import javax.servlet.ServletException;  
    9. import javax.servlet.ServletRequest;  
    10. import javax.servlet.ServletResponse;  
    11. import javax.servlet.http.HttpServletRequest;  
    12. import javax.servlet.http.HttpSession;  
    13.   
    14. import org.apache.commons.lang.StringUtils;  
    15.   
    16. import com.mycompany.mvc.utils.Constant;  
    17.   
    18. public class loginFilter implements Filter{  
    19.       
    20.     private String dispatchUrl = "";  
    21.     private String excludeUrl = "";  
    22.       
    23.     @Override  
    24.     public void destroy() {  
    25.           
    26.     }  
    27.   
    28.     @Override  
    29.     public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)  
    30.             throws IOException, ServletException {  
    31.         HttpServletRequest request = (HttpServletRequest)arg0;  
    32.         String servletPath = request.getServletPath();  
    33.           
    34.         HttpSession session = request.getSession();  
    35.         String sessionKey = (String) session.getAttribute(Constant.SESSIONKEY);  
    36.           
    37.         /*就是登陆界面不进行过滤*/  
    38.         if(servletPath.equals(dispatchUrl) || servletPath.equals(excludeUrl)){  
    39.             arg2.doFilter(arg0, arg1);  
    40.         }else{  
    41.             if(!StringUtils.isEmpty(sessionKey)){  
    42.                 arg2.doFilter(arg0, arg1);  
    43.             }else{  
    44.                 request.getRequestDispatcher(dispatchUrl).forward(arg0, arg1);  
    45.             }  
    46.         }  
    47.     }  
    48.   
    49.     @Override  
    50.     public void init(FilterConfig arg0) throws ServletException {  
    51.         dispatchUrl = arg0.getInitParameter("dispatchUrl");  
    52.         excludeUrl = arg0.getInitParameter("excludeUrl");  
    53.     }  
    54.   
    55. }  

    web.xml:

    [html] view plain copy
     
    1. <filter>  
    2.     <filter-name>loginFilter</filter-name>  
    3.     <filter-class>com.mycompany.mvc.filter.loginFilter</filter-class>  
    4.     <init-param>  
    5. <!--         不进行过滤的url，因为它就是跳转到登陆界面, -->  
    6.         <param-name>excludeUrl</param-name>  
    7.         <param-value>/main</param-value>  
    8.     </init-param>  
    9.     <init-param>  
    10. <!--         未登录用户跳转的url -->  
    11.         <param-name>dispatchUrl</param-name>  
    12.         <param-value>/system/login</param-value>  
    13.     </init-param>  
    14. </filter>  
    [html] view plain copy
     
    1. <filter-mapping>  
    2.     <filter-name>loginFilter</filter-name>  
    3.     <url-pattern>/*</url-pattern>  
    4. </filter-mapping>  

    之所以上面的/main能够直接跳转到index这个登陆界面，是因为SpringMvc中配置了这个（上篇文章有讲述到）：

    <mvc:view-controller path="${adminPath}" view-name="index"/>

    它的意思就是不经过controller层，直接把index放入ModelAndView，然后由渲染层进行渲染。 讲到这里，再结合上面说到的拦截器，我们发现，这个时候拦截器还是能够拦截2次的，就是视图渲染前和渲染后，但是进入controller层之前肯定拦截不到了，因为请求根本就没有进入controller。

    systemAction:

    [java] view plain copy
     
    1. package com.mycompany.system.controller;  
    2.   
    3. import javax.servlet.http.HttpServletRequest;  
    4. import javax.servlet.http.HttpSession;  
    5.   
    6. import org.springframework.stereotype.Controller;  
    7. import org.springframework.web.bind.annotation.RequestMapping;  
    8. import org.springframework.web.servlet.ModelAndView;  
    9.   
    10. @Controller  
    11. @RequestMapping("/system")  
    12. public class systemAction {  
    13.       
    14.     @RequestMapping("/login")  
    15.     public ModelAndView login(HttpServletRequest request){  
    16.         ModelAndView mv = new ModelAndView();  
    17.         HttpSession session = request.getSession();  
    18.         /*假设用户输入的用户名密码正确，则放入sessionKey中，对应的value可以 
    19.          * 是User对象，这里以字符串"test"代替*/  
    20.         session.setAttribute("sessionKey","test");  
    21.         mv.setViewName("login");  
    22.         return mv;  
    23.     }  
    24.       
    25.     @RequestMapping("/view")  
    26.     public ModelAndView view(HttpServletRequest request){  
    27.         ModelAndView mv = new ModelAndView();  
    28.         mv.setViewName("view");  
    29.         return mv;  
    30.     }  
    31.       
    32. }  

    Constant.java:

    [java] view plain copy
     
    1. package com.mycompany.mvc.utils;  
    2.   
    3. public class Constant {  
    4.   
    5.     public static final String SESSIONKEY = "sessionKey";  
    6.       
    7. }  

    6.拦截器(interceptor)

    6.1 拦截器这个要详细讲述一下了，上一篇文章说到，Spring的配置文件应该扫描service层及以下，SpringMvc的配置文件应该扫描controller层； 我们在service层如果想做日志的话，可以使用spring aop特性，在spring.xml中配置aspect即可，那么如果想在controller层做日志，相应地，在SpringMvc.xml中应该怎么配置呢？

    这个时候就需要拦截器，它其实也是一种aop的实现(aop本身是一种思想)，而且这种实现本质上和aspect是一样的，只是做了更多的事情，我们当然可以在SpringMvc.xml中也配置aspect，不过现在有一个更好的实现，为什么不用呢。 

    关于拦截器细节，可以参考这篇文章：http://elim.iteye.com/blog/1750680

    6.2 拦截器的实际应用

    6.2.1 可以全局做日志

    [java] view plain copy
     
    1. package com.mycompany.mvc.interceptor;  
    2.   
    3. import java.lang.reflect.Method;  
    4.   
    5. import javax.servlet.http.HttpServletRequest;  
    6. import javax.servlet.http.HttpServletResponse;  
    7.   
    8. import org.springframework.web.method.HandlerMethod;  
    9. import org.springframework.web.servlet.HandlerInterceptor;  
    10. import org.springframework.web.servlet.ModelAndView;  
    11. /**@Description 
    12.  * logInterceptor公共拦截器，做日志记录 
    13.  */  
    14. public class logInterceptor implements HandlerInterceptor{  
    15.   
    16.     @Override  
    17.     public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)  
    18.             throws Exception {  
    19.         /*做一些清理工作*/  
    20.     }  
    21.   
    22.     @Override  
    23.     public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)  
    24.             throws Exception {  
    25.         System.out.println("logInterceptor.postHandle()---view Name:"+arg3.getViewName());  
    26.     }  
    27.   
    28.     @Override  
    29.     public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {  
    30.         /*取得调用的controller方法等*/  
    31.         if(arg2 instanceof HandlerMethod){  
    32.             HandlerMethod hMethod = (HandlerMethod)arg2;  
    33.             Method method = hMethod.getMethod();  
    34.             System.out.println("logInterceptor.preHandle()--method Name:"+method.getName());  
    35.         }  
    36.         return true;  
    37.     }  
    38.   
    39. }  

    6.2.2 记录部分调用的时间

    [java] view plain copy
     
    1. package com.mycompany.mvc.interceptor;  
    2.   
    3. import javax.servlet.http.HttpServletRequest;  
    4. import javax.servlet.http.HttpServletResponse;  
    5.   
    6. import org.springframework.web.servlet.HandlerInterceptor;  
    7. import org.springframework.web.servlet.ModelAndView;  
    8. /**@Description 
    9.  * 登陆时间拦截器，记录用户登录时间 
    10.  * */  
    11. public class timeInterceptor implements HandlerInterceptor{  
    12.   
    13.     @Override  
    14.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  
    15.             throws Exception {  
    16.         return true;  
    17.     }  
    18.   
    19.     @Override  
    20.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,  
    21.             ModelAndView modelAndView) throws Exception {  
    22.         System.out.println("timeInterceptor.postHandle()--time:"+System.currentTimeMillis());  
    23.     }  
    24.   
    25.     @Override  
    26.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)  
    27.             throws Exception {  
    28.     }  
    29.   
    30. }  

    上述两个拦截器功能的配置如下，SpringMvc.xml:

    [html] view plain copy
     
    1. <!--     拦截器配置 -->  
    2. <mvc:interceptors>  
    3.     <bean class="com.mycompany.mvc.interceptor.logInterceptor"></bean>  
    4.     <mvc:interceptor>  
    5.         <mvc:mapping path="/system/view"/>      
    6.         <bean class="com.mycompany.mvc.interceptor.timeInterceptor"></bean>  
    7.     </mvc:interceptor>  
    8. </mvc:interceptors>  
  • 相关阅读:
    常用第三方快递鸟单号查询Api接口免费对接调用攻略
    Solution -「CF 1477A」Nezzar and Board
    Solution -「THUPC 2021」区间矩阵乘法
    Solution Set -「CF 1520」
    Solution -「HNOI 2010」城市建设
    Solution -「NOI 2007」货币兑换
    Solution -「洛谷 P6156」简单题
    Solution -「YunoOI 2017」由乃的 OJ
    Journey -「CQOI 2021」
    Note -「SOS DP」高维前缀和
  • 原文地址：https://www.cnblogs.com/du-0210/p/8384436.html
Copyright © 2020-2023  润新知