Servlet 文件上传

Servlet 可以与 HTML form 标签一起使用,来允许用户上传文件到服务器。上传的文件可以是文本文件或图像文件或任何文档。

本文使用到的文件有:

  • upload.jsp : 文件上传表单。
  • message.jsp : 上传成功后跳转页面。
  • UploadServlet.java : 上传处理 Servlet。
  • 需要引入的 jar 文件:commons-fileupload-1.3.2、commons-io-2.5.jar。

结构图如下所示:

Servlet 文件上传 - 图1

注意:Servlet3.0 已经内置了文件上传这一特性,开发者不再需要将 Commons FileUpload 组件导入到工程中去。

接下来我们详细介绍。

创建一个文件上传表单

下面的 HTML 代码创建了一个文件上传表单。以下几点需要注意:

  • 表单 method 属性应该设置为 POST 方法,不能使用 GET 方法。
  • 表单 enctype 属性应该设置为 multipart/form-data.
  • 表单 action 属性应该设置为在后端服务器上处理文件上传的 Servlet 文件。下面的实例使用了 UploadServlet Servlet 来上传文件。
  • 上传单个文件,您应该使用单个带有属性 type="file" 的 标签。为了允许多个文件上传,请包含多个 name 属性值不同的 input 标签。输入标签具有不同的名称属性的值。浏览器会为每个 input 标签关联一个浏览按钮。 upload.jsp 文件代码如下:
  1. <%@ page language="java" contentType="text/html; charset=UTF-8"
  2. pageEncoding="UTF-8"%>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  4. "http://www.w3.org/TR/html4/loose.dtd">
  5. <html>
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  8. <title>文件上传实例 - 菜鸟教程</title>
  9. </head>
  10. <body>
  11. <h1>文件上传实例 - 菜鸟教程</h1>
  12. <form method="post" action="/TomcatTest/UploadServlet" enctype="multipart/form-data">
  13. 选择一个文件:
  14. <input type="file" name="uploadFile" />
  15. <br/><br/>
  16. <input type="submit" value="上传" />
  17. </form>
  18. </body>
  19. </html>

编写后台 Servlet

以下是 UploadServlet 的源代码,同于处理文件上传,在这之前我们先确保依赖包已经引入到项目的 WEB-INF/lib 目录下:

  1. package com.servlet.test;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.io.PrintWriter;
  5. import java.util.List;
  6. import javax.servlet.ServletException;
  7. import javax.servlet.annotation.WebServlet;
  8. import javax.servlet.http.HttpServlet;
  9. import javax.servlet.http.HttpServletRequest;
  10. import javax.servlet.http.HttpServletResponse;
  11. import org.apache.commons.fileupload.FileItem;
  12. import org.apache.commons.fileupload.disk.DiskFileItemFactory;
  13. import org.apache.commons.fileupload.servlet.ServletFileUpload;
  14. /**
  15. * Servlet implementation class UploadServlet
  16. */
  17. @WebServlet("/UploadServlet")
  18. public class UploadServlet extends HttpServlet {
  19. private static final long serialVersionUID = 1L;
  20. // 上传文件存储目录
  21. private static final String UPLOAD_DIRECTORY = "upload";
  22. // 上传配置
  23. private static final int MEMORY_THRESHOLD = 1024 * 1024 * 3; // 3MB
  24. private static final int MAX_FILE_SIZE = 1024 * 1024 * 40; // 40MB
  25. private static final int MAX_REQUEST_SIZE = 1024 * 1024 * 50; // 50MB
  26. /**
  27. * 上传数据及保存文件
  28. */
  29. protected void doPost(HttpServletRequest request,
  30. HttpServletResponse response) throws ServletException, IOException {
  31. // 检测是否为多媒体上传
  32. if (!ServletFileUpload.isMultipartContent(request)) {
  33. // 如果不是则停止
  34. PrintWriter writer = response.getWriter();
  35. writer.println("Error: 表单必须包含 enctype=multipart/form-data");
  36. writer.flush();
  37. return;
  38. }
  39. // 配置上传参数
  40. DiskFileItemFactory factory = new DiskFileItemFactory();
  41. // 设置内存临界值 - 超过后将产生临时文件并存储于临时目录中
  42. factory.setSizeThreshold(MEMORY_THRESHOLD);
  43. // 设置临时存储目录
  44. factory.setRepository(new File(System.getProperty("java.io.tmpdir")));
  45. ServletFileUpload upload = new ServletFileUpload(factory);
  46. // 设置最大文件上传值
  47. upload.setFileSizeMax(MAX_FILE_SIZE);
  48. // 设置最大请求值 (包含文件和表单数据)
  49. upload.setSizeMax(MAX_REQUEST_SIZE);
  50. // 中文处理
  51. upload.setHeaderEncoding("UTF-8");
  52. // 构造临时路径来存储上传的文件
  53. // 这个路径相对当前应用的目录
  54. String uploadPath = request.getServletContext().getRealPath("./") + File.separator + UPLOAD_DIRECTORY;
  55. // 如果目录不存在则创建
  56. File uploadDir = new File(uploadPath);
  57. if (!uploadDir.exists()) {
  58. uploadDir.mkdir();
  59. }
  60. try {
  61. // 解析请求的内容提取文件数据
  62. @SuppressWarnings("unchecked")
  63. List<FileItem> formItems = upload.parseRequest(request);
  64. if (formItems != null && formItems.size() > 0) {
  65. // 迭代表单数据
  66. for (FileItem item : formItems) {
  67. // 处理不在表单中的字段
  68. if (!item.isFormField()) {
  69. String fileName = new File(item.getName()).getName();
  70. String filePath = uploadPath + File.separator + fileName;
  71. File storeFile = new File(filePath);
  72. // 在控制台输出文件的上传路径
  73. System.out.println(filePath);
  74. // 保存文件到硬盘
  75. item.write(storeFile);
  76. request.setAttribute("message",
  77. "文件上传成功!");
  78. }
  79. }
  80. }
  81. } catch (Exception ex) {
  82. request.setAttribute("message",
  83. "错误信息: " + ex.getMessage());
  84. }
  85. // 跳转到 message.jsp
  86. request.getServletContext().getRequestDispatcher("/message.jsp").forward(
  87. request, response);
  88. }
  89. }

