ウェブサイト検索

ServletContextListener サーブレットリスナーの例


ServletContextListenerは、多くのServlet Listenerの一つです。これはJava Web Applicationに関するシリーズの第五の記事であり、以前の四つの記事もぜひご覧ください。

  1. Javaウェブアプリケーション
  2. Javaのサーブレット
  3. サーブレットセッション管理
  4. サーブレットフィルター

サーブレットリスナー

このチュートリアルでは、サーブレットリスナー、サーブレットリスナーの利点、リスナーでできる一般的な作業、サーブレットAPIリスナーインターフェース、イベントオブジェクトについて見ていきます。最後に、ServletContext、Session、および ServletRequest の一般的に使用されるリスナー実装の例を示すシンプルなWebプロジェクトを作成します。

  1. なぜサーブレットリスナーが必要ですか?

  2. サーブレットリスナーインターフェースとイベントオブジェクト

  3. サーブレットリスナーの設定

  4. サーブレットリスナーの例

  5. サーブレットコンテキストリスナー

  6. ServletContext属性リスナー

  7. HttpSessionListener

  8. サーブレットリクエストリスナー

  9. なぜサーブレットリスナーが必要なのですか?

私たちは、ServletContextを使用することで、他のすべてのサーブレットがアクセスできるアプリケーションスコープの属性を作成できることを知っていますが、初期化パラメータをStringのみとして設定することができるのは、デプロイメントディスクリプタ(web.xml)です。私たちのアプリケーションがデータベース指向であり、データベース接続のためにServletContextに属性を設定したい場合、アプリケーションに単一のエントリーポイント(ユーザーログイン)があるなら、最初のサーブレットリクエストでそれを行うことができますが、複数のエントリーポイントがある場合、どこでもそれを行うと、多くのコードの冗長性が生じます。また、データベースがダウンしているか、適切に構成されていない場合、最初のクライアントリクエストがサーバーに到達するまで分かりません。これらのシナリオに対処するために、サーブレットAPIは、イベントをリッスンし、特定の操作を行うために実装して構成できるリスナーインターフェースを提供します。 イベントとは何かが発生することを指し、ウェブアプリケーションの世界では、イベントはアプリケーションの初期化、アプリケーションの破棄、クライアントからのリクエスト、セッションの作成/破棄、セッション内の属性修正などとして考えられます。サーブレットAPIは、特定のイベントが発生した際に何かを処理するために実装およびweb.xmlで設定できるさまざまな種類のリスナーインターフェースを提供しています。たとえば、上記のシナリオでは、アプリケーションの起動イベント用にリスナーを作成して、コンテキスト初期パラメータを読み取ったり、データベース接続を作成して他のリソースが使用できるようにコンテキスト属性に設定することができます。8. ### サーブレットリスナーインターフェースとイベントオブジェクト

