4.1　デバッグを行う前に（2023年改訂版）

デバッグを行う前に

4.1 デバッグを行う前に

　本章では、Eclipseを利用したWebアプリケーションのデバッグについて学習していきます。ここでは、すでに「Java基礎Ⅰテキスト」で通常のJavaプログラムでのデバッグを学習している前提で解説します。そのため、デバッグパースペクティブの見方や、ステップオーバーやステップインの操作方法については省略しています。
　本来は、エラーやロジックのミスなどのバグを改善するためにデバッグを行いますが、ここでは、変数に格納されているデータの確認や、プログラムがどのような流れで動いているかなどを確認する形で説明していきます。基本的なデバッグの方法は通常のJavaプログラムと変わりません。

　本章では以下の「数字当てゲーム(WEBセッション版)」を利用して、Webアプリケーションのデバッグ方法について解説しています。

数字当てゲーム(WEBセッション版)

　このプログラムは、入力フォームから0から9までの予想数字を入力し、ランダムで設定された正解数字の判定を行います。判定の結果が「はずれ」の場合はゲームが継続され、「当たり」の場合はゲームが終了します。
　※ソースコードは以下URLからダウンロードして、対象の階層にコピーしてください
　　https://kanda-it-school-square.com/?wpdmdl=4692

実行結果

アプリケーション構成

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

➢　NumberInfo.java

1package ch04;
2 
3public class NumberInfo {
4 
5    private String userNumber;  //入力数値用変数
6    private String judge;           //判定用変数
7 
8    NumberInfo(){
9        userNumber = "";
10        judge = "";
11    }
12  
13    //変数userNumberのアクセサメソッド
14    public String getUserNumber() {
15        return userNumber;
16    }
17    public void setUserNumber(String userNumber) {
18        this.userNumber = userNumber;
19    }
20  
21    //変数judgeのアクセサメソッド
22    public String getJudge() {
23        return judge;
24    }
25    public void setJudge(String judge) {
26        this.judge = judge;
27    }
28 }

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

➢　GuessServlet.java

