Servlet JSP Tutorial -- 1.8 Servlet Upload File and Download File Example

爱被打了一巴掌 2022-06-02 09:52 146阅读 0赞

Servlet上传文件和下载文件是Java Web应用程序中的常见任务。 由于最近我写了很多关于 java servlet 的文章，我想提供一个 servlet 文件上传到服务器的示例，然后从服务器下载到客户端。

1.  Servlet Upload File  
    
    
     *  HTML Page for Java Uploading File to Server
     *  Server File Location for File Upload
     *  ServletContextListener for File Upload Location
2.  File Upload Download Servlet  
    
    
     *  Download Servlet File Upload Download Project

## Servlet Upload File ##

我们的栗子提供一个简单的 HTML 页面，客户端可以选择一个本地文件上传到服务器。在提交上传文件的请求时，我们的 Servlet 程序会将文件上传到服务器的一个目录中，然后提供可供用户下载文件的 URL。出于安全考虑，不会提供直接 URL 给用户，而是给他们一个下载文件的链接，我们的 Servlet 会处理请求并将文件发送给用户。

我们将在 IDEA 中创建一个动态 Web 项目，项目结构如下图所示。  
![这里写图片描述][SouthEast]  
然我们来看一下这个 Web 应用程序的所有组件，并理解实现。

### HTML Page for Java Uploading File to Server ###

我们可以通过发送一个提交表单的 POST 请求给 Servlet来上传一个文件到服务器。不能使用 GET 方法来上传文件。

还有一点需要注意的是，form 的形式应该是 `multipart/form-data`

要从用户文件系统中选择文件，我们需要使用元素类型为 file 的 input。

所以我们创建一个简单的 HTML 页面 index.html 来上传文件：

<!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </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>

### Server File Location for File Upload ###

我们需要将文件存储到服务器的某一个目录，我们可以在程序中对此目录进行硬编码，但为了获得更好的灵活性，我们将在部署描述符 `context-param` 中保持其可配置性。 我们也将我们的上传文件的HTML页面添加到 `welcome-file-list`。  
web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1">
        <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 for File Upload Location ###

由于我们需要读取文件位置的上下文参数并从中创建一个File对象，我们可以编写一个 `ServletContextListener` 来在上下文初始化时执行此操作。 我们可以将绝对目录位置和 File 对象设置为上下文属性，以供其他 servlet 使用。

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
        }
    
    }

### File Upload Download Servlet ###

更新：Servlet 3.0 规范 API 增加了对服务器上传文件的支持，所以我们不需要使用任何第三方API。[Servlet 3 File Upload][]

为了文件上传，我们将是使用 `Apache Commons FileUpload` utility，对于我们使用 1.3.3 版本的项目，`FileUpload` 依赖于`Apache Commons IO` jar包，所以我们需要将两者都放在项目的 lib 目录中。目录结构如上图。

我们将使用 `DiskFileItemFactory` 工厂提供一种方法来解析`HttpServletRequest` 对象和返回`FileItem` 列表。 `FileItem`提供了有用的方法来获取需要上传的文件的文件名，表单中的字段名，大小和内容类型的详细信息。 要将文件写入目录，我们只需要创建一个 `File` 对象，并将其作为参数传递给`FileItem`的`write()`方法。

由于 servlet 的目的是上传文件，因此我们将 Override`init()`方法来初始化servlet 的 `DiskFileItemFactory` 对象实例。 我们将在`doPost()`方法实现中使用这个对象将文件上传到服务器目录。

为了实现下载文件 servlet ，我们首先打开文件的`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.net.URLEncoder;
    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() {
            DiskFileItemFactory fileFactory = new DiskFileItemFactory();
            File filesDir = (File) getServletContext().getAttribute("FILES_DIR_FILE");
            fileFactory.setRepository(filesDir);
            this.uploader = new ServletFileUpload(fileFactory);
            this.uploader.setHeaderEncoding("UTF-8");//解决中文文件名乱码问题
        }
    
        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());
            request.setCharacterEncoding("utf-8");
            response.setContentType(mimeType != null ? mimeType : "application/octet-stream;charset=utf-8");
            response.setContentLength((int) file.length());
            //String headerFileName = URLEncoder.encode(fileName, "UTF-8");
            String headerFileName  = new String(fileName.getBytes("utf-8"),"ISO8859-1");
            if (fileName.length() > 150) {
                String shortHeaderFileName = headerFileName.substring(0, 150);
                headerFileName = new String(shortHeaderFileName.getBytes("utf-8"), "ISO8859-1");
    
            }
            response.setHeader("Content-Disposition", "attachment; filename=\"" + headerFileName + "\"");
    
            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;charset=utf-8");
            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>");
        }
    
    }

该项目的示例执行结果如下图。  
![这里写图片描述][SouthEast 1]  
![这里写图片描述][SouthEast 2]  
![这里写图片描述][SouthEast 3]

下一篇文章：Servlet Exception Handling

[SouthEast]: /images/20220602/df478a87567b4a3b8aa48973c1abbbf5.png
[Servlet 3 File Upload]: http://blog.csdn.net/oktfolio/article/details/79063080
[SouthEast 1]: /images/20220602/902744faef1d40baba6f4d89be61a0e8.png
[SouthEast 2]: /images/20220602/14a72512b01f47ad891ebc83c083904b.png
[SouthEast 3]: /images/20220602/9012aa2cd01c4e9daf7c8e4c5239446f.png