Поиск по сайту:

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

Загрузка файла сервлета и загрузка файла в последнее время являются распространенной задачей в сервлете Java, и я подумал предоставить пример примера загрузки файла сервлета на сервер, а затем загрузки с сервера на клиент.

Файл загрузки сервлета

HTML-страница для загрузки файла Java на сервер

Мы можем загрузить файл на сервер, отправив почтовый запрос на сервлет и отправив форму. Мы не можем использовать метод GET для загрузки файла. Еще один момент, на который стоит обратить внимание, это то, что enctype формы должен быть multipart/form-data. Чтобы выбрать файл из пользовательской файловой системы, нам нужно использовать элемент ввода с типом файла. Таким образом, у нас может быть простая 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 зависит от jar-файла ввода-вывода Apache Commons, поэтому нам нужно поместить оба в каталог lib проекта, как вы можете видеть выше. изображение для структуры проекта. Мы будем использовать фабрику DiskFileItemFactory, которая предоставляет метод для анализа объекта HttpServletRequest и возврата списка FileItem. FileItem предоставляет полезный метод для получения имени файла, имени поля в форме, размера и сведений о типе содержимого файла, который необходимо загрузить. Чтобы записать файл в каталог, все, что нам нужно сделать, это создать объект File и передать его в качестве аргумента методу FileItem write(). Поскольку вся цель сервлета заключается в загрузке файла, мы переопределим метод 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>");
	}

}

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

Вы можете загрузить jar-файл Apache Commons IO и Apache Commons FileUpload по указанным ниже URL-адресам. https://commons.apache.org/proper/commons-io/download_io.cgi

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

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