サーブレット3.0の新機能

Java EE 6 開発入門（2）

ファイルアップロード

　サーブレット3.0では、マルチパートリクエストと呼ばれるリクエストにも対応することが正式にサポートされました。Webアプリケーションの中ではファイルのアップロード時に使用されます。ファイルアップロードのときは特殊なリクエストがサーバへ転送されますので、その特殊な形式に合わせたサーブレットを用意しなくてはなりませんした。Commons-FileUploadと呼ばれる、アップロード専用のライブラリが提供されていますように、Webアプリケーションでは頻繁に使われる機能でしたので、正式にサーブレットの仕様としてアップロードを対応しています。

　では次に、ファイルをアップロードするサンプルコードを示します。アップロードする画面（JSP）と、アップロード処理を行うサーブレットの2つを用意します。

リスト9　アップロード用JSP index.jsp

<%@page contentType="text/html" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Upload Page</title>
    </head>
    <body>
        アップロードするファイルを選択してください。
        <form action="upload" enctype="multipart/form-data" method="post">
            <input type="file" name="file" />
            <input Type="submit" />
        </form>
        ${ message }
    </body>
</html>

　アップロードする入力フォーム<form>部分で、enctype="multipart/form-data"が必須になります。また、アップロードするファイルを選択するためのボタンとダイアログを出すため、<input type="file" />タグを用意します。

リスト10　アップロード用サーブレット UploadSampleServlet.java

@WebServlet(name="upload" , urlPatterns={"/upload"})
@MultipartConfig(fileSizeThreshold=2048*1000 , location="/tmp/upload")
public class UploadSampleServlet extends HttpServlet {
   
    protected void processRequest(HttpServletRequest request, HttpServletResponse response)
    throws ServletException, IOException {
        String filename = "";

        // マルチパートリクエストの情報を取得する
        Part part = request.getPart("file");

        // 送信されたマルチパートのヘッダーを取得する
        String headerString = part.getHeader("Content-Disposition");
        log(headerString);

        // 以下、ヘッダー文字列からファイル名のみを取り出す処理 ////////
        // 送信ヘッダーの値は form-data; name="file"; filename="選択したファイル名" となる
        String[] headers = headerString.split(";");

        // セミコロン区切りで分割したString配列の中からアップロードしたファイルの名前を取り出す
        for ( String header : headers ) {
            String h = header.trim();   // ヘッダー文字列には前後に空白が入っているので取り除く

            // ヘッダー内からファイル名を取得するため、filenameを含むヘッダー文字列を取り出す
            if ( h.startsWith("filename")) {
                // filename="ファイル名"となっているので、=の右側がファイル名
                h = h.substring( h.indexOf("=") +1);

                // ブラウザやOSによって、アップロードするファイル名称にローカルの絶対パスが含まれるので取り除く
                int pos = h.lastIndexOf("\\");
                if (pos > -1) {
                    h = h.substring(pos +1);
                }
                // もしダブルコーテーションがある場合は除去する
                filename = h.replace("\"", "");
            }
        }

        // @MultipartConfigのlocationで指定したディレクトリにアップロードしたファイルが配置される
        part.write(filename);

        // メッセージをリクエスト属性に追加し、JSPに表示させる
        request.setAttribute("message", "アップロードが完了しました");

        //String fileName = ge
        RequestDispatcher rd = request.getRequestDispatcher("index.jsp");
        rd.forward(request, response);
    }
}

　アップロード機能に関する設定は クラスの先頭部のアノテーションである @MultipartConfig(fileSizeThreshold=2048*1000 , location="/tmp/upload") で行っています。

　fileSizeThresholdは、アップロードするファイルサイズの上限をバイト単位で指定し、locationは、アップロードされたファイルが、サーバのどのディレクトリに格納されるかを指定します。

　以上、リクエストヘッダを加工してファイル名の文字列を作るところでいろいろとしておりますが、ファイル名さえ特定できるのであれば、

Part part = request.getPart("[fileタグで指定した名称]");

でマルチパートリクエストのオブジェクトを取得し、

part.write(filename)

とすることでサーバへファイルの書き出しを行ってくれます。非常に簡単です。

まとめ

　今回はJava EE 6での中核となるサーブレット3.0の新機能について紹介しました。アノテーションを使って簡単に設定できるようになっていますので、拡張性を重視しつつ、従来のサーブレットの煩わしさから開放されることがご理解いただけたと思います。

　次回はJava EE 6のもう一つの基本仕様であるJSF2.1について解説します。

参考文献

• 寺田 佳央 : Servlet 3.0 の新機能概要
• Tomcat5 サーブレット/JSP コンテナ:レルム設定方法
• JavaRoad : 9 BASIC認証