本示例演示如何使用 Java Servlet 上传文件

始终可以将文件上传到 Java EE Servlet，但是要完成该工作需要付出很大的努力。 Apache Foundation 甚至构建了一个称为 Commons FileUpload 的库，以使此任务更易于实现。 尽管如此，Servlet 3.0 规范弥补了这一差距，并且自 Java EE 6 起，多部分配置选项已添加到 Servlet 中，从而在HttpServletRequest中引入了getPart和getParts方法。

如果您有兴趣使用 WebServices 将文件上传到服务器，则可以查看本教程。

Servlet 文件上传示例

Servlet 文件上载示例演示了MultipartConfig注解的用法，并使用户能够上载一个或两个文件。

该示例项目的结构非常简单。 它由一个 servlet 文件FileUploadServlet.java，pom.xml和可选的web.xml组成，这些文件用于在构建时处理依赖项。 正如我们在 Servlet 注释示例中讨论的那样，您可以在注释和部署描述符之间进行选择，以设置 Servlet 配置。 本示例使用注释。

下图显示了项目结构

Java Servlet 文件上传 - 图1

Servlet 文件上传项目结构

在 Maven 的pom.xml文件中，我们需要声明的唯一依赖项是javax.servlet

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>net.javatutorial.tutorials</groupId>
  6.     <artifactId>ServletFileUpload</artifactId>
  7.     <version>1</version>
  8.     <packaging>war</packaging>
  10.     <name>ServletFileUpload</name>
  11.     <url>https://javatutorial.net</url>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.     </properties>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>javax.servlet</groupId>
  20.             <artifactId>javax.servlet-api</artifactId>
  21.             <version>3.1.0</version>
  22.             <scope>provided</scope>
  23.         </dependency>
  24.     </dependencies>
  26.     <build>
  27.         <finalName>fileuploader</finalName>
  28.         <sourceDirectory>src/main/java</sourceDirectory>
  30.         <plugins>
  31.             <plugin>
  32.                 <groupId>org.apache.maven.plugins</groupId>
  33.                 <artifactId>maven-war-plugin</artifactId>
  34.                 <version>2.3</version>
  35.                 <configuration>
  36.                     <warSourceDirectory>src/main/webapp</warSourceDirectory>
  37.                 </configuration>
  38.             </plugin>
  39.             <plugin>
  40.                 <groupId>org.apache.maven.plugins</groupId>
  41.                 <artifactId>maven-compiler-plugin</artifactId>
  42.                 <version>3.1</version>
  43.                 <configuration>
  44.                     <source>1.8</source>
  45.                     <target>1.8</target>
  46.                 </configuration>
  47.             </plugin>
  48.         </plugins>
  49.     </build>
  50. </project>

