碼上快樂

相關內容    簡體    繁體

JavaWeb中監聽器+過濾器+攔截器區別、配置和實際應用

本文轉載自   查看原文   2019-06-05 15:26   2022    java

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:

 

  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:

 

  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:

 

  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中諸如下面的配置即可：

 

  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 獲取當前在線人數

  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來添加了：

 

  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 請求編碼轉換

 

  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配置：

 

 

  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>  

 

  1. <filter-mapping>  
  2.     <filter-name>urlEncodeFilter</filter-name>  
  3.     <url-pattern>/*</url-pattern>  
  4. </filter-mapping> 

5.2.2  日志記錄，比如記錄所有對網站發起請求的地址

 

 

  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:

 

  1. <filter>  
  2.     <filter-name>logFilter</filter-name>  
  3.     <filter-class>com.mycompany.mvc.filter.logFilter</filter-class>  
  4. </filter>  

 

  1. <filter-mapping>  
  2.     <filter-name>logFilter</filter-name>  
  3.     <url-pattern>/*</url-pattern>  
  4. </filter-mapping>  

5.2.3  對未登陸用戶的判斷

 

  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:

 

  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>  

 

  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:

 

 

  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:

 

  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 可以全局做日志

 

 

  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 記錄部分調用的時間

 

  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:

 

  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> 

 

from:https://blog.csdn.net/smxjant/article/details/78912820

 更詳細的web.xml解釋，請參考：

https://blog.csdn.net/ahou2468/article/details/79015251

 


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 過濾器、監聽器、攔截器的區別 過濾器，攔截器，監聽器的區別 過濾器，攔截器，監聽器的區別 過濾器、監聽器、攔截器的區別 過濾器、攔截器和監聽器區別 JavaWeb-攔截器，過濾器，監聽器的區別和執行順序 3.JavaWeb過濾器/攔截器/監聽器及AOP編程的理解 過濾器、監聽器、攔截器 springBoot的過濾器，監聽器，攔截器 java 攔截器、過濾器、監聽器
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM