原文： https://javatutorial.net/java-file-upload-rest-service

在本教程中，我将解释如何构建 Java REST Web 服务以通过 HTTP 从任何客户端上载文件。

将文件上传到 Web 应用程序是当今的一项常见任务。 许多服务都支持在其网站上上传图片或文档。 使用 Java Web 服务，这很容易实现。 除了 Java Web 容器（由 Tomcat，GlassFish 或 JBoss 等应用服务器提供）之外，我们还需要 Jersey 使它运行。 首先，我将向您展示如何实现 Web 服务，然后为您提供两个使用该服务的客户端示例。

Java 文件上传 REST 服务 - 图1

Java 文件上传表格

构建文件上传 REST 服务

该文件通过 HTTP POST 以编码类型multipart/form-data从客户端推送到我们的 Web 服务。 这样，除了文件之外，您还可以向 POST 请求添加多个参数。 让我们从需求开始。 您将需要 Web 应用程序服务器（例如 Tomcat，GlassFish 或 JBoss）来部署服务。 另外，我们将使用 jersey 框架来构建我们的服务端点。 请注意，GlassFish 4.x 版本需要 jersey 版本 2 库，因此如果使用 GlassFish 4，则请在您的 POM 文件中使用 jersey 2.x 依赖项。

为了快速参考，您可以在我们的 GitHub 存储库中的 https://github.com/JavaTutorialNetwork/Tutorials/tree/master/FileUploaderRESTService 下找到整个项目

我将在此处发布整个 POM 文件，但您需要考虑的是 Jersey 依赖项

  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>FileUploaderRESTService</artifactId>
  7.     <version>1</version>
  8.     <packaging>war</packaging>
  10.     <name>File Uploader Rest Service</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>com.sun.jersey</groupId>
  20.             <artifactId>jersey-server</artifactId>
  21.             <version>1.8</version>
  22.         </dependency>
  23.         <dependency>
  24.             <groupId>com.sun.jersey</groupId>
  25.             <artifactId>jersey-servlet</artifactId>
  26.             <version>1.17.1</version>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>com.sun.jersey</groupId>
  30.             <artifactId>jersey-json</artifactId>
  31.             <version>1.8</version>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>com.sun.jersey.contribs</groupId>
  35.             <artifactId>jersey-multipart</artifactId>
  36.             <version>1.8</version>
  37.         </dependency>
  38.     </dependencies>
  40.     <build>
  41.         <plugins>
  42.             <plugin>
  43.                 <groupId>org.apache.maven.plugins</groupId>
  44.                 <artifactId>maven-compiler-plugin</artifactId>
  45.                 <version>3.1</version>
  46.                 <inherited>true</inherited>
  47.                 <configuration>
  48.                     <source>1.7</source>
  49.                     <target>1.7</target>
  50.                 </configuration>
  51.             </plugin>
  52.             <plugin>
  53.                 <artifactId>maven-war-plugin</artifactId>
  54.                 <version>2.3</version>
  55.                 <configuration>
  56.                     <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
  57.                     <webResources>
  58.                         <resource>
  59.                             <!-- this is relative to the pom.xml directory -->
  60.                             <directory>${project.basedir}/src/main/resources
  61.                             </directory>
  62.                         </resource>
  63.                     </webResources>
  64.                 </configuration>
  65.             </plugin>
  66.         </plugins>
  67.     </build>
  69. </project>

