JavaのPartクラスgetHeaderNamesメソッドを完全解説！初心者でもわかるServletでの全ヘッダー名の取得方法

PartのgetHeaderNamesメソッド

先生と生徒の会話形式で理解しよう

生徒

「JavaのServletでアップロードされたファイルに、どんなヘッダーが付いてるか全部一覧で見たいんですが、できますか？」

先生

「それなら、javax.servlet.http.PartのgetHeaderNamesメソッドを使えば、すべてのヘッダー名を取得できますよ。」

生徒

「へぇ、そんな便利なメソッドがあるんですね！どうやって使えばいいですか？」

先生

「それじゃあ、ServletでPartを使って、全ヘッダー名を取得する方法を詳しく見ていきましょう。」

1. Java Servletとは？

JavaのServlet（サーブレット）は、Webサーバー上で動作するJavaプログラムで、javax.servletパッケージに含まれています。HTTPリクエストを受け取り、処理し、HTTPレスポンスを返すのが主な役割です。フォームデータの送信やファイルアップロードなど、Webアプリケーションの中心的な処理を担います。

2. Partインターフェースの概要

javax.servlet.http.Partインターフェースは、Servletでファイルアップロードなどのマルチパートリクエストを処理するためのインターフェースです。アップロードされたファイルやフォームデータの各部分（パート）を表し、ファイル名やサイズ、コンテンツタイプ、ヘッダー情報などを取得することができます。

将来を見据えて、＋αのスキルを身につけたい方へ

JavaやLinuxを学んでいても、「このままで市場価値は上がるのか」「キャリアの選択肢を広げたい」と感じる方は少なくありません。

AIを学ぶならアイデミープレミアム

3. getHeaderNamesメソッドとは？

getHeaderNames()メソッドは、Partに含まれるすべてのヘッダー名をCollection<String>として返します。このメソッドを使うことで、どんなヘッダーが含まれているのかを一覧で取得することができます。取得したヘッダー名を使って、それぞれのヘッダー値も確認できます。

4. getHeaderNamesメソッドの使い方

以下は、getHeaderNamesメソッドを使って、すべてのヘッダー名とその値を出力するJava Servletのサンプルです。


import java.io.IOException;
import java.util.Collection;
import javax.servlet.ServletException;
import javax.servlet.annotation.MultipartConfig;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.Part;

@MultipartConfig
public class HeaderInfoServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        Part filePart = request.getPart("file");
        Collection<String> headerNames = filePart.getHeaderNames();

        for (String name : headerNames) {
            String value = filePart.getHeader(name);
            response.getWriter().println(name + ": " + value);
        }
    }
}

5. 実行結果のイメージ

上記のServletを実行すると、次のようにアップロードされたファイルのヘッダー情報が表示されます。


content-disposition: form-data; name="file"; filename="example.png"
content-type: image/png

このように、getHeaderNamesを使えば、どのヘッダーが付いているかを簡単に確認できます。

6. すべてのヘッダー値を表示するには

getHeaderNamesで取得した名前を使って、getHeadersを呼び出すことで、同じヘッダー名に複数の値がある場合もすべて出力することができます。


Collection<String> headerNames = filePart.getHeaderNames();
for (String name : headerNames) {
    Collection<String> values = filePart.getHeaders(name);
    for (String value : values) {
        System.out.println(name + ": " + value);
    }
}

7. HTMLフォームの設定方法

Servletでファイルアップロードを行うには、HTMLフォームにenctype="multipart/form-data"を設定する必要があります。設定がないとPartとしてデータを取得できません。


<form action="upload" method="post" enctype="multipart/form-data">
    <input type="file" name="file">
    <button type="submit">アップロード</button>
</form>

8. Partで取得できる主なヘッダーの種類

Partインターフェースを使うと、以下のような代表的なヘッダーを取得できます。

content-disposition：フォームフィールドの名前やファイル名の情報
content-type：アップロードされたファイルのMIMEタイプ
content-length：ファイルのサイズ情報

これらのヘッダー情報は、アップロードされたファイルをサーバー側で適切に処理するために非常に重要です。

9. Servletでのヘッダー確認はバリデーションにも活用できる

アップロードされたファイルが許可された種類であるか、サイズが制限を超えていないかなどを判定する際にも、getHeaderNamesで取得したヘッダー情報が活躍します。ヘッダーを調べて、想定外のファイル形式や不正なデータを検出するバリデーション処理を行うことで、安全性の高いWebアプリケーションを構築できます。

サーブレットやJSPの基礎を体系的に理解したい人には、定番の入門書がこちらです。

スッキリわかるサーブレット＆JSP入門をAmazonで見る

※ Amazonアソシエイト・プログラムを利用しています