Servlet リクエストパラメーターを取得する方法

Java のサーブレットで、HTTPリクエストのパラメーターを取得する方法を書いていきます。

バージョン

ブログ執筆時の製品バージョンは以下の通りです。

Servlet 5.0（JakartaEE 9/jakartaee.servlet.*）
Java 17
Maven 3.8.6
Jetty Maven Plugin 11.0.15

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

以下のコマンドで、サンプルプロジェクト sample-servlet のディレクトリ階層を作成します。

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

サーブレットのコードは、src/main/java 配下に置きます。

2. サーブレットの作成

パラメーター名 msg の値を取得するサーブレットを作成します。

org/example/request/GetParamServlet.java

package org.example.request;

import java.io.IOException;

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

@WebServlet("/req/param")
@SuppressWarnings("serial")
public class GetParamServlet extends HttpServlet {
  public void doGet(HttpServletRequest req, HttpServletResponse res)
    throws ServletException, IOException
  {
    // リクエストパラメーターを取得
    String msg = req.getParameter("msg");

    // 取得した値を出力
    res.setContentType("text/plain");
    res.setCharacterEncoding("utf-8");
    res.getWriter().println(msg);
  }
}

@WebServlet を付けて、/req/param のリクエストを処理するようにしています。

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>

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

4. 動作確認

以下のコマンドでコンテナ（Jetty Maven Plugin）を起動します。

sample-servlet> mvn jetty:run

起動後にブラウザで以下の URL を開きます。

http://localhost:8080/req/param?msg=Hello

ブラウザで開くと、以下の文字列が表示されます。

Hello

C#, Python, Web開発

プログラミングやデータ分析のことなどを書いています。