现在拥有所有必需的库，让我们继续实现 REST 服务。 下面的代码中有几个地方我想提醒您注意。 首先请注意@Consumes(MediaType.MULTIPART_FORM_DATA)作为请求的编码类型的用法。 其次，如果愿意，您可能希望向该方法添加其他参数。 例如，您可能要在上传时传递一些描述或其他文本数据。 最后，如果您尝试将文件上传到不存在的目录中，Java 将抛出异常。 为了避免这个问题，我创建了方法createFolderIfNotExists(StringdirName)。

  1. package net.javatutorial.tutorials.services;
  3. import java.io.File;
  4. import java.io.FileOutputStream;
  5. import java.io.IOException;
  6. import java.io.InputStream;
  7. import java.io.OutputStream;
  9. import javax.ws.rs.Consumes;
  10. import javax.ws.rs.POST;
  11. import javax.ws.rs.Path;
  12. import javax.ws.rs.core.Context;
  13. import javax.ws.rs.core.MediaType;
  14. import javax.ws.rs.core.Response;
  15. import javax.ws.rs.core.UriInfo;
  17. import com.sun.jersey.core.header.FormDataContentDisposition;
  18. import com.sun.jersey.multipart.FormDataParam;
  20. /**
  21.  * This example shows how to build Java REST web-service to upload files
  22.  * accepting POST requests with encoding type "multipart/form-data". For more
  23.  * details please read the full tutorial on
  24.  * https://javatutorial.net/java-file-upload-rest-service
  25.  * 
  26.  * @author javatutorial.net
  27.  */
  28. @Path("/upload")
  29. public class FileUploadService {
  31.     /** The path to the folder where we want to store the uploaded files */
  32.     private static final String UPLOAD_FOLDER = "c:/uploadedFiles/";
  34.     public FileUploadService() {
  35.     }
  37.     @Context
  38.     private UriInfo context;
  40.     /**
  41.      * Returns text response to caller containing uploaded file location
  42.      * 
  43.      * @return error response in case of missing parameters an internal
  44.      *         exception or success response if file has been stored
  45.      *         successfully
  46.      */
  47.     @POST
  48.     @Consumes(MediaType.MULTIPART_FORM_DATA)
  49.     public Response uploadFile(
  50.             @FormDataParam("file") InputStream uploadedInputStream,
  51.             @FormDataParam("file") FormDataContentDisposition fileDetail) {
  53.         // check if all form parameters are provided
  54.         if (uploadedInputStream == null || fileDetail == null)
  55.             return Response.status(400).entity("Invalid form data").build();
  57.         // create our destination folder, if it not exists
  58.         try {
  59.             createFolderIfNotExists(UPLOAD_FOLDER);
  60.         } catch (SecurityException se) {
  61.             return Response.status(500)
  62.                     .entity("Can not create destination folder on server")
  63.                     .build();
  64.         }
  66.         String uploadedFileLocation = UPLOAD_FOLDER + fileDetail.getFileName();
  67.         try {
  68.             saveToFile(uploadedInputStream, uploadedFileLocation);
  69.         } catch (IOException e) {
  70.             return Response.status(500).entity("Can not save file").build();
  71.         }
  73.         return Response.status(200)
  74.                 .entity("File saved to " + uploadedFileLocation).build();
  75.     }
  77.     /**
  78.      * Utility method to save InputStream data to target location/file
  79.      * 
  80.      * @param inStream
  81.      *            - InputStream to be saved
  82.      * @param target
  83.      *            - full path to destination file
  84.      */
  85.     private void saveToFile(InputStream inStream, String target)
  86.             throws IOException {
  87.         OutputStream out = null;
  88.         int read = 0;
  89.         byte[] bytes = new byte[1024];
  91.         out = new FileOutputStream(new File(target));
  92.         while ((read = inStream.read(bytes)) != -1) {
  93.             out.write(bytes, 0, read);
  94.         }
  95.         out.flush();
  96.         out.close();
  97.     }
  99.     /**
  100.      * Creates a folder to desired location if it not already exists
  101.      * 
  102.      * @param dirName
  103.      *            - full path to the folder
  104.      * @throws SecurityException
  105.      *             - in case you don't have permission to create the folder
  106.      */
  107.     private void createFolderIfNotExists(String dirName)
  108.             throws SecurityException {
  109.         File theDir = new File(dirName);
  110.         if (!theDir.exists()) {
  111.             theDir.mkdir();
  112.         }
  113.     }
  115. }

