11.2　リクエストスコープを利用しサーブレットからJSPへ値を渡す（2023年改訂版）

リクエストスコープを利用しサーブレットからJSPへ値を渡す

11.2 リクエストスコープを利用しサーブレットからJSPへ値を渡す

　本節では、JSP/サーブレットに用意されたスコープの1つであるリクエストスコープの利用方法について学習します。

11.2.1 オブジェクトの登録と取得

　リクエストスコープにオブジェクトを登録する場合、以下の書式を利用します。

書式：リクエストスコープへのデータの登録

　変数requestは、jakarta.servlet.http.HttpServletRequestインタフェースのオブジェクトです。
　HttpServletRequestインタフェースのオブジェクトに用意されたsetAttribute()メソッドを利用することで、リクエストスコープへデータを登録することができます。メソッドの引数には、登録するデータの名前と登録するデータを渡します。次は、リクエストスコープからデータを取得する書式です。

書式：リクエストスコープからのデータの取得

　HttpServletRequestインタフェースのオブジェクトに用意されたgetAttribute()メソッドを利用することで、リクエストスコープからデータを取得することができます。メソッドの引数には、登録されたデータの名前を渡します。また、リクエストスコープから取得したデータはObject型のデータに変換されているため、登録する前のデータ型へキャストする必要があります。

　では、リクエストスコープを利用してサーブレットとJSP間でデータを共有するプログラムを作成してみましょう

リクエストスコープを利用しサーブレットからJSPへデータを渡すプログラム

　サーブレット内で定義した文字列をリクエストスコープに登録し、その文字列をJSPで受け取り画面に表示するプログラムです。リクエストスコープへのデータの登録方法とリクエストスコープからのデータの取得方法について学習しましょう。

実行結果

アプリケーション構成

① ソース・フォルダ：web_basic/src/main/java
② パッケージ：ch11
③ 名前：UseRequestServlet1
④ スーパークラス：jakarta.servlet.http.HttpServlet
⑤ アクセスURL ：http://localhost:8080/web_basic/UseRequestServlet1

➢　UseRequestServlet1.java

1package ch11;
2 
3import java.io.IOException;
4 
5import jakarta.servlet.ServletException;
6import jakarta.servlet.annotation.WebServlet;
7import jakarta.servlet.http.HttpServlet;
8import jakarta.servlet.http.HttpServletRequest;
9import jakarta.servlet.http.HttpServletResponse;
10 
11@WebServlet("/UseRequestServlet1")
12public class UseRequestServlet1 extends HttpServlet {
13 
14    public void doGet(HttpServletRequest request, HttpServletResponse response)
15            throws ServletException, IOException {
16        //リクエストスコープへの登録
17        request.setAttribute("bookTitle", "JSP/サーブレットの本");
18        request.getRequestDispatcher("/view/ch11/useRequest1.jsp").forward(request, response);
19    }
20}

① 親フォルダの入力または選択：web_basic/src/main/webapp/view/ch11
② ファイル名：useRequest1.jsp
③ アクセスURL ：UseRequestServlet1.javaからの画面遷移でアクセスされる

➢　useRequest1.jsp

1<%@page contentType= "text/html; charset=UTF-8" %>
2 
3<%
4//リクエストスコープからのデータの取得
5String bookTitle = (String)request.getAttribute("bookTitle");
6%>
7 
8<html>
9    <head>
10        <title>リクエストスコープを利用したプログラム</title>
11    </head>
12    <body>
13        本の名前：<%= bookTitle %>
14    </body>
15</html>

解説
　このプログラムは、サーブレット内の17行目でsetAttribute()メソッドを利用し、リクエストスコープにデータを登録しています。setAttribute()メソッドの第1引数に「bookTitle」という文字列を渡しています。この第1引数が、登録するデータの名前になります。また、第2引数には「JSP/サーブレットの本」という文字列を渡しています。この文字列が、実際にリクエストスコープに登録されるデータです。
　　　17：request.setAttribute("bookTitle", "JSPサーブレットの本");

図 11.2.1: リクエストスコープへのデータ登録の流れ

　ここで1つ注意する点があります。setAttribute()メソッドの第2引数は、Object型と呼ばれるクラス型です。Object型は全てのクラスが継承している型なので、この型を引数とすることで、どのような型でも登録することができます。

　setAttribute()メソッドによってリクエストスコープ内に登録される際に、String型の文字列「JSP/サーブレットの本」はObject型に自動型変換されて登録されます。

図 11.2.2:リクエストスコープへのデータ登録時の型変換

　18行目では、フォワードを利用してuseRequest1.jspに転送を行っています。
　　　18：request.getRequestDispatcher("/view/ch11/useRequest1.jsp").forward(request, response);

　useRequest1.jspへ処理の転送後は、5行目で登録された文字列を取得しています。
　getAttribute()メソッドの引数に「bookTitle」という文字列を渡しています。この引数の文字列がリクエストスコープから取得するデータの名前になります。
　　　5：String bookTitle = (String)request.getAttribute("bookTitle");

図 11.2.3: リクエストスコープからのデータ取得の流れ

　ここで注意する点は、登録されたデータはObject型で取得されることです。そのため、取得されたデータを適切に扱うためには、型をリクエストスコープへ登録される前の型に明示的に変換(キャスト)する必要があります。

図 11.2.4:リクエストスコープへのデータ登録時の型変換