文件上传 servlet 是我们项目的核心。 它只有两种方法 - goGet（显示上载表格）和doPost（完成整个上载工作）。

  1. package net.javatutorial.tutorials;
  3. import java.io.File;
  4. import java.io.IOException;
  5. import java.io.PrintWriter;
  7. import javax.servlet.ServletException;
  8. import javax.servlet.annotation.MultipartConfig;
  9. import javax.servlet.annotation.WebServlet;
  10. import javax.servlet.http.HttpServlet;
  11. import javax.servlet.http.HttpServletRequest;
  12. import javax.servlet.http.HttpServletResponse;
  13. import javax.servlet.http.Part;
  15. @WebServlet(name = "uploadServlet", urlPatterns = { "/upload" }, loadOnStartup = 1)
  16. @MultipartConfig(fileSizeThreshold = 6291456, // 6 MB
  17.         maxFileSize = 10485760L, // 10 MB
  18.         maxRequestSize = 20971520L // 20 MB
  19. )
  20. public class FileUploadServlet extends HttpServlet {
  22.     private static final long serialVersionUID = 5619951677845873534L;
  24.     private static final String UPLOAD_DIR = "uploads";
  26.     @Override
  27.     protected void doGet(HttpServletRequest request, HttpServletResponse response)
  28.             throws ServletException, IOException {
  29.         response.setContentType("text/html");
  30.         response.setCharacterEncoding("UTF-8");
  32.         PrintWriter writer = response.getWriter();
  33.         writer.append("<!DOCTYPE html>\r\n")
  34.         .append("<html>\r\n")
  35.         .append("    <head>\r\n")
  36.         .append("        <title>File Upload Form</title>\r\n")
  37.         .append("    </head>\r\n")
  38.         .append("    <body>\r\n");
  40.         writer.append("<h1>Upload file</h1>\r\n");
  41.         writer.append("<form method=\"POST\" action=\"upload\" ")
  42.         .append("enctype=\"multipart/form-data\">\r\n");
  43.         writer.append("<input type=\"file\" name=\"fileName1\"/><br/><br/>\r\n");
  44.         writer.append("<input type=\"file\" name=\"fileName2\"/><br/><br/>\r\n");
  45.         writer.append("<input type=\"submit\" value=\"Submit\"/>\r\n");
  46.         writer.append("</form>\r\n");
  48.         writer.append("    </body>\r\n").append("</html>\r\n");
  49.     }
  51.     @Override
  52.     protected void doPost(HttpServletRequest request, HttpServletResponse response)
  53.             throws ServletException, IOException {
  55.         response.setContentType("text/html");
  56.         response.setCharacterEncoding("UTF-8");
  58.         // gets absolute path of the web application
  59.         String applicationPath = request.getServletContext().getRealPath("");
  60.         // constructs path of the directory to save uploaded file
  61.         String uploadFilePath = applicationPath + File.separator + UPLOAD_DIR;
  63.         // creates upload folder if it does not exists
  64.         File uploadFolder = new File(uploadFilePath);
  65.         if (!uploadFolder.exists()) {
  66.             uploadFolder.mkdirs();
  67.         }
  69.         PrintWriter writer = response.getWriter();
  71.         // write all files in upload folder
  72.         for (Part part : request.getParts()) {
  73.             if (part != null && part.getSize() > 0) {
  74.                 String fileName = part.getSubmittedFileName();
  75.                 String contentType = part.getContentType();
  77.                 // allows only JPEG files to be uploaded
  78.                 if (!contentType.equalsIgnoreCase("image/jpeg")) {
  79.                     continue;
  80.                 }
  82.                 part.write(uploadFilePath + File.separator + fileName);
  84.                 writer.append("File successfully uploaded to " 
  85.                         + uploadFolder.getAbsolutePath() 
  86.                         + File.separator
  87.                         + fileName
  88.                         + "<br>\r\n");
  89.             }
  90.         }
  92.     }
  94. }

@MultipatrtConfig注解使 Servlet 可以接受文件上传。 有 3 个重要属性：

  • fileSizeThreshold – 在将文件写入temp目录之前要超出的文件大小。 如果文件小于此阈值，则文件将在请求完成之前驻留在内存中。
  • maxFileSize – 这是允许上传的文件的最大大小。 在上面的示例中，不允许用户上传大于 10 MB 的文件
  • maxRequestSize – 是我们尝试通过一个请求上传的所有文件的大小的总和。 在上面的示例中，我们将该值设置为 20 MB，这意味着无论文件数量多少，我们总共可以上传 20MB

您可能要指定或不指定第四个属性。 它称为location，它指向 Web 容器应存储临时文件的目录。 但是，如果您未指定此属性，则容器将使用默认的temp文件夹。

我们重写doGet方法以显示具有两个文件选择器字段的简单形式。 您可能需要添加其他输入字段，因为多部分附件允许这样做。

Java Servlet 文件上传 - 图2

表格上传文件

在doPost方法中，我们首先构造要存储上载文件的文件夹的路径。 比我们使用request.getParts()遍历用户选择上传的文件，最后将它们存储到所需位置。

构建并部署后，您可以在以下浏览器中访问应用程序：http://localhost:8080/fileuploader/upload

您可以在我们的 GitHub 存储库的中找到该项目。