原文: http://zetcode.com/articles/javaservletuploadfile/

Java Servlet 上传文件显示了如何使用 Servlet 技术在 Java Web 应用中上传单个文件。

Java Servlet

Servlet 是 Java 类,可响应特定类型的网络请求-最常见的是 HTTP 请求。 Java servlet 用于创建 Web 应用。 它们在 servlet 容器(例如 Tomcat 或 Jetty)中运行。 现代 Java Web 开发使用在 servlet 之上构建的框架。

HTML 表单编码类型

POST 请求有三种编码 HTML 表单方法:

  • application/x-www-form-urlencoded
  • multipart/form-data
  • text/plain

application/x-www-form-urlencoded是默认编码。 这些值编码在由&分隔的键值元组中。 =字符用于键和值之间。 非字母数字字符采用百分比编码。 此编码类型不适用于二进制文件。

multipart/form-data用于非 acsii 数据和二进制文件。 input元素的type属性设置为file

text/plain用于调试。

Java Servlet 上传文件示例

在以下应用中,我们有一个 Web 表单来选择要上传到服务器的文件。 该表单调用 Java servlet,该 servlet 读取文件并将其保存到目录中。

上传目录

/var/www目录是 Debian Linux 中 Web 内容的标准目录。

  1. $ ls -ld /var/www/upload/
  2. drwxrwxr-x 2 www-data www-data 4096 Dec 3 14:29 /var/www/upload/

我们将文件上传到/var/www/upload目录。 www-data组中的用户可以修改目录文件。 因此,运行 Web 服务器的用户必须在此组中。

应用

这是一个 Maven Web 应用。 它部署在 Tomcat 上。

  1. $ tree
  2. .
  3. ├── nb-configuration.xml
  4. ├── pom.xml
  5. └── src
  6. └── main
  7. ├── java
  8. └── com
  9. └── zetcode
  10. └── FileUploadServlet.java
  11. └── webapp
  12. ├── index.html
  13. └── META-INF
  14. └── context.xml

这是项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5. http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6. <modelVersion>4.0.0</modelVersion>
  7. <groupId>com.zetcode</groupId>
  8. <artifactId>JavaServletFileUploadEx</artifactId>
  9. <version>1.0-SNAPSHOT</version>
  10. <packaging>war</packaging>
  11. <name>JavaServletFileUploadEx</name>
  12. <properties>
  13. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  14. <maven.compiler.source>1.8</maven.compiler.source>
  15. <maven.compiler.target>1.8</maven.compiler.target>
  16. </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>
  25. <build>
  26. <plugins>
  27. <plugin>
  28. <groupId>org.apache.maven.plugins</groupId>
  29. <artifactId>maven-war-plugin</artifactId>
  30. <version>2.3</version>
  31. <configuration>
  32. <failOnMissingWebXml>false</failOnMissingWebXml>
  33. </configuration>
  34. </plugin>
  35. </plugins>
  36. </build>
  37. </project>

这是 Maven POM 文件。 javax.servlet-api工件用于 servlet。 maven-war-plugin负责收集 Web 应用的所有工件依赖项,类和资源,并将它们打包到 Web 应用存档(WAR)中。

context.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Context path="/JavaServletFileUploadEx"/>

在 Tomcat context.xml文件中,我们定义了上下文路径。 它是 Web 应用的名称。

