Пример загрузки файла и загрузки файла через сервлет

Сервлет Загрузка файла и Загрузка файла – это обычная задача в веб-приложении Java. Поскольку я недавно много писал о сервлетах Java, я решил предоставить пример загрузки файла в сервер от сервлета, а затем загрузки с сервера на клиент.

Загрузка файла сервлетом

Наш случай использования – предоставить простую HTML-страницу, где клиент может выбрать локальный файл для загрузки на сервер. При отправке запроса на загрузку файла наша программа-сервлет загрузит файл в каталог на сервере, а затем предоставит URL, по которому пользователь может загрузить файл. В целях безопасности пользователю не будет предоставлен прямой URL для загрузки файла, вместо этого им будет предоставлена ссылка для загрузки файла, и наш сервлет обработает запрос и отправит файл пользователю. Мы создадим динамический веб-проект в Eclipse, и структура проекта будет выглядеть как на изображении ниже. Давайте рассмотрим все компоненты нашего веб-приложения и поймем реализацию.

HTML Страница для загрузки файла на сервере с использованием Java

Мы можем загрузить файл на сервер, отправив POST-запрос на сервлет и предоставив форму. Нельзя использовать метод GET для загрузки файла. Еще один момент, который следует отметить, – это то, что enctype формы должен быть multipart/form-data. Чтобы выбрать файл из файловой системы пользователя, нам нужно использовать элемент input с type равным file. Таким образом, у нас может быть простая 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>

Местоположение файла на сервере для загрузки файла

Нам нужно сохранить файл в некоторый каталог на сервере, мы можем захардкодить этот каталог в программе, но для лучшей гибкости мы будем хранить его в конфигурационных параметрах контекста в файле развертывания. Также мы добавим нашу страницу загрузки файла в список страниц приветствия. Наш файл 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>

Слушатель контекста для расположения загруженных файлов

Поскольку нам нужно считать параметр контекста для расположения файла и создать объект 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) {
		// выполнить очистку при необходимости
	}
	
}

Сервлет загрузки и скачивания файлов

Обновление: Спецификация Servlet 3 добавила поддержку загрузки файлов на сервер в API, поэтому нам не нужно использовать сторонние API. Пожалуйста, ознакомьтесь с Загрузкой файла Servlet 3. Для загрузки файлов мы будем использовать утилиту Apache Commons FileUpload. В нашем проекте мы используем версию 1.3, FileUpload зависит от библиотеки Apache Commons IO, поэтому нам нужно поместить обе библиотеки в каталог lib проекта, как показано на изображении структуры проекта выше. Мы будем использовать фабрику DiskFileItemFactory, которая предоставляет метод для разбора объекта HttpServletRequest и возвращает список FileItem. FileItem предоставляет полезные методы для получения имени файла, имени поля в форме, размера и типа содержимого файла, который нужно загрузить. Для записи файла в каталог нам просто нужно создать объект File и передать его в качестве аргумента методу write() FileItem. Поскольку цель сервлета – загрузка файла, мы переопределим метод init() для инициализации объекта DiskFileItemFactory в экземпляре сервлета. Мы будем использовать этот объект в реализации метода 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>");
	}

}

Пример выполнения проекта показан на изображениях ниже.

Загрузить файл сервлета Проект загрузки

Вы можете скачать Apache Commons IO jar и Apache Commons FileUpload jar из следующих URL-адресов. https://commons.apache.org/proper/commons-fileupload/download_fileupload.cgi https://commons.apache.org/proper/commons-io/download_io.cgi

Загрузить файл сервлета Пример проекта загрузки

Проверьте следующую статью в серии о Обработке исключений в сервлетах.

Source:
https://www.digitalocean.com/community/tutorials/servlet-upload-file-download-example