1package ch04;
2 
3import java.io.IOException;
4import java.util.ArrayList;
5import java.util.Random;
6 
7import jakarta.servlet.ServletException;
8import jakarta.servlet.annotation.WebServlet;
9import jakarta.servlet.http.HttpServlet;
10import jakarta.servlet.http.HttpServletRequest;
11import jakarta.servlet.http.HttpServletResponse;
12import jakarta.servlet.http.HttpSession;
13 
14@WebServlet("/GuessServlet")
15public class GuessServlet extends HttpServlet {
16 
17    public void doGet(HttpServletRequest request, HttpServletResponse response) 
18            throws ServletException, IOException {
19  
20        try {
21            // 文字コードの設定
22            request.setCharacterEncoding("UTF-8");
23            response.setContentType("text/plain; charset=UTF-8");
24  
25            // セッションオブジェクトの取得
26            HttpSession session = request.getSession();
27  
28            Integer answerNumber = null; // 正解数字用変数
29            ArrayList<NumberInfo> list = null; // 履歴用変数
30            String message = ""; // メッセージ用変数
31  
32            // ゲーム制御フラグを取得
33            String cmd = request.getParameter("cmd");
34  
35            // 初回アクセス、または再チャレンジ時の初期化処理
36            if (cmd == null || cmd.equals("first")) {
37                list = new ArrayList<NumberInfo>();
38                cmd = "first";
39                answerNumber = new Random().nextInt(10);
40                session.setAttribute("answer", answerNumber);
41  
42                // ゲームが継続中の処理
43            } else if (cmd.equals("game")) {
44  
45                // 入力数値、履歴、回答数値の取得
46                String strUserNumber = (String) request.getParameter("user_number");
47                list = (ArrayList<NumberInfo>) session.getAttribute("list");
48                answerNumber = (Integer) session.getAttribute("answer");
49  
50                int intUserNumber = -1; // 入力数値用変数
51                String judge = ""; // 判定用変数
52  
53                // エラーチェック
54                if (strUserNumber.equals("")) {
55                    message = "何も入力されていません";
56                } else {
57                    try {
58                        intUserNumber = Integer.parseInt(strUserNumber);
59                        if (intUserNumber < 0 || 9 < intUserNumber) {
60                            message = "0から9までの数字を入力してください";
61                        }
62                    } catch (NumberFormatException e) {
63                        message = "数字を入力してください";
64                    }
65                }
66  
67                // エラーがない場合、判定処理
68                if (message.equals("")) {
69                    if (answerNumber == intUserNumber) {
70                        judge = "当たり";
71                        cmd = "end";
72                        message = intUserNumber + " は、当たりです";
73                    } else {
74                        judge = "はずれ";
75                        message = intUserNumber + " は、はずれです";
76                    }
77                    // 入力数値、判定を履歴に追加
78                    NumberInfo objNumberInfo = new NumberInfo();
79                    objNumberInfo.setUserNumber(Integer.toString(intUserNumber));
80                    objNumberInfo.setJudge(judge);
81                    list.add(objNumberInfo);
82                }
83            }
84  
85            // ゲーム制御フラグ、メッセージをリクエストスコープへ登録
86            request.setAttribute("cmd", cmd);
87            request.setAttribute("message", message);
88            // 履歴をセッションへ登録
89            session.setAttribute("list", list);
90            // JSPへ画面遷移
91            request.getRequestDispatcher("/view/ch04/guess.jsp").forward(request, response);
92  
93            // 予期しない例外が発生した場合の画面遷移
94        } catch (Exception e) {
95            String message = "予期せぬエラーが発生しました<br>" + e.toString();
96            request.setAttribute("cmd", "end");
97            request.setAttribute("message", message);
98            request.getRequestDispatcher("/view/ch04/guess.jsp").forward(request, response);
99        }
100    }
101 }

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

➢　guess.jsp

1<%@page contentType="text/html; charset=UTF-8"%>
2<%@page import="java.util.ArrayList,ch04.NumberInfo"%>
3 
4<%
5String cmd = (String)request.getAttribute("cmd");
6String message = (String)request.getAttribute("message");
7ArrayList<NumberInfo> list =(ArrayList<NumberInfo>)session.getAttribute("list");
8if(cmd == null){
9    cmd = "first";
10 }
11 %>
12  
13 <html>
14    <head>
15        <title>数字当てゲーム（セッション版）</title>
16    </head>
17    <body>
18        <div style="text-align:center">
19            <h1 style="text-align:center">数字当てゲーム（セッション版）</h1>
20            <hr style="height:3; background-color:#0000ff" />
21            <br>
22            <br>
23            <br>
24            <p style="text-align:center">0～9の数字をいれてください</p>
25  
26            <%
27            if(cmd.equals("end")){
28            %>
29                <input type="text">
30                <input type="button" value="送信" disabled>
31                <form action="<%=request.getContextPath()%>/GuessServlet">
32                    <input type="hidden" name="cmd" VALUE="first">
33                    <br>
34                    <input type="submit" value="もう一度挑戦">
35                </form>
36            <%
37            }
38            else{
39            %>
40                <form action="<%=request.getContextPath()%>/GuessServlet">
41                    <input type="text" name="user_number">
42                    <input type="hidden" name="cmd" VALUE="game">
43                    <input type="submit" VALUE="送信">
44                </form>
45            <%
46            }
47            %>
48  
49            <br>
50  
51            <%
52            if(message != null){
53            %>
54            <h3 style="text-align:center; color: red;"><%=message%></h3>
55            <%
56            }
57            %>
58  
59            <h2 style="text-align:center">判定結果</h2>
60            <table style="border: 1px solid; margin:0 auto;">
61                <tr>
62                    <td style="border: 1px solid;">挑戦回数</td>
63                    <td style="border: 1px solid;">入力数字</td>
64                    <td style="border: 1px solid;">判定</td>
65                </tr>
66                <%
67                if(list != null){
68                    for(int i=0; i<list.size(); i++){
69                        NumberInfo objNumberInfo = list.get(i);
70                %>
71                    <tr>
72                        <td style="border: 1px solid;"><%=i+1%>回目</td>
73                        <td style="border: 1px solid;"><%=objNumberInfo.getUserNumber()%></td>
74                        <td style="border: 1px solid;"><%=objNumberInfo.getJudge()%></td>
75                    </tr>
76                <%
77                    }
78                }
79                %>
80            </table>
81        </div>
82    </body>
83 </html>

