JSP デバッグ

JSP または Servlet プログラムのテスト/デバッグは常に難しいものです。JSP と Servlet のプログラムは、クライアントとサーバー間の大量のやり取りを伴う傾向があり、これによってエラーが発生する可能性が高く、エラーが発生した環境を再現するのが難しいのです。

次に、プログラムのデバッグに役立ついくつかのコツとアドバイスを紹介します。


System.out.println() を使用する

System.out.println() を使うと、コードの一部が実行されたかどうかを簡単に確認できます。もちろん、さまざまな値を出力することもできます。さらに:

  • System オブジェクトは Java のコアオブジェクトであるため、追加のクラスをインポートすることなくどこでも使用できます。使用範囲には、Servlets、JSP、RMI、EJB's、Beans、クラス、およびスタンドアロンアプリケーションが含まれます。
  • ブレークポイントで実行を停止するのと比較して、System.out による出力はアプリケーションの実行フローに大きな影響を与えません。この特性は、タイミング機構が非常に重要なアプリケーションにおいて非常に役立ちます。

次に、System.out.println() の構文を示します:

System.out.println("Debugging message");

これは System.out.print() を使用した簡単な例です:

<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head><title>System.out.println</title></head>
<body>
<c:forEach var="counter" begin="1" end="10" step="1" >
   <c:out value="${counter-5}"/></br>
   <% System.out.println( "counter= " + 
                     pageContext.findAttribute("counter") ); %>
</c:forEach>
</body>
</html>

さて、上記の例を実行すると、次のような結果が得られます:

-4
-3
-2
-1
0
1
2
3
4
5

Tomcat サーバーを使用している場合は、logs ディレクトリの stdout.log ファイルに次の内容が追加されていることを確認できます:

counter=1
counter=2
counter=3
counter=4
counter=5
counter=6
counter=7
counter=8
counter=9
counter=10

この方法を使用すると、変数やその他の情報をシステムログに出力し、問題を引き起こす根本的な原因を分析して特定することができます。


JDB Logger を使用する

J2SE ログフレームワークは、JVM 内で実行されている任意のクラスにログ記録サービスを提供します。したがって、このフレームワークを使用して任意の情報を記録できます。

上記のコードを、JDK の logger API を使用して書き直してみましょう:

<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@page import="java.util.logging.Logger" %>

<html>
<head><title>Logger.info</title></head>
<body>
<% Logger logger=Logger.getLogger(this.getClass().getName());%>

<c:forEach var="counter" begin="1" end="10" step="1" >
   <c:set var="myCount" value="${counter-5}" />
   <c:out value="${myCount}"/></br>
   <% String message = "counter="
                  + pageContext.findAttribute("counter")
                  + " myCount="
                  + pageContext.findAttribute("myCount");
                  logger.info( message );
   %>
</c:forEach>
</body>
</html>

実行結果は先ほどと似ていますが、追加の情報を stdout.log ファイルに出力できます。ここでは、logger の info メソッドを使用しました。以下に stdout.log ファイルのスナップショットを示します:

24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=1 myCount=-4
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=2 myCount=-3
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=3 myCount=-2
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=4 myCount=-1
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=5 myCount=0
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=6 myCount=1
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=7 myCount=2
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=8 myCount=3
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=9 myCount=4
24-Sep-2013 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter=10 myCount=5

メッセージはさまざまな優先度で送信できます。sever()、warning()、info()、config()、fine()、finer()、finest() メソッドを使用します。finest() メソッドは最も詳細な情報を記録するために使用され、sever() メソッドは最も重大な情報を記録するために使用されます。

Log4J フレームワークを使用すると、重大度と重要度に基づいて分類されたメッセージを異なるファイルに記録できます。


デバッグツール

NetBeans はツリー構造を備えた、オープンソースの Java 統合開発環境であり、スタンドアロンの Java アプリケーションと Web アプリケーションの開発をサポートし、JSP デバッグもサポートしています。

NetBeans は次の基本的なデバッグ機能をサポートしています:

  • ブレークポイント
  • ステップ実行
  • ウォッチポイント

詳細については、NetBeans のマニュアルを参照してください。


JDB Debugger を使用する

JSP や Servlet では、通常のアプリケーションをデバッグするのと同じように、jdb コマンドを使用してデバッグできます。

通常、sun.servlet.http.HttpServer オブジェクトを直接デバッグして、HttpServer が HTTP リクエストに応答するときに JSP/Servlet を実行する状況を確認します。これはアプレットのデバッグと非常に似ています。違いは、アプレットプログラムでは実際には sun.applet.AppletViewer をデバッグするという点です。

ほとんどのデバッガは、アプレットのデバッグ方法を知っているため、アプレットのデバッグ時にいくつかの詳細を自動的に無視できます。デバッグ対象を JSP に移したい場合は、次の2点を行う必要があります:

  • デバッガの classpath を設定して、sun.servlet.http.Http-Server と関連するクラスを見つけられるようにします。
  • デバッガの classpath を設定して、JSP ファイルと関連するクラスを見つけられるようにします。

classpath を設定したら、sun.servlet.http.Http-Server のデバッグを開始します。JSP ファイルの好きな場所にブレークポイントを設定して、ブラウザを使用してサーバーにリクエストを送信すると、プログラムがブレークポイントで停止するのを確認できるはずです。


コメントを使用する

プログラム内のコメントは、さまざまな面でプログラムのデバッグに役立ちます。コメントは、デバッグプログラムの多くの側面で使用できます。

JSP は Java コメントを使用します。バグが消えた場合は、コメントアウトしたばかりのコードを注意深く確認してください。通常、原因が見つかります。


クライアントとサーバーのヘッダー

JSP が期待どおりに動作しない場合、未加工の HTTP リクエストとレスポンスを確認すると役立つことがあります。HTTP の構造に精通していれば、リクエストとレスポンスを直接調べて、これらのヘッダーがどうなっているかを確認できます。


重要なデバッグテクニック

ここでは、JSP をデバッグするための 2 つのちょっとしたコツを紹介します:

  • ブラウザを使用して元のページコンテンツを表示し、フォーマットの問題かどうかを区別します。このオプションは通常、View メニューにあります。
  • ブラウザがページを強制的に再読み込みするときに、以前のリクエスト出力をキャプチャしないようにしてください。Netscape Navigator ブラウザを使用している場合は Shift-Reload、IE ブラウザを使用している場合は Shift-Refresh を使用します。
その他の拡張機能