JavaのHttpServletRequestWrapperのgetHeaderの使い方を完全ガイド!初心者でもわかるHTTPヘッダー情報の取得方法
生徒
「JavaのServletで、特定のHTTPヘッダーの値を取り出したいんですが、どうすればいいですか?」
先生
「それなら、HttpServletRequestWrapperクラスのgetHeader()メソッドを使えば簡単に取得できますよ。」
生徒
「ヘッダーの名前を指定するだけなんですか?」
先生
「はい、名前を渡すだけで、そのヘッダーの値を文字列として取得できます。それでは、詳しい使い方を見ていきましょう!」
1. getHeaderメソッドとは
getHeader()メソッドは、HTTPリクエストヘッダーの中から、指定された名前のヘッダーの値をString型で取得するためのメソッドです。
このメソッドは、javax.servlet.http.HttpServletRequestインターフェースに定義されており、HttpServletRequestWrapperでも問題なく使用できます。
存在しないヘッダー名を指定した場合には、nullが返ります。
2. getHeaderの基本的な使い方
次のコードは、ユーザーエージェント(User-Agent)を取得する簡単な例です。
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
public class HeaderWrapper extends HttpServletRequestWrapper {
public HeaderWrapper(HttpServletRequest request) {
super(request);
}
public void printUserAgent() {
String userAgent = getHeader("User-Agent");
if (userAgent != null) {
System.out.println("ユーザーエージェント: " + userAgent);
} else {
System.out.println("User-Agentヘッダーは存在しません。");
}
}
}
このように、名前を指定するだけで目的のヘッダー値を簡単に取得できます。
3. どんなときにgetHeaderを使う?
getHeader()メソッドは、次のような場面で頻繁に使われます。
- ユーザーエージェントによるブラウザ判定(User-Agent)
- 認証情報の取得(Authorization)
- リファラの取得(Referer)
- 言語設定の取得(Accept-Language)
これらの情報は、リクエストを処理するロジックを制御するために役立ちます。
4. ヘッダーの大文字小文字について
HTTPヘッダー名は厳密には大文字と小文字を区別しませんが、JavaのgetHeader()では大文字小文字を区別しない仕組みになっています。そのため、"User-Agent"でも"user-agent"でも同じ結果が得られます。
5. 応用例:カスタムヘッダーの処理
企業内やAPI開発では、X-Custom-TokenなどのカスタムHTTPヘッダーが利用されることもあります。
例えば、次のように特定のトークンを読み取ってログに記録したり、認証処理を行ったりすることが可能です。
String token = request.getHeader("X-Custom-Token");
if (token != null) {
System.out.println("カスタムトークンを受信: " + token);
// トークンに基づく処理をここで実行
} else {
System.out.println("カスタムトークンが指定されていません。");
}
このように、getHeader()メソッドは、Webアプリケーションの柔軟な処理に欠かせない重要なメソッドです。