最后，我们需要配置web.xml以将我们的类注册为 Web 服务并使其在启动时运行。

  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" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  4.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  5.     id="WebApp_ID" version="2.5">
  6.     <display-name>net.javatutorial.tutorials.services</display-name>
  7.     <servlet>
  8.         <servlet-name>Jersey REST Service</servlet-name>
  9.         <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
  10.         <init-param>
  11.             <param-name>com.sun.jersey.config.property.packages</param-name>
  12.             <param-value>net.javatutorial.tutorials.services</param-value>
  13.         </init-param>
  14.         <load-on-startup>1</load-on-startup>
  15.     </servlet>
  16.     <servlet-mapping>
  17.         <servlet-name>Jersey REST Service</servlet-name>
  18.         <url-pattern>/rest/*</url-pattern>
  19.     </servlet-mapping>
  20. </web-app>

好的！ 现在，您可以构建和部署 WAR 文件。 如果您使用上面代码中提供的完全相同的名称，则您的服务 URL（假设您在localhost上运行）将是：http://localhost:8080/FileUploaderRESTService-1/rest/upload

文件上传 HTML 表格

您可以使用非常简单的 HTML post 表单作为客户端将文件发送到服务器。

请注意multipart/form-data作为编码类型的用法。 您还需要添加文件类型为[file]的输入

  1. Choose file to upload<br>
  2. <form action="http://localhost:8080/FileUploaderRESTService-1/rest/upload" method="post" enctype="multipart/form-data">
  3.     <input name="file" id="filename" type="file" /><br><br>
  4.     <button name="submit" type="submit">Upload</button>
  5. </form>

如前所述，您可以向请求中添加其他数据。 在这种情况下，别忘了在网络服务中处理它🙂

Java 文件上传客户端

您可以为 Android 或 Java 中的独立程序创建文件上传客户端。 在下面的示例中，我将使用 Apache http 库，您将需要以下五个：

  • commonlog
  • httpclient
  • httpclient cache
  • httpcore
  • httpmime
  1. package net.javatutorial.tutorials.clienst;
  3. import java.io.File;
  4. import java.io.FileInputStream;
  5. import java.io.IOException;
  7. import org.apache.http.HttpEntity;
  8. import org.apache.http.HttpResponse;
  9. import org.apache.http.client.ClientProtocolException;
  10. import org.apache.http.client.methods.HttpPost;
  11. import org.apache.http.entity.mime.MultipartEntity;
  12. import org.apache.http.entity.mime.content.InputStreamBody;
  13. import org.apache.http.impl.client.DefaultHttpClient;
  14. import org.apache.http.params.BasicHttpParams;
  15. import org.apache.http.util.EntityUtils;
  17. /**
  18.  * This example shows how to upload files using POST requests 
  19.  * with encoding type "multipart/form-data".
  20.  * For more details please read the full tutorial
  21.  * on https://javatutorial.net/java-file-upload-rest-service
  22.  * @author javatutorial.net
  23.  */
  24. public class FileUploaderClient {
  26.     public static void main(String[] args) {
  28.         // the file we want to upload
  29.         File inFile = new File("C:\\Users\\admin\\Desktop\\Yana-make-up.jpg");
  30.         FileInputStream fis = null;
  31.         try {
  32.             fis = new FileInputStream(inFile);
  33.             DefaultHttpClient httpclient = new DefaultHttpClient(new BasicHttpParams());
  35.             // server back-end URL
  36.             HttpPost httppost = new HttpPost("http://localhost:8080/FileUploaderRESTService-1/rest/upload");
  37.             MultipartEntity entity = new MultipartEntity();
  39.             // set the file input stream and file name as arguments
  40.             entity.addPart("file", new InputStreamBody(fis, inFile.getName()));
  41.             httppost.setEntity(entity);
  43.             // execute the request
  44.             HttpResponse response = httpclient.execute(httppost);
  46.             int statusCode = response.getStatusLine().getStatusCode();
  47.             HttpEntity responseEntity = response.getEntity();
  48.             String responseString = EntityUtils.toString(responseEntity, "UTF-8");
  50.             System.out.println("[" + statusCode + "] " + responseString);
  52.         } catch (ClientProtocolException e) {
  53.             System.err.println("Unable to make connection");
  54.             e.printStackTrace();
  55.         } catch (IOException e) {
  56.             System.err.println("Unable to read file");
  57.             e.printStackTrace();
  58.         } finally {
  59.             try {
  60.                 if (fis != null) fis.close();
  61.             } catch (IOException e) {}
  62.         }
  63.     }
  65. }

您将在我们的 GitHub 存储库中找到项目文件 https://github.com/JavaTutorialNetwork/Tutorials/tree/master/FileUploaderJavaClient

谢谢阅读。 一如既往欢迎评论🙂