FileUploadServlet.java

  1. package com.zetcode;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.nio.file.Files;
  5. import java.nio.file.Paths;
  6. import java.nio.file.StandardCopyOption;
  7. import javax.servlet.ServletConfig;
  8. import javax.servlet.ServletException;
  9. import javax.servlet.ServletOutputStream;
  10. import javax.servlet.annotation.MultipartConfig;
  11. import javax.servlet.annotation.WebInitParam;
  12. import javax.servlet.annotation.WebServlet;
  13. import javax.servlet.http.HttpServlet;
  14. import javax.servlet.http.HttpServletRequest;
  15. import javax.servlet.http.HttpServletResponse;
  16. import javax.servlet.http.Part;
  17. @WebServlet(name = "FileUploadServlet", urlPatterns = {"/FileUploadServlet"},
  18. initParams = { @WebInitParam(name = "path", value = "/var/www/upload/") })
  19. @MultipartConfig
  20. public class FileUploadServlet extends HttpServlet {
  21. @Override
  22. protected void doPost(HttpServletRequest request, HttpServletResponse response)
  23. throws IOException, ServletException {
  24. response.setContentType("text/plain;charset=UTF-8");
  25. ServletOutputStream os = response.getOutputStream();
  26. ServletConfig sc = getServletConfig();
  27. String path = sc.getInitParameter("uploadpath");
  28. Part filePart = request.getPart("myfile");
  29. String fileName = filePart.getSubmittedFileName();
  30. InputStream is = filePart.getInputStream();
  31. Files.copy(is, Paths.get(path + fileName),
  32. StandardCopyOption.REPLACE_EXISTING);
  33. os.print("File successfully uploaded");
  34. }
  35. }

FileUploadServlet将文件上传到/var/www/upload目录。

  1. @WebServlet(name = "FileUploadServlet", urlPatterns = {"/FileUploadServlet"},
  2. initParams = { @WebInitParam(name = "uploadpath", value = "/var/www/upload/") })

使用@WebServlet批注,我们将 servlet 映射到/FileUploadServlet URL 模式,并定义了初始的uploadpath变量。

  1. @MultipartConfig

servlet 也用@MultipartConfig装饰。 @MultipartConfig批注指示 servlet 期望使用multipart/form-data MIME 类型进行请求。

  1. @Override
  2. protected void doPost(HttpServletRequest request, HttpServletResponse response)
  3. throws IOException, ServletException {

POST 请求由doPost()方法处理。

  1. ServletOutputStream os = response.getOutputStream();

我们使用getOutputStream()方法获得 servlet 输出流。

  1. ServletConfig sc = getServletConfig();
  2. String path = sc.getInitParameter("uploadpath");

我们检索初始参数。 这是我们要上传文件的目录。

  1. Part filePart = request.getPart("myfile");

使用getPart()方法检索文件部分。

  1. String fileName = filePart.getSubmittedFileName();
  2. InputStream is = filePart.getInputStream();

我们得到零件的文件名和输入流。

  1. Files.copy(is, Paths.get(path + fileName),
  2. StandardCopyOption.REPLACE_EXISTING);

使用Files.copy(),将文件复制到目标目录。

  1. os.print("File successfully uploaded");

最后,我们将消息写回客户端。

index.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Uploading a file</title>
  5. <meta charset="UTF-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
  8. </head>
  9. <body>
  10. <form class="pure-form pure-form-stacked" method="post" action="FileUploadServlet"
  11. enctype="multipart/form-data">
  12. <fieldset>
  13. <legend>File:</legend>
  14. <input type="file" name="myfile">
  15. <button type="submit" class="pure-button pure-button-primary">Upload</button>
  16. </fieldset>
  17. </form>
  18. </body>
  19. </html>

这是选择要上传文件的主页。 它包含一个 HTML 表单。 提交表单后,处理将发送到FileUploadServlet

  1. <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">

我们包括 Pure.css 库,用于创建负责任的页面。

  1. <form class="pure-form pure-form-stacked" method="post" action="FileUploadServlet"
  2. enctype="multipart/form-data">

method属性为 post,因为我们将数据发送到服务器。 action属性指定处理请求的 servlet 的名称。 enctype属性指定multipart/form-data编码类型,这是使用 HTML 格式上传文件所必需的。

  1. <input type="file" name="myfile">

input标签的type属性使用户可以选择一个文件。

  1. <button type="submit" class="pure-button pure-button-primary">Upload</button>

这是提交按钮。

在本教程中,我们展示了如何使用 Java Servlet 上传单个文件。

您可能也对以下相关教程感兴趣: Java Servlet 分页Java Log4j 教程Java Servlet RESTful 客户端Java RequestDispatcher从 Java servletJava servlet 图像教程Java 教程提供纯文本