解説
　これは、サーブレット内でランダムに生成された正解の数字とフォームから入力された数字を判定し、結果を画面に表示するプログラムです。またゲームが継続している間、履歴も一覧で表示します。

　このプログラムは以下の3つのファイルで構成されています。

・　NumberInfo.java
　1回分の入力された値と判定の情報を管理するJavaBeanクラスです。
　入力数字の判定を管理する変数や、変数にアクセスするためのアクセサメソッドが定義されています。

・　GuessServlet.java
　正解数字の生成や、エラー判定、正否判定などを行うサーブレットです。

・　guess.jsp
　GuessServletで生成されたデータを画面に表示するためのJSPです。

　GuessServlet.javaでは、33行目でゲームの進行を管理するためのフラグを取得しています。cmdは「コマンド」の略称です。
　　　33：String cmd = request.getParameter("cmd");

　ゲームの進行を制御するフラグには以下の4つの値があり、変数に格納された値が何なのかをもとにゲームの継続や終了の判定が行われています。

　【cmd変数の値】
　①　null
　　最初のアクセスであることを表す値です。
　　ブラウザから最初にアクセスされた際に変数cmdに格納されます。
　②　”first”
　　ゲームが初期化された状態であることを表す値です。
　　ゲームが終了し、「もう1度挑戦」が選択された際に変数cmdに格納されます。
　③　”game”
　　ゲームが継続している状態であることを表す値です。
　　入力された数字が正解ではなかった場合に、変数cmdに格納されます。
　④　”end”
　　ゲームが終了している状態であることを表す値です。
　　入力された数字が正解だった場合に、変数cmdに格納されます。

　GuessServlet.javaには、次の3つの処理が記述されていて、取得されたcmdの値によってどこの処理が行われるかが決まります。

　①　36行目から40行目
　　初回アクセス、または再チャレンジ時の初期化処理
　②　43行目から83行目
　　ゲームが継続中の処理
　③　86行目から91行目
　　データを登録する処理と画面遷移の処理

