ウェブサイト検索

サーブレットのファイルアップロードとファイルダウンロードの例


サーブレットによるファイルのアップロードとダウンロードは、Javaウェブアプリケーションにおいて一般的なタスクです。最近、Javaサーブレットについて多く書いてきたので、サーバーへのサーブレットファイルのアップロードと、クライアントへのサーバーからのダウンロードのサンプル例を提供しようと思いました。

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

私たちのユースケースは、クライアントがサーバーにアップロードするためのローカルファイルを選択できるシンプルなHTMLページを提供することです。ファイルアップロードのリクエストを提出すると、私たちのサーブレットプログラムがそのファイルをサーバーのディレクトリにアップロードし、ユーザーがファイルをダウンロードできるURLを提供します。セキュリティ上の理由から、ユーザーにはファイルを直接ダウンロードするためのURLは提供されず、代わりにファイルをダウンロードするためのリンクが渡され、私たちのサーブレットがリクエストを処理し、ファイルをユーザーに送信します。Eclipseで動的なウェブプロジェクトを作成し、プロジェクト構造は下の画像のようになります。

サーバーにファイルをアップロードするためのJavaのHTMLページ

ファイルをサーバーにアップロードするには、サーブレットに POST リクエストを送り、フォームを送信します。ファイルのアップロードに GET メソッドを使用することはできません。もう一つ注意すべき点は、フォームの enctype は multipart/form-data である必要があるということです。ユーザーのファイルシステムからファイルを選択するには、type を file とした input 要素を使用する必要があります。したがって、ファイルをアップロードするためのシンプルな HTML ページ index.html を作成することができます:

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

ファイルアップロードのためのサーバーファイル位置

私たちは、サーバーのあるディレクトリにファイルを格納する必要があります。このディレクトリはプログラム内にハードコーディングすることもできますが、柔軟性を高めるために、デプロイメントディスクリプタのコンテキストパラメータで構成可能にしておきます。また、アップロードファイルの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>ServletFileUploadDownloadExample</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
  </welcome-file-list>
  <context-param>
    <param-name>tempfile.dir</param-name>
    <param-value>tmpfiles</param-value>
  </context-param>
</web-app>

ファイルアップロード位置のためのServletContextListener

ファイルの場所のコンテキストパラメータを読み取り、それに基づいてFileオブジェクトを作成する必要があるため、コンテキストが初期化される際にそれを行うServletContextListenerを記述できます。絶対ディレクトリの場所とFileオブジェクトをコンテキスト属性として設定し、他のサーブレットで使用できるようにします。私たちのServletContextListenerの実装コードは以下のようになります。

package com.journaldev.servlet;

import java.io.File;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class FileLocationContextListener implements ServletContextListener {

    public void contextInitialized(ServletContextEvent servletContextEvent) {
    	String rootPath = System.getProperty("catalina.home");
    	ServletContext ctx = servletContextEvent.getServletContext();
    	String relativePath = ctx.getInitParameter("tempfile.dir");
    	File file = new File(rootPath + File.separator + relativePath);
    	if(!file.exists()) file.mkdirs();
    	System.out.println("File Directory created to be used for storing files");
    	ctx.setAttribute("FILES_DIR_FILE", file);
    	ctx.setAttribute("FILES_DIR", rootPath + File.separator + relativePath);
    }

	public void contextDestroyed(ServletContextEvent servletContextEvent) {
		//do cleanup if needed
	}
	
}

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

更新: Servlet Specs 3はAPIでファイルをサーバーにアップロードするサポートを追加したので、サードパーティのAPIを使用する必要はありません。Servlet 3 アップロードファイルをご覧ください。ファイルのアップロードには、Apache Commons FileUploadユーティリティを使用します。私たちのプロジェクトではバージョン1.3を使用しており、FileUploadはApache Commons IO jarに依存しているため、両方をプロジェクトのlibディレクトリに配置する必要があります。上の画像でプロジェクト構造を見ることができます。DiskFileItemFactoryファクトリを使用して、HttpServletRequestオブジェクトを解析し、FileItemのリストを返すメソッドを提供します。

FileItemは、アップロードするファイルのファイル名、フォーム内のフィールド名、サイズおよびコンテンツタイプの詳細を取得するための便利なメソッドを提供します。ディレクトリにファイルを書くためには、Fileオブジェクトを作成し、それをFileItemのwrite()メソッドの引数として渡せば良いだけです。サーブレットの目的がファイルをアップロードすることであるため、サーブレットのDiskFileItemFactoryオブジェクトインスタンスを初期化するためにinit()メソッドをオーバーライドします。