message.jsp 文件代码如下:

  1. <%@ page language="java" contentType="text/html; charset=UTF-8"
  2. pageEncoding="UTF-8"%>
  3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  4. "http://www.w3.org/TR/html4/loose.dtd">
  5. <html>
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  8. <title>文件上传结果</title>
  9. </head>
  10. <body>
  11. <center>
  12. <h2>${message}</h2>
  13. </center>
  14. </body>
  15. </html>

编译和运行 Servlet

编译上面的 Servlet UploadServlet,并在 web.xml 文件中创建所需的条目,如下所示:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns="http://java.sun.com/xml/ns/javaee"
  4. xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  5. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  6. http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  7. id="WebApp_ID" version="2.5">
  8. <servlet>
  9. <display-name>UploadServlet</display-name>
  10. <servlet-name>UploadServlet</servlet-name>
  11. <servlet-class>com.runoob.test.UploadServlet</servlet-class>
  12. </servlet>
  13. <servlet-mapping>
  14. <servlet-name>UploadServlet</servlet-name>
  15. <url-pattern>/TomcatTest/UploadServlet</url-pattern>
  16. </servlet-mapping>
  17. </web-app>

现在尝试使用您在上面创建的 HTML 表单来上传文件。在浏览器中访问:http://localhost:8080/TomcatTest/upload.jsp

a 标签用法

对于一般的文件直接用 a 标签的话,如下代码所示。由于浏览器可以解析jpg和txt文件,故不会直接下载而是在其他网页打开:

  1. <a href="/IT/download/1.gif" rel="nofollow">下载图片</a>
  2. <a href="/IT/download/day10.doc" rel="nofollow">下载文档</a>
  3. <a href="/IT/download/day10.txt" rel="nofollow">下载笔记</a>

如果想要完成直接下载的目的,可以通过Servlet进行操作,做了一个简单的html页面

  1. <a href="/IT/download?name=1.gif" rel="nofollow">下载图片1</a>
  2. <a href="/IT/download?name=day10.doc" rel="nofollow">下载文档1</a>
  3. <a href="/IT/download?name=day10.txt" rel="nofollow">下载笔记1</a>

我为download注册了一个servlet,xml描写如下:

  1. <servlet>
  2. <servlet-name>DownloadServlet</servlet-name>
  3. <servlet-class>com.response.download.DownloadServlet</servlet-class>
  4. </servlet>
  5. <servlet-mapping>
  6. <servlet-name>DownloadServlet</servlet-name>
  7. <url-pattern>/download</url-pattern>
  8. </servlet-mapping>

由于我的请求方式是get方式,所以只需在DownloadServlet这个类中重写doGet方法,代码实现如下:

  1. public void doGet(HttpServletRequest request, HttpServletResponse response)
  2. throws ServletException, IOException {
  3. //获取文件名
  4. String filename=request.getParameter("name");
  5. //防止读取name名乱码
  6. filename=new String(filename.getBytes("iso-8859-1"),"utf-8");
  7. //在控制台打印文件名
  8. System.out.println("文件名:"+filename);
  9. //设置文件MIME类型
  10. response.setContentType(getServletContext().getMimeType(filename));
  11. //设置Content-Disposition
  12. response.setHeader("Content-Disposition", "attachment;filename="+filename);
  13. //获取要下载的文件绝对路径,我的文件都放到WebRoot/download目录下
  14. ServletContext context=this.getServletContext();
  15. String fullFileName=context.getRealPath("/download/"+filename);
  16. //输入流为项目文件,输出流指向浏览器
  17. InputStream is=new FileInputStream(fullFileName);
  18. ServletOutputStream os =response.getOutputStream();
  19. /*
  20. * 设置缓冲区
  21. * is.read(b)当文件读完时返回-1
  22. */
  23. int len=-1;
  24. byte[] b=new byte[1024];
  25. while((len=is.read(b))!=-1){
  26. os.write(b,0,len);
  27. }
  28. //关闭流
  29. is.close();
  30. os.close();
  31. }