　36行目から40行目では初回アクセス、または再チャレンジの場合の初期化処理を行なっています。
　37行目では履歴を管理するオブジェクトを生成します。38行目ではcmdの値を「first」で初期化しています。39目は正解数字を生成し、40でセッションへ登録します。
　　　36：if(cmd == null || cmd.equals("first")){ 　　　37： list = new ArrayList<NumberInfo>(); 　　　38： cmd = "first"; 　　　39； answerNumber = new Random().nextInt(10); 　　　40： session.setAttribute("answer",answerNumber);

　43行目から83行目のelseブロックではゲームが継続中の処理を行います。
　46行目から48行目では入力数値、履歴、正解数値の値を取得しています。
　　　46：String strUserNumber = (String)request.getParameter("user_number"); 　　　47；list = (ArrayList<NumberInfo>)session.getAttribute("list"); 　　　48：answerNumber = (Integer)session.getAttribute("answer");

　54行目から65行目では入力チェックを行い、問題がある値だった場合には、変数messageにエラーメッセージを代入します。
　　　54：if(strUserNumber.equals("")){ 　　　55： message = "何も入力されていません"; 　　　56：}else{ 　　　57： try{ 　　　58： intUserNumber = Integer.parseInt(strUserNumber); 　　　59： if(intUserNumber > 0 || 9 < intUserNumber){ 　　　60： message = "0から9までの数字を入力してください"; 　　　61： } 　　　62： }catch(NumberFormatException e){ 　　　63： message = "数字を入力してください"; 　　　64： } 　　　65：}

　エラーメッセージがない場合には、69行目から76行目で正解の判定を行います。この時入力された数字が当たりの場合は、cmd変数の値に「end」を代入します。
　　　69：if(answerNumber == intUserNumber){ 　　　70： judge = "当たり"; 　　　71：cmd = "end"; 　　　72： message = intUserNumber + " は、当たりです"; 　　　73：}else{ 　　　74： judge = "はずれ"; 　　　75： message = intUserNumber + " は、はずれです"; 　　　76：}

　78行目から81行目では入力された数字と判定結果を履歴情報に追加しています。
　　　78：NumberInfo objNumberInfo = new NumberInfo(); 　　　79：objNumberInfo.setUserNumber(Integer.toString(intUserNumber)); 　　　80：objNumberInfo.setJudge(judge); 　　　81：list.add(objNumberInfo);

　86行目から87行目ではゲーム制御フラグとメッセージをリクエストスコープへ登録します。
　　　86：request.setAttribute("cmd",cmd); 　　　87：request.setAttribute("message", message);

　89行目で履歴情報をセッションへ登録します。
　　　89：session.setAttribute("list", list);

　登録後は、91行目のフォワード処理でguess.jspへ画面遷移を行います。
　　　91：request.getRequestDispatcher("/view/ch04/guess.jsp").forward(request,response);

　guess.jspでは5行目から8行目でゲーム制御用フラグ、メッセージ、履歴オブジェクトを取得しています。
　　　5：String cmd = (String)request.getAttribute("cmd"); 　　　6：String message = (String)request.getAttribute("message"); 　　　7：ArrayList<NumberInfo> list =(ArrayList<NumberInfo>)session.getAttribute("list");

　guess.jspのHTML部分は取得されたデータの有無や状態によって制御されており、 29行目から35行目は変数cmdの値が「end」だった場合に表示される画面になっています。
　　　29：<input type="text"> 　　　30：<input type="button" value="送信" disabled> 　　　31：<form action="<%=request.getContextPath()%>/GuessServlet"> 　　　32： <input type="hidden" name="cmd" VALUE="first"> 　　　33： <br> 　　　34： <input type="submit" value="もう一度挑戦"> 　　　35：</form>

　40行目から44行目は変数cmdの値が「game」だった場合に出力されます。
　　　40：<form action="<%=request.getContextPath()%>/GuessServlet"> 　　　41： <input type="text" name="user_number"> 　　　42： <input type="hidden" name="cmd" VALUE="game"> 　　　43： <input type="submit" VALUE="送信"> 　　　44：</form>

図 4.1.1: cmdの値による入力画面の違い

　54行目はエラーメッセージや正否のメッセージがある場合に、そのメッセージを表示します。
　　　54：<h3 style="text-align:center; color: red;"><%=message%></h3>

図 4.1.2: メッセージの表示画面

　67行目から78行目では、履歴がある場合にfor文を利用して履歴情報をテーブル形式で出力しています。
　　　67：if(list != null){ 　　　68： for(int i=0; i<list.size(); i++){ 　　　69： NumberInfo objNumberInfo = list.get(i); 　　　70：%> 　　　71： <tr> 　　　72： <td><%=i+1%>回目</td> 　　　73： <td><%=objNumberInfo.getUserNumber()%></td> 　　　74： <td><%=objNumberInfo.getJudge()%></td> 　　　75： </tr> 　　　76：<% 　　　77： } 　　　78：}

図 4.1.3: 履歴情報の表示画面

　これで、デバッグに利用するプログラムの解説は終了です。
　次の節からは、実際にデバッグを行う手順について解説していきます。

NEXT>> 4.2 サーブレットのデバッグ