Java Servlet 文件下载示例

骑猪看日落 2023-09-30 08:54 5阅读 0赞

本 Java 教程描述了为将文件从服务器传输到客户端（Web 浏览器）的 Java servlet 编写代码的步骤。用户可以通过单击指向 servlet URL 的超链接来下载文件。这对于使用 Java servlet 在 Web 应用程序中实现文件下载功能很有用。

典型步骤如下：

*  使用FileInputStream读取服务器上的文件班级。
 *  通过以下方式确定文件的 MIME 类型：
    
     *   *  通过servlet的getServletContext()方法 获取ServletContext 。
         *  在ServletContext对象上 调用getMimeType(String file)方法来获取文件的 MIME 类型。
 *  为HttpResponse对象设置以下信息：
    
     *   *  通过调用setContentType(String)方法 将内容类型设置为检索到的 MIME 类型。这告诉浏览器什么样的响应是。
         *  通过调用setContentLength(int)方法 设置响应的内容长度。
 *  获取响应的OutputStream对象。
 *  从FileInputStream读取字节数组，然后将它们写入OutputStream。重复直到没有可读取的字节（文件结束）。
 *  关闭FileInputStream和OutputStream。

**笔记：**

*  MIME 类型的映射由 servlet 容器声明。例如，Tomcat 在此文件的“默认 MIME 类型映射”部分下声明了 MIME 映射：

Tomcat 安装目录\\conf\\web.xml

*  如果指定文件没有 MIME 映射，则getMimeType()方法返回null 。在这种情况下，建议将 MIME 类型强制设置为二进制类型：

*  默认情况下，浏览器根据 HTTP 标头中设置的内容类型处理响应。例如，如果响应是图像文件，它会渲染图像，或者如果响应是 PDF 文档，它会打开 PDF 阅读器程序等。如果我们想强制浏览器总是下载文件，我们可以添加这个 header回复：

以下是名为DownloadFileServlet的 Java servlet 的代码：

package net.codejava;
    
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.IOException;
    import java.io.OutputStream;
    
    import javax.servlet.ServletContext;
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/DownloadFileServlet")
    public class DownloadFileServlet extends HttpServlet {
    
    	protected void doGet(HttpServletRequest request, HttpServletResponse response)
    			throws ServletException, IOException {
    		// reads input file from an absolute path
    		String filePath = "E:/servlet-download.png";
    		File downloadFile = new File(filePath);
    		FileInputStream inStream = new FileInputStream(downloadFile);
    
    		// if you want to use a relative path to context root:
    		String relativePath = getServletContext().getRealPath("");
    		System.out.println("relativePath = " + relativePath);
    
    		// obtains ServletContext
    		ServletContext context = getServletContext();
    
    		// gets MIME type of the file
    		String mimeType = context.getMimeType(filePath);
    		if (mimeType == null) {
    			// set to binary type if MIME mapping not found
    			mimeType = "application/octet-stream";
    		}
    		System.out.println("MIME type: " + mimeType);
    
    		// modifies response
    		response.setContentType(mimeType);
    		response.setContentLength((int) downloadFile.length());
    
    		// forces download
    		String headerKey = "Content-Disposition";
    		String headerValue = String.format("attachment; filename=\"%s\"", downloadFile.getName());
    		response.setHeader(headerKey, headerValue);
    
    		// obtains response's output stream
    		OutputStream outStream = response.getOutputStream();
    
    		byte[] buffer = new byte[4096];
    		int bytesRead = -1;
    
    		while ((bytesRead = inStream.read(buffer)) != -1) {
    			outStream.write(buffer, 0, bytesRead);
    		}
    
    		inStream.close();
    		outStream.close();
    	}
    }

在 Web 部署描述符文件web.xml中为此 servlet 配置 URL 映射，如下所示：

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">1</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">2</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">3</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">4</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">5</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">6</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">7</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">8</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">9</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">10</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">11</span></span></span></span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:left;"> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&lt;</code><code>servlet</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>description</code><code>&gt;This servlet sends file to client&lt;/</code><code>description</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>display-name</code><code>&gt;DownloadFileServlet&lt;/</code><code>display-name</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-name</code><code>&gt;DownloadFileServlet&lt;/</code><code>servlet-name</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-class</code><code>&gt;net.codejava.DownloadFileServlet&lt;/</code><code>servlet-class</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&lt;/</code><code>servlet</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&lt;</code><code>servlet-mapping</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-name</code><code>&gt;DownloadFileServlet&lt;/</code><code>servlet-name</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>url-pattern</code><code>&gt;/DownloadFileServlet&lt;/</code><code>url-pattern</code><code>&gt;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&lt;/</code><code>servlet-mapping</code><code>&gt; &nbsp;</code></span></span></span></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

或者使用Servlet 3.0 中的[@WebServlet注解：][WebServlet]

我们可以通过以下形式的 URL 调用 servlet：

*http://localhost:8080/MyWebApp/DownloadFileServlet*

浏览器应要求用户下载文件，如以下屏幕截图所示：

![cd9d3b98b1caab9b8d19e0bb16b0d999.png][]

[WebServlet]: https://www.codejava.net/java-ee/servlet/webservlet-annotation-examples
[cd9d3b98b1caab9b8d19e0bb16b0d999.png]: https://img-blog.csdnimg.cn/img_convert/cd9d3b98b1caab9b8d19e0bb16b0d999.png