Servlet監聽器(Listener)
web.xml的載入順序是:【Context-Param】->【Listener】->【Filter】->【Servlet】,而同個型別之間的實際程式呼叫的時候的順序是根據對應的Mapping的順序進行呼叫。
為什麼使用Servlet Listener?
我們知道使用ServletContext
,我們可以建立一個具有所有其他servlet可以訪問的應用範圍的屬性,但是我們可以在部署描述符(web.xml)中將ServletContext init引數初始化為String。如果我們的應用程式是面向資料庫的,並且我們要在資料庫連線的ServletContext中設定一個屬性,該怎麼辦?如果應用程式具有單個入口點(使用者登入),那麼可以在第一個Servlet請求中執行,但是如果我們有多個入口點,那麼在任何地方都會執行程式碼冗餘。另外,如果資料庫關閉或配置不正確,我們將不會知道,直到第一個客戶端請求到達伺服器。為了處理這些情況,Servlet API提供了Listener介面,我們可以實現和配置監聽事件並執行某些操作。
事件(Event)是發生的事情,在Web應用程式世界中,事件可以是應用程式的初始化,銷燬應用程式,從客戶端請求,建立/銷燬會話,會話中的屬性修改等。
Servlet API提供了不同型別的偵聽器介面,我們可以在web.xml中實現和配置,以便在特定事件發生時處理某些事件。例如,在上述情況下,我們可以為應用程式啟動事件建立一個偵聽器來讀取上下文初始化引數並建立資料庫連線,並將其設定為上下文屬性以供其他資源使用。
Servlet Listener介面和事件(Event)物件
Servlet API為不同型別的事件提供了不同型別的偵聽器。偵聽器介面宣告方法來處理一組類似的事件,例如我們有ServletContext Listener監聽上下文的啟動和關閉事件。偵聽器介面中的每個方法都將事件物件作為輸入。事件物件作為一個包裝器,為偵聽器提供特定的物件。
Servlet API提供以下事件物件:
- javax.servlet.AsyncEvent - 在ServletRequest(通過呼叫ServletRequest#startAsync或ServletRequest#startAsync(ServletRequest,ServletResponse))啟動的非同步操作已完成,超時或產生錯誤時觸發的事件。
- javax.servlet.http.HttpSessionBindingEvent - 將此型別的事件傳送到實現HttpSessionBindingListener的物件,當該物件從會話繫結或解除繫結時,或者傳送到在web.xml中配置的HttpSessionAttributeListener,當繫結任何屬性時,在會話中取消繫結或替換。會話通過對HttpSession.setAttribute的呼叫來繫結物件,並通過呼叫HttpSession.removeAttribute解除物件的繫結。當物件從會話中刪除時,我們可以使用此事件進行清理活動。
- javax.servlet.http.HttpSessionEvent - 這是表示Web應用程式中會話更改的事件通知的類。
- javax.servlet.ServletContextAttributeEvent - 關於對Web應用程式的ServletContext的屬性進行更改的通知的事件類。
- javax.servlet.ServletContextEvent - 這是關於Web應用程式的servlet上下文更改的通知的事件類。
- javax.servlet.ServletRequestEvent - 此類事件表示ServletRequest的生命週期事件。事件的原始碼是這個Web應用程式的ServletContext。
- javax.servlet.ServletRequestAttributeEvent - 這是事件類,用於對應用程式中servlet請求的屬性進行更改的通知。
Servlet API提供了以下監聽器介面:
- javax.servlet.AsyncListener - 如果在添加了偵聽器的ServletRequest上啟動的非同步操作已完成,超時或導致錯誤,將會通知偵聽器。
- javax.servlet.ServletContextListener - 用於接收關於ServletContext生命週期更改的通知事件的介面。
- javax.servlet.ServletContextAttributeListener - 接收關於ServletContext屬性更改的通知事件的介面。
- javax.servlet.ServletRequestListener - 用於接收關於進入和超出Web應用程式範圍的請求的通知事件的介面。
- javax.servlet.ServletRequestAttributeListener - 接收關於ServletRequest屬性更改的通知事件的介面。
- javax.servlet.http.HttpSessionListener - 接收關於HttpSession生命週期更改的通知事件的介面。
- javax.servlet.http.HttpSessionBindingListener - 使物件從會話繫結到繫結或從其繫結時被通知。
- javax.servlet.http.HttpSessionAttributeListener - 用於接收關於HttpSession屬性更改的通知事件的介面。
- javax.servlet.http.HttpSessionActivationListener - 繫結到會話的物件可能會偵聽容器事件,通知他們會話將被鈍化,該會話將被啟用。需要在VM或持久化會話之間遷移會話的容器來通知繫結到實現HttpSessionActivationListener的會話的所有屬性。
Servlet Listener配置
我們可以使用@WebListener註解來宣告一個類作為Listener,但是該類應該實現一個或多個Listener介面。
我們可以在web.xml中定義listener:
<listener> <listener-class> com.journaldev.listener.AppContextListener </listener-class> </listener>
Servlet Listener示例
讓我們建立一個簡單的Web應用程式來檢視Servlet偵聽器的操作。我們將在Eclipse ServletListenerExample中建立動態Web專案,這些專案結構將如下圖所示。
web.xml:在部署描述符中,我將定義一些上下文初始化引數和監聽器配置。
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <display-name>ServletListenerExample</display-name> <context-param> <param-name>DBUSER</param-name> <param-value>pankaj</param-value> </context-param> <context-param> <param-name>DBPWD</param-name> <param-value>password</param-value> </context-param> <context-param> <param-name>DBURL</param-name> <param-value>jdbc:mysql://localhost/mysql_db</param-value> </context-param> <listener> <listener-class>com.journaldev.listener.AppContextListener</listener-class> </listener> <listener> <listener-class>com.journaldev.listener.AppContextAttributeListener</listener-class> </listener> <listener> <listener-class>com.journaldev.listener.MySessionListener</listener-class> </listener> <listener> <listener-class>com.journaldev.listener.MyServletRequestListener</listener-class> </listener> </web-app>
DBConnectionManager:這是資料庫連線的類,為了簡單起見,我沒有為實際的資料庫連線提供程式碼。我們將這個物件設定為servlet上下文的屬性。
package com.journaldev.db; import java.sql.Connection; public class DBConnectionManager { private String dbURL; private String user; private String password; private Connection con; public DBConnectionManager(String url, String u, String p){ this.dbURL=url; this.user=u; this.password=p; //create db connection now } public Connection getConnection(){ return this.con; } public void closeConnection(){ //close DB connection here } }
MyServlet:一個簡單的servlet類,我將使用會話,屬性等。
package com.journaldev.servlet; import java.io.IOException; import java.io.PrintWriter; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; @WebServlet("/MyServlet") public class MyServlet extends HttpServlet { private static final long serialVersionUID = 1L; protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { ServletContext ctx = request.getServletContext(); ctx.setAttribute("User", "Pankaj"); String user = (String) ctx.getAttribute("User"); ctx.removeAttribute("User"); HttpSession session = request.getSession(); session.invalidate(); PrintWriter out = response.getWriter(); out.write("Hi "+user); } }
現在我們將實現監聽器類,我為常用的監聽器提供了示例偵聽器類 - ServletContextListener,ServletContextAttributeListener,ServletRequestListener和HttpSessionListener。
ServletContextListener
我們將讀取servlet context init引數來建立DBConnectionManager物件,並將其設定為ServletContext物件的屬性。
package com.journaldev.listener; import javax.servlet.ServletContext; import javax.servlet.ServletContextEvent; import javax.servlet.ServletContextListener; import javax.servlet.annotation.WebListener; import com.journaldev.db.DBConnectionManager; @WebListener public class AppContextListener implements ServletContextListener { public void contextInitialized(ServletContextEvent servletContextEvent) { ServletContext ctx = servletContextEvent.getServletContext(); String url = ctx.getInitParameter("DBURL"); String u = ctx.getInitParameter("DBUSER"); String p = ctx.getInitParameter("DBPWD"); //create database connection from init parameters and set it to context DBConnectionManager dbManager = new DBConnectionManager(url, u, p); ctx.setAttribute("DBManager", dbManager); System.out.println("Database connection initialized for Application."); } public void contextDestroyed(ServletContextEvent servletContextEvent) { ServletContext ctx = servletContextEvent.getServletContext(); DBConnectionManager dbManager = (DBConnectionManager) ctx.getAttribute("DBManager"); dbManager.closeConnection(); System.out.println("Database connection closed for Application."); } }
ServletContextAttributeListener
在servlet上下文中新增,刪除或替換屬性時,記錄事件的簡單實現。
package com.journaldev.listener; import javax.servlet.ServletContextAttributeEvent; import javax.servlet.ServletContextAttributeListener; import javax.servlet.annotation.WebListener; @WebListener public class AppContextAttributeListener implements ServletContextAttributeListener { public void attributeAdded(ServletContextAttributeEvent servletContextAttributeEvent) { System.out.println("ServletContext attribute added::{"+servletContextAttributeEvent.getName()+","+servletContextAttributeEvent.getValue()+"}"); } public void attributeReplaced(ServletContextAttributeEvent servletContextAttributeEvent) { System.out.println("ServletContext attribute replaced::{"+servletContextAttributeEvent.getName()+","+servletContextAttributeEvent.getValue()+"}"); } public void attributeRemoved(ServletContextAttributeEvent servletContextAttributeEvent) { System.out.println("ServletContext attribute removed::{"+servletContextAttributeEvent.getName()+","+servletContextAttributeEvent.getValue()+"}"); } }
HttpSessionListener
建立或銷燬會話時記錄事件的簡單實現。
package com.journaldev.listener; import javax.servlet.annotation.WebListener; import javax.servlet.http.HttpSessionEvent; import javax.servlet.http.HttpSessionListener; @WebListener public class MySessionListener implements HttpSessionListener { public void sessionCreated(HttpSessionEvent sessionEvent) { System.out.println("Session Created:: ID="+sessionEvent.getSession().getId()); } public void sessionDestroyed(HttpSessionEvent sessionEvent) { System.out.println("Session Destroyed:: ID="+sessionEvent.getSession().getId()); } }
ServletRequestListener
ServletRequestListener介面的簡單實現,用於在請求初始化和銷燬時記錄ServletRequest IP地址。
package com.journaldev.listener; import javax.servlet.ServletRequest; import javax.servlet.ServletRequestEvent; import javax.servlet.ServletRequestListener; import javax.servlet.annotation.WebListener; @WebListener public class MyServletRequestListener implements ServletRequestListener { public void requestDestroyed(ServletRequestEvent servletRequestEvent) { ServletRequest servletRequest = servletRequestEvent.getServletRequest(); System.out.println("ServletRequest destroyed. Remote IP="+servletRequest.getRemoteAddr()); } public void requestInitialized(ServletRequestEvent servletRequestEvent) { ServletRequest servletRequest = servletRequestEvent.getServletRequest(); System.out.println("ServletRequest initialized. Remote IP="+servletRequest.getRemoteAddr()); } }
現在,當我們將使用URL部署我們的應用程式並在瀏覽器中訪問MyServlet時http://localhost:8080/ServletListenerExample/MyServlet
,我們將在伺服器日誌檔案中看到以下日誌。
ServletContext attribute added::{DBManager,[email protected]} Database connection initialized for Application. ServletContext attribute added::{org.apache.jasper.compiler.TldLocationsCache,[email protected]} ServletRequest initialized. Remote IP=0:0:0:0:0:0:0:1%0 ServletContext attribute added::{User,Pankaj} ServletContext attribute removed::{User,Pankaj} Session Created:: ID=8805E7AE4CCCF98AFD60142A6B300CD6 Session Destroyed:: ID=8805E7AE4CCCF98AFD60142A6B300CD6 ServletRequest destroyed. Remote IP=0:0:0:0:0:0:0:1%0 ServletRequest initialized. Remote IP=0:0:0:0:0:0:0:1%0 ServletContext attribute added::{User,Pankaj} ServletContext attribute removed::{User,Pankaj} Session Created:: ID=88A7A1388AB96F611840886012A4475F Session Destroyed:: ID=88A7A1388AB96F611840886012A4475F ServletRequest destroyed. Remote IP=0:0:0:0:0:0:0:1%0 Database connection closed for Application.
注意日誌的順序,它按照執行的順序。當您關閉應用程式或關閉容器時,將顯示最後一個日誌。