Jakarta Servlet 5.0 の Servlet Life Cycle

f:id:bau1537:20210925143925j:plain

Jakarta Servlet 5 の Servlet Life Cycle に関して読んだのでその内容を軽くまとめる
- https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0.html#servlet-life-cycle
Servlet にはライフサイクルがある
1. ロードされインスタンス化される
2. 初期化される
3. リクエストを受けて処理する
4. 終了する
これらのライフサイクルで任意のコードを実行できるよう、APIが定義されている
- jakarta.servlet.Servlet インターフェイスの次のメソッドがそれに当たる
  - init
  - service
    - jakarta.servlet.HttpServlet では doGet などになる
  - destroy
というわけで、実際にやってみる
プロジェクトディレクトリ構成

$ tree .
.
├── pom.xml
└── src
    └── main
        └── java
            └── org
                └── example
                    └── servlet
                        └── DemoServlet.java

6 directories, 2 files

pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>servlet</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>Servlet Maven Webapp</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</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>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.2.2</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

DemoServlet.java

package org.example.servlet;

import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;

@WebServlet(urlPatterns = "/")
public class DemoServlet extends HttpServlet {

    @Override
    public void init(ServletConfig config) throws ServletException {
        super.init(config);
        log("Servlet init (with config)");
    }

    @Override
    public void init() {
        log("Servlet init");
    }

    @Override
    public void destroy() {
        log("Servlet destroy");
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        log("Servlet handle get request");
        var writer = resp.getWriter();
        writer.write("Hello, from Jakarta Servlet 5");
    }

}

HttpServlet を継承したクラスを作り、 @WebServlet でリクエストを受け付けるURLを設定
init と destroy メソッドをそれぞれオーバーライドし、サーブレットのライフサイクルで任意のコードを実行できるようにする
- それぞれのライフサイクルでログが出るようにした
- init は設定クラスを引数に取るものと、取らないものがある
Jettyにデプロイして動かすと、こんな感じのログが出てくる
- ここで、ログが出るタイミングはいつなのかというと、対象のURLにアクセスしたときだった
- つまり、サーバーを起動した（今回の場合はJetty）ではサーブレットは初期化されず、初めてアクセスが来たタイミングで初期化されたということ
- この動作がJetty特有なものなのか、Servletの決まりなのかはわからぬ
  - Jakarta Servlet 5 の仕様書を読んだ範囲だと、リクエストを受け付ける前には初期化メソッドを呼んで初期化を済ませること、としか書いていないのでタイミングはサーブレットコンテナに依存するのかもしれない
  - https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0.html#initialization

2021-09-25 15:44:58.848:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp293907205-34: org.example.servlet.DemoServlet: Servlet init
2021-09-25 15:44:58.848:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp293907205-34: org.example.servlet.DemoServlet: Servlet init (with config)
2021-09-25 15:44:58.848:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp293907205-34: org.example.servlet.DemoServlet: Servlet handle get request
2021-09-25 15:45:00.130:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp293907205-28: org.example.servlet.DemoServlet: Servlet handle get request

Jettyを Ctrl + c で止めると、 destroy メソッドが呼ばれる

2021-09-25 15:56:08.664:INFO :oejs.Server:JettyShutdownThread: Stopped Server@6989da5e{STOPPING}[11.0.6,sto=5000]
2021-09-25 15:56:08.664:INFO :oejs.Server:JettyShutdownThread: Shutdown Server@6989da5e{STOPPING}[11.0.6,sto=5000]
2021-09-25 15:56:08.671:INFO :oejs.AbstractConnector:JettyShutdownThread: Stopped ServerConnector@75c56eb9{HTTP/1.1, (http/1.1)}{0.0.0.0:8080}
2021-09-25 15:56:08.672:INFO :oejshC.servlet_demo:JettyShutdownThread: org.example.servlet.DemoServlet: Servlet destroy

設定クラスを引数に取る init メソッドでは ServletContext なるものにアクセスできるということなので試す
こんな感じに書き換え
- ServletContextName なるものをログに出してみる

    @Override
    public void init(ServletConfig config) throws ServletException {
        super.init(config);
        log("Servlet init (with config)");
        log("Servlet context name is " + config.getServletContext().getServletContextName());
    }

デプロイするとこんな感じにログが出た
- Servlet context name is /servlet-1.0-SNAPSHOT と出力された
- どうやら ServletContextName とはサーブレットにアクセスするときのURLの一部であるらしい
- 正確なことはまたとで...

2021-09-25 15:58:07.115:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp1175259735-26: org.example.servlet.DemoServlet: Servlet init
2021-09-25 15:58:07.115:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp1175259735-26: org.example.servlet.DemoServlet: Servlet init (with config)
2021-09-25 15:58:07.116:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp1175259735-26: org.example.servlet.DemoServlet: Servlet context name is /servlet-1.0-SNAPSHOT
2021-09-25 15:58:07.116:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp1175259735-26: org.example.servlet.DemoServlet: Servlet handle get request
2021-09-25 15:58:07.308:INFO :oejshC.servlet_1_0_SNAPSHOT:qtp1175259735-31: org.example.servlet.DemoServlet: Servlet handle get request