ServletContextListener アプリの起動時と終了時に処理を追加

ServletContextListener を使って、Webアプリの起動時と終了時に処理を追加する方法を書いていきます。

バージョン

サーブレットのバージョンは以下の通りです。

Servlet 5.0（JakartaEE 9）

動作確認用プロダクト

動作確認のために、以下の製品を使用しました。

Java 17
Maven 3.8.6
Jetty Maven Plugin 11.0.15

1. リスナーの作成

ServletContextListener を実装するクラスを作成します。

org/example/listener/ContextListener.java

package org.example.listener;

import jakarta.servlet.ServletContextEvent;
import jakarta.servlet.ServletContextListener;
import jakarta.servlet.annotation.WebListener;

@WebListener
public class ContextListener implements ServletContextListener {
  // Webアプリの初期化が開始される時に実行されます。
  @Override
  public void contextInitialized(ServletContextEvent sce) {
    System.out.println("起動時の処理");
  }

  // ServletContext がシャットダウンされる時に実行されます。
  @Override
  public void contextDestroyed(ServletContextEvent sce) {
    System.out.println("終了時の処理");
  }
}

アノテーション @WebListener を付けて、サーブレットコンテナに認識されるようにしています。

2. ディレクトリ階層の作成

動作確認をする場合、プロジェクト sample-servlet のディレクトリ階層を作成します。

mkdir sample-servlet
cd sample-servlet
mkdir src\main\java
mkdir src\main\webapp\WEB-INF

作成したら、src/main/java 配下にコードを置きます。

3. pom.xml の作成

フォルダ sample-servlet に pom.xml を作成します。

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.example</groupId>
  <artifactId>sample-servlet</artifactId>
  <version>1.0.0</version>
  <packaging>war</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>jakarta.servlet</groupId>
      <artifactId>jakarta.servlet-api</artifactId>
      <version>5.0.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>${project.artifactId}</finalName>
    <plugins>
      <plugin>
        <artifactId>maven-war-plugin</artifactId>
        <version>3.4.0</version>
      </plugin>
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>11.0.15</version>
        <configuration>
          <scan>1</scan>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

サーブレットコンテナを起動できるように、build で Jetty Plugin を定義しています。

4. 動作確認

以下のコマンドでコンテナを起動すると、起動時の文言が出力されます。

sample-servlet> mvn jetty:run

・・・ 省略 ・・・

起動時の処理

Ctrl + C でコンテナを停止すると、以下の文言が標準出力されます。

終了時の処理

Web系開発メモ

Java, C#, HTML, CSS, JavaScript のことなどを書いてます。