Servlet APIは、異なる種類のイベントに対して異なるリスナーを提供します。リスナーインターフェースは、類似のイベントのグループに対処するためのメソッドを宣言します。たとえば、コンテキストの起動およびシャットダウンイベントをリッスンするためのServletContextリスナーがあります。リスナーインターフェース内のすべてのメソッドは、入力としてEventオブジェクトを受け取ります。Eventオブジェクトは、リスナーに特定のオブジェクトを提供するためのラッパーとして機能します。Servlet APIは、以下のイベントオブジェクトを提供します。

  1. javax.servlet.AsyncEvent - サーブレットリクエストで開始された非同期操作が完了したとき、タイムアウトしたとき、またはエラーが発生したときに発生するイベントです(ServletRequest#startAsyncまたはServletRequest#startAsync(ServletRequest, ServletResponse)を呼び出すことによって)。
  2. javax.servlet.http.HttpSessionBindingEvent - このタイプのイベントは、セッションにバインドまたはアンバインドされるときに、HttpSessionBindingListenerを実装するオブジェクトに送信されるか、またはセッション内で任意の属性がバインド、アンバインド、または置き換えられるときにweb.xmlに設定されたHttpSessionAttributeListenerに送信されます。セッションはHttpSession.setAttributeの呼び出しによってオブジェクトをバインドし、HttpSession.removeAttributeの呼び出しによってオブジェクトのバインディングを解除します。このイベントは、オブジェクトがセッションから削除されるときのクリーンアップアクティビティに使用できます。
  3. javax.servlet.http.HttpSessionEvent - これはウェブアプリケーション内のセッションの変更に関するイベント通知を表すクラスです。
  4. javax.servlet.ServletContextAttributeEvent - WebアプリケーションのServletContextの属性に対する変更に関する通知のためのイベントクラス。
  5. javax.servlet.ServletContextEvent - これはウェブアプリケーションのサーブレットコンテキストに対する変更についての通知のためのイベントクラスです。
  6. javax.servlet.ServletRequestEvent - この種のイベントは、ServletRequestのライフサイクルイベントを示します。イベントのソースは、このWebアプリケーションのServletContextです。
  7. javax.servlet.ServletRequestAttributeEvent - これは、アプリケーション内のサーブレットリクエストの属性に対する変更の通知のためのイベントクラスです。

Servlet APIは、以下のリスナーインターフェースを提供します。

  1. javax.servlet.AsyncListener - リスナが追加されたServletRequestで開始された非同期操作が完了、タイムアウト、またはエラーが発生した場合に通知されるリスナーです。

  2. javax.servlet.ServletContextListener - ServletContextのライフサイクルの変化に関する通知イベントを受け取るためのインターフェース。

  3. javax.servlet.ServletContextAttributeListener - ServletContext属性の変更に関する通知イベントを受信するためのインターフェース。

  4. javax.servlet.ServletRequestListener - ウェブアプリケーションのスコープに入るおよび出るリクエストに関する通知イベントを受け取るためのインターフェースです。

  5. javax.servlet.ServletRequestAttributeListener - ServletRequest属性の変更に関する通知イベントを受信するためのインターフェース。

  6. javax.servlet.http.HttpSessionListener - HttpSessionライフサイクルの変更に関する通知イベントを受信するためのインターフェース。

  7. javax.servlet.http.HttpSessionBindingListener - オブジェクトがセッションにバインドされるか、セッションからアンバインドされるときに通知される原因となる。

  8. javax.servlet.http.HttpSessionAttributeListener - HttpSession属性の変更に関する通知イベントを受信するためのインターフェース。

  9. javax.servlet.http.HttpSessionActivationListener - セッションにバインドされているオブジェクトは、セッションがパッシベーションされることやセッションがアクティブ化されることを通知するコンテナイベントをリッスンすることができます。VM間でセッションを移動させたり、セッションを永続化するコンテナは、HttpSessionActivationListenerを実装しているセッションにバインドされたすべての属性に通知する必要があります。

  10. サーブレットリスナーの設定

@WebListener アノテーションを使用してクラスをリスナーとして宣言できますが、そのクラスは1つ以上のリスナーインターフェースを実装する必要があります。リスナーはweb.xmlで次のように定義できます:

<listener>
    <listener-class>
    com.journaldev.listener.AppContextListener
    </listener-class>
</listener>
  1. サーブレットリスナーの例

サーブレットリスナーの動作を確認するために、簡単なウェブアプリケーションを作成しましょう。EclipseでServletListenerExampleという動的ウェブプロジェクトを作成します。このプロジェクトの構造は下の画像のようになります。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://java.sun.com/xml/ns/javaee" xsi:schemaLocation="https://java.sun.com/xml/ns/javaee https://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: これはデータベース接続のためのクラスです。簡単のため、実際のデータベース接続のコードは提供しません。このオブジェクトをサーブレットコンテキストの属性として設定します。

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: セッション、属性などで作業するシンプルなサーブレットクラスです。

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。27. ## ServletContextListener

サーブレットコンテキストの初期パラメータを読み取り、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.");
    	
    }
	
}
  1. ServletContext属性リスナー

属性がサーブレットコンテキストに追加、削除、または置き換えられたときにイベントをログするシンプルな実装。

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()+"}");
    }
	
}
  1. 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());
    }
	
}
  1. サーブレットリクエストリスナー

リクエストが初期化され、破棄される際にServletRequestのIPアドレスをログするためのServletRequestListenerインターフェースのシンプルな実装。

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 https://localhost:8080/ServletListenerExample/MyServletを使用してMyServletにアクセスすると、サーバーログファイルに以下のログが表示されます。

ServletContext attribute added::{DBManager,com.journaldev.db.DBConnectionManager@4def3d1b}
Database connection initialized for Application.
ServletContext attribute added::{org.apache.jasper.compiler.TldLocationsCache,org.apache.jasper.compiler.TldLocationsCache@1594df96}

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.

ログのシーケンスに注目し、それが実行順序にあることを確認してください。最後のログは、アプリケーションをシャットダウンするか、コンテナをシャットダウンすると表示されます。

これでリスナーのサーブレットについては終了です。次はクッキーといくつかの一般的なサーブレットの例を見ていきます。プロジェクトは以下のリンクからダウンロードできるので、自由に使ってもっと学んでみてください。

ダウンロード サーブレット リスナーのサンプルプロジェクト

シリーズの次の記事サーブレットにおけるクッキーをご覧ください。

関連記事: