English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Загрузка файлов Servlet

Servlet можно использовать вместе с тегом HTML form, чтобы позволить пользователю загружать файлы на сервер. Загружаемые файлы могут быть текстовыми файлами, изображениями или любыми документами.

В этом материале используются следующие файлы:

  • upload.jsp: Форма для загрузки файла.

  • message.jsp: Страница перехода после успешной загрузки.

  • UploadServlet.java: Servlet для обработки загрузки.

  • Необходимо включить jar-файлы: commons-fileupload-1.3.2, commons-io-2.5.jar.

Структура представлена на рисунке ниже:

Примечание:Servlet 3.0 уже включает поддержку загрузки файлов, и разработчикам больше не нужно добавлять компонент Commons FileUpload в проект.

Давайте рассмотрим это более подробно.

Создание формы загрузки файла

Ниже приведен HTML-код, создающий форму загрузки файла. Вот几点, на которые следует обратить внимание:

  • форма method атрибут должен быть установлен на POST метод, использовать метод GET нельзя.

  • форма enctype атрибут должен быть установлен на multipart/form-data.

  • форма action Атрибут должен быть установлен на Servlet на сервере, который обрабатывает загрузку файлов. В данном примере используется UploadServlet Servlet для загрузки файла.

  • Для загрузки одного файла вам следует использовать один<input type="file" .../> тег с атрибутом type="file". Чтобы允нить загрузку нескольких файлов, включите несколько тегов input с различными значениями атрибута name. Вводные теги имеют различные значения атрибута name. Браузер ассоциирует каждый тег input с кнопкой выбора файла.

Код файла upload.jsp следующий:

<%@ page language="java" contentType="text/html; charset=UTF-8" %>
    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>Пример загрузки файла - Сайт основного руководства</title>
</head>
<body>
<h1>Пример загрузки файла - Сайт основного руководства</h1>
<form method="post" action="/TomcatTest/UploadServlet" enctype="multipart/form-data">
    Выберите файл:
    <input type="file" name="uploadFile"/>
    <br/><br/>
    <input type="submit" value="Загрузить" />
</form>
</body>
</html>

Написание后台 Servlet

Ниже представлен исходный код UploadServlet, который отвечает за обработку загрузки файлов. Перед этим мы должны убедиться, что зависимые пакеты уже добавлены в 目录 проекта WEB-INF/lib:

  • Данный пример зависит от FileUpload, поэтому一定要 убедитесь, что у вас в classpath есть последняя версия commons-fileupload.x.x.jar Файл. Его можно найти на http://commons.apache.org/proper/commons-fileupload/ Скачать.

  • FileUpload зависит от Commons IO, поэтому一定要 убедитесь, что у вас в classpath есть последняя версия commons-io-x.x.jar Файл. Его можно найти на http://commons.apache.org/proper/commons-io/ Скачать.

Вы можете напрямую скачивать два зависимых пакета, предоставляемых на этом сайте:

Исходный код UploadServlet представлен следующим образом:

пакет com.w3codebox.test;
импорт java.io.File;
импорт java.io.IOException;
импорт java.io.PrintWriter;
импорт java.util.List;
 
импорт javax.servlet.ServletException;
импорт javax.servlet.annotation.WebServlet;
импорт javax.servlet.http.HttpServlet;
импорт javax.servlet.http.HttpServletRequest;
импорт javax.servlet.http.HttpServletResponse;
 
импорт org.apache.commons.fileupload.FileItem;
импорт org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
 
/**
 * Класс реализации Servlet UploadServlet
 */