私たちは、このオブジェクトを doPost() メソッドの実装で使用して、サーバーディレクトリにファイルをアップロードします。ファイルが正常にアップロードされると、ファイルをダウンロードするための URL をクライアントに返します。HTMLリンクは GET メソッドを使用するため、URL にファイル名のパラメータを追加し、同じサーブレットの doGet() メソッドを利用してファイルダウンロードプロセスを実装できます。ダウンロードファイルのサーブレットを実装するために、最初にファイルの InputStream を開き、ServletContext.getMimeType() メソッドを使用してファイルの MIME タイプを取得し、それをレスポンスのコンテンツタイプとして設定します。

レスポンスのコンテンツ長をファイルの長さとして設定する必要があります。クライアントが私たちがファイルをレスポンスとして送信していることを理解できるようにするために、“Content-Disposition” ヘッダーを "attachment; filename=“fileName”"として設定する必要があります。レスポンスの設定が完了したら、InputStream からファイルの内容を読み取り、それを ServletOutputStream に書き込み、出力をクライアントにフラッシュします。UploadDownloadFileServlet の最終的な実装は以下のようになります。

package com.journaldev.servlet;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.util.Iterator;
import java.util.List;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

@WebServlet("/UploadDownloadFileServlet")
public class UploadDownloadFileServlet extends HttpServlet {
	private static final long serialVersionUID = 1L;
    private ServletFileUpload uploader = null;
	@Override
	public void init() throws ServletException{
		DiskFileItemFactory fileFactory = new DiskFileItemFactory();
		File filesDir = (File) getServletContext().getAttribute("FILES_DIR_FILE");
		fileFactory.setRepository(filesDir);
		this.uploader = new ServletFileUpload(fileFactory);
	}
	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		String fileName = request.getParameter("fileName");
		if(fileName == null || fileName.equals("")){
			throw new ServletException("File Name can't be null or empty");
		}
		File file = new File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileName);
		if(!file.exists()){
			throw new ServletException("File doesn't exists on server.");
		}
		System.out.println("File location on server::"+file.getAbsolutePath());
		ServletContext ctx = getServletContext();
		InputStream fis = new FileInputStream(file);
		String mimeType = ctx.getMimeType(file.getAbsolutePath());
		response.setContentType(mimeType != null? mimeType:"application/octet-stream");
		response.setContentLength((int) file.length());
		response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
		
		ServletOutputStream os = response.getOutputStream();
		byte[] bufferData = new byte[1024];
		int read=0;
		while((read = fis.read(bufferData))!= -1){
			os.write(bufferData, 0, read);
		}
		os.flush();
		os.close();
		fis.close();
		System.out.println("File downloaded at client successfully");
	}

	protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		if(!ServletFileUpload.isMultipartContent(request)){
			throw new ServletException("Content type is not multipart/form-data");
		}
		
		response.setContentType("text/html");
		PrintWriter out = response.getWriter();
		out.write("<html><head></head><body>");
		try {
			List<FileItem> fileItemsList = uploader.parseRequest(request);
			Iterator<FileItem> fileItemsIterator = fileItemsList.iterator();
			while(fileItemsIterator.hasNext()){
				FileItem fileItem = fileItemsIterator.next();
				System.out.println("FieldName="+fileItem.getFieldName());
				System.out.println("FileName="+fileItem.getName());
				System.out.println("ContentType="+fileItem.getContentType());
				System.out.println("Size in bytes="+fileItem.getSize());
				
				File file = new File(request.getServletContext().getAttribute("FILES_DIR")+File.separator+fileItem.getName());
				System.out.println("Absolute Path at server="+file.getAbsolutePath());
				fileItem.write(file);
				out.write("File "+fileItem.getName()+ " uploaded successfully.");
				out.write("<br>");
				out.write("<a href=\"UploadDownloadFileServlet?fileName="+fileItem.getName()+"\">Download "+fileItem.getName()+"</a>");
			}
		} catch (FileUploadException e) {
			out.write("Exception in uploading file.");
		} catch (Exception e) {
			out.write("Exception in uploading file.");
		}
		out.write("</body></html>");
	}

}

プロジェクトのサンプル実行は以下の画像に示されています。

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

以下のURLからApache Commons IOのjarファイルとApache Commons FileUploadのjarファイルをダウンロードできます。 https://commons.apache.org/proper/commons-fileupload/download_fileupload.cgi https://commons.apache.org/proper/commons-io/download_io.cgi

サーブレットファイルアップロードダウンロードの例プロジェクトをダウンロード

シリーズの次の記事ではサーブレット例外処理についてチェックしてください。

関連記事: