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

生徒

「Java Servletでファイルをアップロードするとき、ヘッダーが複数ある場合はどうやって全部取得するんですか？」

先生

「そういうときには、javax.servlet.http.PartインターフェースのgetHeadersメソッドを使うと、同じ名前の複数のヘッダーをまとめて取得できますよ。」

生徒

「なるほど！でも、getHeaderじゃだめなんですか？」

先生

「getHeaderは最初の一つしか取れません。複数の値があるときにはgetHeadersを使う必要があるんです。実際の使い方を見てみましょう。」

1. Partインターフェースとは

Javaのjavax.servlet.http.Partインターフェースは、Servletでファイルアップロードを行う際に使用されるインターフェースです。Servlet 3.0以降で使用可能で、マルチパートリクエストを処理するために使われます。アップロードされたファイルやデータに対して、名前、サイズ、コンテンツタイプ、そしてヘッダー情報などを取得できます。

2. getHeadersメソッドの基本

getHeaders(String name)メソッドは、指定したヘッダー名に対応するすべてのヘッダー値を取得するために使います。戻り値はjava.util.Collection<String>型で、複数の値をまとめて扱うことができます。

たとえば、同じ名前のヘッダーが複数含まれている場合、すべての値をループで確認できます。

3. getHeadersの基本的な使い方

以下は、アップロードされたファイルのcontent-dispositionヘッダーに含まれるすべての値を表示するサンプルです。


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 UploadServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        Part part = request.getPart("file");
        Collection<String> headers = part.getHeaders("content-disposition");

        response.setContentType("text/plain");
        for (String header : headers) {
            response.getWriter().println("ヘッダー: " + header);
        }
    }
}

4. getHeaderとの違いを理解しよう

getHeaderメソッドは指定された名前の最初のヘッダーしか返しません。それに対してgetHeadersはすべての同名ヘッダーを取得します。

たとえば、次のように複数のSet-Cookieヘッダーがある場合、getHeaderでは一つしか取れませんが、getHeadersを使えば全部取得できます。

5. 実際のヘッダー一覧を出力してみる

getHeaderNames()と組み合わせることで、利用可能なすべてのヘッダー名と値を確認することもできます。以下のように実装します。


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

6. アップロードされたファイルの情報を抽出する

content-dispositionヘッダーの中には、アップロードされたファイル名やフォームフィールド名が含まれています。以下のようにしてファイル名を取得できます。


String header = part.getHeader("content-disposition");
for (String cd : header.split(";")) {
    if (cd.trim().startsWith("filename")) {
        String fileName = cd.substring(cd.indexOf('=') + 1).trim().replace("\"", "");
        System.out.println("ファイル名: " + fileName);
    }
}

7. HTMLフォームの設定も忘れずに

Partを使うServletでは、HTML側のフォームにenctype="multipart/form-data"を指定する必要があります。これがないとgetPartでファイルを取得できません。


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