HTTPサーブレットリクエスト

サーブレットのservice()（doPost()・getGet()）の引数であるHttpServletRequestのメモ。

POSTデータ

HTTPリクエストには、POSTメソッドで送られてきた値が入っている。[2007-07-08]

コンソールにデータを出力する例：

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {

		req.setCharacterEncoding("MS932");
		for (Enumeration i = req.getParameterNames(); i.hasMoreElements();) {
			String key = (String) i.nextElement();
			String val = req.getParameter(key);

			System.out.printf("%s = %s%n", key, val);
		}
	}

HttpServletRequest#setCharacterEncoding()で、リクエストの文字コード体系を指定しておく。（これは、クライアント側で入力に使用した文字コード体系に合わせる）

→ファイルアップロード時の取得方法（multipart/form-data）
→getParameterValues()

パスの取得

パス（URL・URI）取得関連のメソッド。

サーブレット（JSP）では、フォワードやインクルードによって他のサーブレットを呼び出す（処理を委譲する）ことが出来る。
その為、大元のクライアントから渡されるURIと、直前のサーブレットによって指定されたURIを別々に取得できるようになっている。

なお、ここで言うインクルードは、サーブレット内から実行されるRequestDispatcher#include()メソッド。
JSPで言えば、標準アクションタグのインクルードタグ「<jsp:include page="〜.jsp" />」のこと。
（JSPのincludeディレクティブ「<%@include file="〜.jsp" %>」は、別jspファイルの内容を事前コンパイル時に取り込んで自分の一部にしてしまう為、実行時には呼び出されない）

getParameterValues()の順序

getParameterValues(name)は、指定されたパラメーターの値を取得するメソッド。[2008-10-19]
HTML（HTTPのGET/POSTメソッド）の場合、同じ名前のパラメーターを指定することが出来るので、getParameterValues()では、同名のパラメーターの全ての値がString配列として返される。
（ちなみに、getParameter()は、String配列の先頭1個目を返す。が、getParameter()は値が1つしか無い（はず）と分かっている場合に使用する）

<form method="POST">
	<input name="nm" type="text" value="foo">
	<input name="nm" type="text" value="hoge">
	<input name="nm" type="text" value="zzz">
</form>

↓
req.getParameterValues("nm")でString[]{ "foo", "hoge", "zzz" }が返る。

ここで、getParameterValues()が返すString配列内の値の順番は保証されるか？という話題がある。（GoogleでもgetParameterValuesで検索すると、「getParameterValues 順番」が検索候補に出てくる）
getParameterValues()のJavadocには順序に関して特に記述が無い。記述が無いということは、厳密に言えば「保証が無い」ということになるとも言える。
また、HTTPのRFCには、順番に関する規定は特に無いらしい。（参考： @IT会議室のgetParameterValuesについて）

しかし、HTML4.01仕様には、<form enctype="application/x-www-form-urlencoded">の場合（つまりデフォルト）は、名前/値はドキュメント（HTML文書）に現れている順序通りとある。

• HTML4仕様書邦訳計画補完委員会の17.13.4 フォームのMIMEタイプ
• W3Cの17.13.4 Form content types

つまり、サーブレットに到達するまで（すなわちブラウザーがセットしたもの）は、HTML内の順番通りに並んでいる（はず）。少なくともHTML4では。
→HTMLのバージョン指定方法（DOCTYPE）

そしてサーブレット仕様2.2には、クエリー文字列（GETメソッドによる名前/値）とPOST本体を合わせて同名パラメーターがある場合に“順序がこうなるはず”という例が載っている。
あくまで例なので、厳密に仕様かと問われるとちょっと怪しい気はしないでもないが…。
ちなみにJBoss4.2.3が準拠しているサーブレットのバージョンは2.4（J2EE1.4）だと思うが、サーブレット仕様2.2も2.5も同じ例が載っているので、2.4も同じだろう 。

• 株式会社クレスのJava Servlet仕様書v2.2邦訳版の5.1 パラメタ
• SunのJava Servlet API Specification - Version 2.2
• SunのJSR-000154 Java Servlet 2.5 SpecificationのSRV.3.1 HTTP Protocol Parameters

そいでもって、JBoss（中身はTomcat）の実装も、POSTメソッド（クエリー文字列）の解釈部分は、同名パラメーターが後から来た場合にString配列の末尾に追加するようコーディングされている。 つまり、パラメーターの現れた順番に値が保持される。

• jboss-4.2.3.GA-src/thirdparty/jboss/web/lib/jbossweb-src.zip
  • org.apache.tomcat.util.http.Parameters#processParameters() （jbossweb.jar）
  • javax.servlet.http.HttpUtils#parseQueryString() （servlet-api.jar） （エンコードがデフォルトしか使えないのでクラス自体が非推奨になっているが、パラメーターの解釈/保持は順番通り）

結論としては、getParameterValues()の返す値は、HTML内の順番通りに並んでいると思っていいだろう。少なくともJBoss・Tomcatは。

リクエストヘッダー

HTTPのリクエストヘッダーを取得するにはgetHeader()を使用する。

	String referer = req.getHeader("referer");

	for (Enumeration<?> e = req.getHeaderNames(); e.hasMoreElements();) {
		String key = (String) e.nextElement();
		String val = req.getHeader(key);

		String msg = String.format("%s= %s", key, val);
		System.out.println(msg);
	}

ひとつの名前に複数の値が入る可能性がある場合はgetHeaders()（Enumerationを返す）
数値として取得する場合はgetIntHeader()（intを返す）
日付として取得したい場合はgetDateHeader()（longを返す）
を使う。