ウェブサイト検索

Servlet 3 ファイルアップロード - @MultipartConfig, Part


今日、@MultipartConfig アノテーションと javax.servlet.http.Part を使用した Servlet 3 ファイルアップロードの例について見ていきます。少し前に Servlet ファイルアップロード に関する記事を書き、Apache FileUpload API を使用しましたが、ここでは Servlet 3 ファイルアップロード機能を使用します。

サーブレット3ファイルアップロード

ファイルアップロードはウェブアプリケーションで一般的なタスクであるため、Servlet Specs 3.0はサーバーへのファイルアップロードに対する追加サポートを提供し、これに対してサードパーティのAPIに依存する必要がなくなりました。このチュートリアルでは、Servlet 3.0 APIを使用してサーバーにファイルをアップロードする方法を見ていきます。

MultipartConfig

ファイルアップロードハンドラサーブレットにMultipartConfig注釈を付けて、ファイルをサーバーにアップロードするために使用されるmultipart/form-dataリクエストを処理する必要があります。MultipartConfig注釈には以下の属性があります:

  • fileSizeThreshold: ファイルがディスクに書き込まれるサイズの閾値を指定できます。サイズ値はバイト単位で、1024*1024*10は10MBです。
  • 場所: ファイルがデフォルトで保存されるディレクトリ。デフォルト値は「 」です。
  • maxFileSize: ファイルをアップロードする際に許可される最大サイズで、その値はバイトで提供されます。デフォルト値は -1L で、これは無制限を意味します。
  • maxRequestSize: multipart/form-dataリクエストで許可される最大サイズ。デフォルト値は-1Lで、これは制限なしを意味します。

Java アノテーションチュートリアルでアノテーションについてもっと読む。

パートインターフェース

パートインターフェースは、multipart/form-dataのPOSTリクエスト内で受信した部分またはフォーム項目を表します。重要なメソッドには、getInputStream()やwrite(String fileName)があり、これを使用してファイルの読み取りと書き込みを行うことができます。

HttpServletRequestの変更

HttpServletRequest に multipart/form-data リクエスト内のすべてのパーツを取得するために getParts() メソッドを使用する新しいメソッドが追加されました。特定のパーツは getPart(String partName) メソッドを使用して取得できます。上記の API メソッドを使用してファイルをサーブレットにアップロードするシンプルなプロジェクトを見てみましょう。私たちのプロジェクト構造は以下の画像のようになります。

HTMLフォーム

私たちはファイルを選択してサーバーにリクエストを送信してアップロードさせるためのシンプルなHTMLページを持っています。index.html

<html>
<head></head>
<body>
<form action="FileUploadServlet" method="post" enctype="multipart/form-data">
Select File to Upload:<input type="file" name="fileName">
<br>
<input type="submit" value="Upload">
</form>
</body>
</html>

ファイルアップロードサーブレット

こちらが私たちのファイルアップロードサーブレットの実装です。FileUploadServlet.java

package com.journaldev.servlet;
 
import java.io.File;
import java.io.IOException;
 
import javax.servlet.ServletException;
import javax.servlet.annotation.MultipartConfig;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.Part;
 
@WebServlet("/FileUploadServlet")
@MultipartConfig(fileSizeThreshold=1024*1024*10, 	// 10 MB 
                 maxFileSize=1024*1024*50,      	// 50 MB
                 maxRequestSize=1024*1024*100)   	// 100 MB
public class FileUploadServlet extends HttpServlet {
 
    private static final long serialVersionUID = 205242440643911308L;
	
    /**
     * Directory where uploaded files will be saved, its relative to
     * the web application directory.
     */
    private static final String UPLOAD_DIR = "uploads";
     
    protected void doPost(HttpServletRequest request,
            HttpServletResponse response) throws ServletException, IOException {
        // gets absolute path of the web application
        String applicationPath = request.getServletContext().getRealPath("");
        // constructs path of the directory to save uploaded file
        String uploadFilePath = applicationPath + File.separator + UPLOAD_DIR;
         
        // creates the save directory if it does not exists
        File fileSaveDir = new File(uploadFilePath);
        if (!fileSaveDir.exists()) {
            fileSaveDir.mkdirs();
        }
        System.out.println("Upload File Directory="+fileSaveDir.getAbsolutePath());
        
        String fileName = null;
        //Get all the parts from request and write it to the file on server
        for (Part part : request.getParts()) {
            fileName = getFileName(part);
            part.write(uploadFilePath + File.separator + fileName);
        }
 
        request.setAttribute("message", fileName + " File uploaded successfully!");
        getServletContext().getRequestDispatcher("/response.jsp").forward(
                request, response);
    }
 
    /**
     * Utility method to get file name from HTTP header content-disposition
     */
    private String getFileName(Part part) {
        String contentDisp = part.getHeader("content-disposition");
        System.out.println("content-disposition header= "+contentDisp);
        String[] tokens = contentDisp.split(";");
        for (String token : tokens) {
            if (token.trim().startsWith("filename")) {
                return token.substring(token.indexOf("=") + 2, token.length()-1);
            }
        }
        return "";
    }
}

@MultipartConfigアノテーションを使用して、アップロードファイルの異なるサイズパラメータを指定することに注意してください。クライアントによって送信されたファイル名を取得するには、リクエストヘッダーの「content-disposition」属性を使用する必要があります。ファイルは同じ名前で保存します。ディレクトリの場所は、ファイルを保存するウェブアプリケーションに対して相対的です。Apache Commons FileUploadの例のように、他の場所に設定することもできます。

レスポンスJSP

ファイルがサーバーに正常にアップロードされた後、クライアントに応答として送信される簡単なJSPページです。response.jsp

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
    "https://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Upload File Response</title>
</head>
<body>
	<%-- Using JSP EL to get message attribute value from request scope --%>
    <h2>${requestScope.message}</h2>
</body>
</html>

デプロイメント記述子

サーブレットファイルのアップロードに関してweb.xmlファイルに新しいことは何もありません。それはindex.htmlをウェルカムファイルとして使用するためだけに使われています。web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://java.sun.com/xml/ns/javaee" xsi:schemaLocation="https://java.sun.com/xml/ns/javaee https://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
  <display-name>ServletFileUploadExample</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
  </welcome-file-list>
</web-app>

今、アプリケーションを実行すると、以下のページが応答として得られます。

Upload File Directory=/Users/pankaj/Documents/workspace/j2ee/.metadata/.plugins/org.eclipse.wst.server.core/tmp0/wtpwebapps/ServletFileUploadExample/uploads
content-disposition header= form-data; name="fileName"; filename="IMG_2046.jpg"

私はEclipseを通じてTomcatを実行しています。そのため、ファイルの場所はこのようになっています。コマンドラインを通じてTomcatを実行し、アプリケーションをWARファイルとしてwebappsディレクトリにエクスポートしてデプロイすると、異なる構造になりますが、わかりやすいものになります。

Servlet 3 マルチパートファイルアップロードプロジェクトをダウンロードする

関連記事: