实现一个简单的文件下载servlet

Question

我该如何实现简单的文件下载servlet？

思路是通过GET请求index.jsp?filename=file.txt，用户可以从文件servlet下载例如file.txt这样的文件，并将该文件上传给用户。

我能够获取文件，但是如何实现文件下载呢？

- newbie

---

你应认真考虑涉及的安全风险。例如请参见https://www.owasp.org/index.php/Path_Traversal。 - Mark W

Answer 1

假设您可以像以下方式访问servlet

http://localhost:8080/myapp/download?id=7

我需要创建一个servlet并将其注册到web.xml中

web.xml

<servlet>
     <servlet-name>DownloadServlet</servlet-name>
     <servlet-class>com.myapp.servlet.DownloadServlet</servlet-class>
</servlet>
<servlet-mapping>
     <servlet-name>DownloadServlet</servlet-name>
     <url-pattern>/download</url-pattern>
</servlet-mapping>

下载Servlet.java

public class DownloadServlet extends HttpServlet {


    protected void doGet( HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

         String id = request.getParameter("id");

         String fileName = "";
         String fileType = "";
         // Find this file id in database to get file name, and file type

         // You must tell the browser the file type you are going to send
         // for example application/pdf, text/plain, text/html, image/jpg
         response.setContentType(fileType);

         // Make sure to show the download dialog
         response.setHeader("Content-disposition","attachment; filename=yourcustomfilename.pdf");

         // Assume file name is retrieved from database
         // For example D:\\file\\test.pdf

         File my_file = new File(fileName);

         // This should send the file to browser
         OutputStream out = response.getOutputStream();
         FileInputStream in = new FileInputStream(my_file);
         byte[] buffer = new byte[4096];
         int length;
         while ((length = in.read(buffer)) > 0){
            out.write(buffer, 0, length);
         }
         in.close();
         out.flush();
    }
}

- Ali Irawan

---

请注意，“read”循环条件应使用-1而不是0： while ((length = in.read(buffer)) > -1) - reformy

使用注解@WebServlet简化代码@WebServlet(description = "下载Servlet", urlPatterns = {"/download"}) - Mise

如果ID参数不是哈希值，攻击者可能会尝试猜测其他ID并从您的数据库中获取文件。此外，最好验证接收到的ID不包含任何SQL注入。 - Cristian Arteaga

Answer 2

这取决于情况。如果该文件可以通过您的HTTP服务器或Servlet容器公开访问，您可以使用response.sendRedirect()进行重定向。

如果不能公开访问，则需要手动将其复制到响应输出流中：

OutputStream out = response.getOutputStream();
FileInputStream in = new FileInputStream(my_file);
byte[] buffer = new byte[4096];
int length;
while ((length = in.read(buffer)) > 0){
    out.write(buffer, 0, length);
}
in.close();
out.flush();

当然，你需要处理适当的异常。

- ChssPly76

---

内容处理(Content-Disposition)和内容类型(Content-Type)是什么？ - Udo

请注意，“read”循环的条件应该使用-1而不是0： while ((length = in.read(buffer)) > -1) - reformy

@ reformy 0 同样有效。如果读取的字节数为0，则没有任何内容可写入输出。 - ChssPly76

@ChssPly76 文档说如果已到达文件结尾，则返回“-1”。为什么要冒险呢？也许磁盘不可用一秒钟，所以您得到0但应该继续读取？ - reformy

@reformy 也许在你引用这里的内容之前，应该充分阅读文档。特别注意诸如“此方法会阻塞直到输入数据可用”和“至少读取并存储一个字节”的短语。 - ChssPly76

Answer 3

可自动关闭的资源管理

File file = new File("Foo.txt");
try (PrintStream ps = new PrintStream(file)) {
   ps.println("Bar");
}
response.setContentType("application/octet-stream");
response.setContentLength((int) file.length());
response.setHeader( "Content-Disposition",
         String.format("attachment; filename=\"%s\"", file.getName()));

OutputStream out = response.getOutputStream();
try (FileInputStream in = new FileInputStream(file)) {
    byte[] buffer = new byte[4096];
    int length;
    while ((length = in.read(buffer)) > 0) {
        out.write(buffer, 0, length);
    }
}
out.flush();

- Sorter

---

"out" 也必须在 try() 块中，因此需要加上 out.flush()。 - Simon Logic

当你需要下载一个大文件（例如超过5MB）时，这种方法非常有用。如果你不指定内容长度，客户端可能会关闭与你的服务器的TCP连接，然后你会得到一个SocketException：Connection reset by peer: socket write error。 - FelipeCaparelli

Answer 4

最简单的实现下载的方式是直接将用户引导到文件位置，浏览器会自动完成下载。

您可以通过以下方式轻松实现：

HttpServletResponse.sendRedirect()

- Winston Chen

Answer 5

发送大文件

byte[] pdfData = getPDFData();

String fileType = "";

res.setContentType("application/pdf");

httpRes.setContentType("application/.pdf");
httpRes.addHeader("Content-Disposition", "attachment; filename=IDCards.pdf");
httpRes.setStatus(HttpServletResponse.SC_OK);
OutputStream out = res.getOutputStream();
System.out.println(pdfData.length);
         
out.write(pdfData);
System.out.println("sendDone");
out.flush();

- user13916409