　このように、サーブレット内でリクエストスコープにデータを登録し、登録されたデータをJSP内で取得することで、データを共有することができるようになります。実行結果からわかるように、サーブレット内でリクエストスコープに登録した文字列をJSPで表示することができています。
　また、このリクエストスコープへ登録可能なデータは、既存のクラスのデータだけではありません。
　次のプログラムでは自作クラスのデータを登録するプログラムについて確認します。

11.2.2 自作クラスのデータの登録と取得

　前節では、既存のクラス型であるString型の文字列をリクエストスコープに登録するプログラムを作成しました。
　リクエストスコープに登録可能なデータは既存のクラス型だけではありません。自作したクラスのデータについても同様に扱うことができます。

自作クラスのデータを渡すプログラム

　サーブレット内で自作クラスのデータをリクエストスコープに登録し、そのデータをJSPで受け取り画面に表示するプログラムです。リクエストスコープに登録された自作クラスのデータを取得し画面に表示できることを確認しましょう。

実行結果

アプリケーション構成

① ソース・フォルダ：web_basic/src/main/java
② パッケージ：ch11
③ 名前：User

➢　User.java

1package ch11;
2 
3public class User {
4 
5    private String name;
6    private int age;
7 
8    public User() {
9        this.name = "名無し";
10        this.age = 0;
11    }
12    public String getName() {
13        return name;
14    }
15    public void setName(String name) {
16        this.name = name;
17    }
18    public int getAge() {
19        return age;
20    }
21    public void setAge(int age) {
22        this.age = age;
23    }
24 }

① ソース・フォルダ：web_basic/src/main/java
② パッケージ：ch11
③ 名前：UseRequestServlet2
④ スーパークラス：jakarta.servlet.http.HttpServlet
⑤ アクセスURL ：http://localhost:8080/web_basic/UseRequestServlet2

➢　UseRequestServlet2.java

1package ch11;
2 
3import java.io.IOException;
4 
5import jakarta.servlet.ServletException;
6import jakarta.servlet.annotation.WebServlet;
7import jakarta.servlet.http.HttpServlet;
8import jakarta.servlet.http.HttpServletRequest;
9import jakarta.servlet.http.HttpServletResponse;
10 
11@WebServlet("/UseRequestServlet2")
12public class UseRequestServlet2 extends HttpServlet {
13 
14    public void doGet(HttpServletRequest request, HttpServletResponse response)
15            throws ServletException, IOException {
16 
17        //Userオブジェクトの生成
18        User objUser = new User();
19        objUser.setName("神田タロー");
20        objUser.setAge(25);
21 
22        //リクエストスコープへのUserオブジェクトの登録
23        request.setAttribute("RequestUser", objUser);
24        request.getRequestDispatcher("/view/ch11/useRequest2.jsp").forward(request, response);
25    }
26}

① 親フォルダの入力または選択：web_basic/src/main/webapp/view/ch11
② ファイル名：useRequest2.jsp
③ アクセスURL ：UseRequestServlet2.javaからの画面遷移でアクセスされる

➢　useRequest2.jsp

1<%@page contentType= "text/html; charset=UTF-8" %>
2<%@page import="ch11.User" %>
3 
4<%
5//リクエストスコープからのデータの取得
6User objUser = (User)request.getAttribute("RequestUser");
7String name = objUser.getName();
8int age = objUser.getAge();
9%>
10<html>
11    <head>
12        <title>自作クラスのオブジェクトを登録する</title>
13    </head>
14    <body>
15        名前は：<%= name %><br>
16        年齢は：<%= age %><br>
17    </body>
18</html>

解説
　このプログラムは、自作クラスであるUserクラスを定義しています。このクラスには1人分の名前と年齢を格納するフィールド変数とアクセサメソッドが定義されています。

　サーブレット内でUserクラスのオブジェクトをリクエストスコープに登録し、フォワード先のJSPでオブジェクトを取得し、オブジェクト内のデータを画面に表示しています。
　UseRequestServlet2.javaの18行目から20行目でUserオブジェクトを生成しています。その際に、名前を「神田タロー」、年齢を「25」と設定しています。
　　　18：User objUser = new User(); 　　　19：objUser.setName("神田タロー"); 　　　20：objUser.setAge(25);

　23行目でリクエストスコープにUserオブジェクトを登録し、24行目でuseRequest2.jspへ処理を転送します。
　　　23：request.setAttribute("RequestUser", objUser); 　　　24：request.getRequestDispatcher("/view/ch11/useRequest2.jsp").forward(request, response);

　useRequest2.jspでは、自作のクラスであるUserクラスを利用するため、ページディレクティブを利用してインポートを行なっています。
　　　2：<%@page import="ch11.User" %>

　useRequest2.jspへ処理の転送後は、6行目で登録されたUserクラスのオブジェクトを取得しています。このオブジェクトの型は元はUser型なので、User型へキャストを行います。
　　　6：User objUser = (User)request.getAttribute("RequestUser");

　7行目、8行目ではUserクラスのオブジェクトに用意されたゲッターメソッドを利用して名前と年齢のデータを取得しています。
　　　7：String name = objUser.getName(); 　　　8：int age = objUser.getAge();

　実行結果からも分かるように、サーブレット内でリクエストスコープに登録した自作クラスのオブジェクトをJSPで取得し、オブジェクト内のデータを表示することができます。このように、既存のクラス型以外にも自分で作成したクラスのオブジェクトを扱うことも可能です。

NEXT>> 11.3 本章のまとめ