@WebServlet("/UploadServlet")
public class UploadServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
     
    // Каталог для хранения загруженных файлов
    private static final String UPLOAD_DIRECTORY = "upload";
 
    // Настройка загрузки
    private static final int MEMORY_THRESHOLD = 1024 * 1024 * 3; // 3MB
    private static final int MAX_FILE_SIZE = 1024 * 1024 * 40; // 40MB
    private static final int MAX_REQUEST_SIZE = 1024 * 1024 * 50; // 50MB
 
    /**
     * Загрузка данных и сохранение файла
     */
    protected void doPost(HttpServletRequest request,
        HttpServletResponse response) throws ServletException, IOException {
        // Проверка является ли это загрузка мультимедиа
        if (!ServletFileUpload.isMultipartContent(request)) {
            // Если нет, то остановите
            PrintWriter writer = response.getWriter();
            writer.println("Ошибка: Форма должна содержать enctype=multipart/form-data");
            writer.flush();
            return;
        }
 
        // Настройка параметров загрузки
        DiskFileItemFactory factory = new DiskFileItemFactory();
        // установка порога памяти - при превышении создается временный файл и хранится в временном каталоге
        factory.setSizeThreshold(MEMORY_THRESHOLD);
        // установка временного каталога для хранения
        factory.setRepository(new File(System.getProperty("java.io.tmpdir")));
 
        ServletFileUpload upload = new ServletFileUpload(factory);
         
        // установка максимального размера загружаемого файла
        upload.setFileSizeMax(MAX_FILE_SIZE);
         
        // установка максимального значения запроса (включая файлы и данные формы)
        upload.setSizeMax(MAX_REQUEST_SIZE);
        // обработка китайских символов
        upload.setHeaderEncoding("UTF-8"); 
        // создаем временный путь для хранения загруженных файлов
        // этот путь относителен к текущему приложению
        String uploadPath = request.getServletContext().getRealPath("./") + File.separator + UPLOAD_DIRECTORY;
       
         
        // если директория не существует, то создаем её
        File uploadDir = new File(uploadPath);
        if (!uploadDir.exists()) {
            uploadDir.mkdir();
        }
 
        try {
            // парсинг содержимого запроса для извлечения данных файлов
            @SuppressWarnings("unchecked")
            List<FileItem> formItems = upload.parseRequest(request);
 
            if (formItems != null && formItems.size() > 0) {
                // итерация по данным формы
                for (FileItem item : formItems) {
                    // обработка полей, не входящих в форму
                    if (!item.isFormField()) {
                        String fileName = new File(item.getName()).getName();
                        String filePath = uploadPath + File.separator + fileName;
                        File storeFile = new File(filePath);
                        // Вывод路径 файла на экран
                        System.out.println(filePath);
                        // Сохранение файла на жесткий диск
                        item.write(storeFile);
                        request.setAttribute("message",
                            "Файл загружен успешно!");
                    }
                }
            }
        } catch (Exception ex) {
            request.setAttribute("message",
                    "Ошибка: " + ex.getMessage());
        }
        // Перенаправление на message.jsp
        request.getServletContext().getRequestDispatcher("/message.jsp").forward(
                request, response);
    }
}

Код файла message.jsp выглядит следующим образом:

<%@ page language="java" contentType="text/html; charset=UTF-8" %>
    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>Результат загрузки файла</title>
</head>
<body>
    <center>
        <h2>${message}</h2>
    </center>
</body>
</html>

Компилируйте и запускайте Servlet

Компилируйте Servlet UploadServlet и создайте необходимые записи в файле web.xml, как показано ниже:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">
  <servlet>
    <display-name>UploadServlet</display-name>
    <servlet-name>UploadServlet</servlet-name>
    <servlet-class>com.w3codebox.test.UploadServlet</servlet-class>
  </servlet>
   
  <servlet-mapping>
    <servlet-name>UploadServlet</servlet-name>
    <url-pattern>/TomcatTest/UploadServlet</url-pattern>
  </servlet-mapping>
</web-app>

Теперь попробуйте использовать HTML-форму, которую вы создали ранее, чтобы загрузить файл. Когда вы посещаете в браузере: http://localhost:8080/TomcatTest/upload.jsp , демонстрация будет выглядеть так: