Apache HttpClient - 分段上传

使用HttpClient，我们可以进行分段上传，即可以将较大的对象分成较小的部分上传。在本章中，我们通过上传一个简单的文本文件来演示HTTP客户端中的分段上传。

一般来说，任何分段上传都包含三个部分。

  • 开始上传

  • 上传对象部分

  • 完成分段上传

对于使用 HttpClient 的分段上传，我们需要遵循以下步骤 -

  • 创建一个多部分构建器。

  • 添加所需的部件。

  • 完成构建并获得一个多部分的HttpEntity。

  • 通过设置上述多部分实体来构建请求。

  • 执行请求。

以下是使用 HttpClient 库上传多部分实体的步骤。

第 1 步 - 创建 HttpClient 对象

HttpClients类的createDefault ()方法返回CloseableHttpClient类的对象，该类是 HttpClient 接口的基本实现。使用此方法创建一个 HttpClient 对象 -

//Creating CloseableHttpClient object
CloseableHttpClient httpclient = HttpClients.createDefault();

第 2 步 - 创建 FileBody 对象

FileBody类表示文件支持的二进制正文部分。通过传递File对象和表示内容类型的ContentType对象来实例化此类。

//Creating a File object
File file = new File("sample.txt");

//Creating the FileBody object
FileBody filebody = new FileBody(file, ContentType.DEFAULT_BINARY);

第 3 步 - 创建 MultipartEntityBuilder

MultipartEntityBuilder类用于构建多部分HttpEntity对象。使用create()方法（同一类）创建其对象。

//Creating the MultipartEntityBuilder
MultipartEntityBuilder entitybuilder = MultipartEntityBuilder.create();

第 4 步 - 设置模式

MultipartEntityBuilder具有三种模式：STRICT 、 RFC6532 和 BROWSER_COMPATIBLE。使用setMode()方法将其设置为所需的模式。

//Setting the mode
entitybuilder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);

第 5 步 - 添加各种所需的部件

使用方法addTextBody()、 addPart() 和addBinaryBody()，您可以将简单的文本、文件、流和其他对象添加到 MultipartBuilder中。使用这些方法添加所需的内容。

//Adding text
entitybuilder.addTextBody("sample_text", "This is the text part of our file");
//Adding a file
entitybuilder.addBinaryBody("image", new File("logo.png"));

第 6 步 - 构建单一实体

您可以使用MultipartEntityBuilder类的build()方法将所有这些部分构建为单个实体。使用此方法，将所有部分构建到单个HttpEntity中。

//Building a single entity using the parts
HttpEntity mutiPartHttpEntity = entityBuilder.build();

第 7 步 - 创建 RequestBuilder 对象

RequestBuilder类用于通过向请求添加参数来构建请求。如果请求的类型为 PUT 或 POST，它将参数作为 URL 编码实体添加到请求中。

使用post()方法创建一个 RequestBuilder 对象（PO​​ST 类型）。并将您想要将请求发送到的 Uri 作为参数传递。

//Building the post request object
RequestBuilder reqbuilder = RequestBuilder.post("http://httpbin.org/post");

第 8 步 - 将实体对象设置为 RequestBuilder

使用RequestBuilder类的setEntity()方法将上面创建的多部分实体设置到 RequestBuilder 。

//Setting the entity object to the RequestBuilder
reqbuilder.setEntity(mutiPartHttpEntity);

第 9 步 - 构建 HttpUriRequest

使用RequestBuilder类的build()方法构建HttpUriRequest请求对象。

//Building the request
HttpUriRequest multipartRequest = reqbuilder.build();

第 10 步 - 执行请求

使用execute()方法，执行上一步中构建的请求（绕过该请求作为该方法的参数）。

//Executing the request
HttpResponse httpresponse = httpclient.execute(multipartRequest);

例子

以下示例演示如何使用 HttpClient 库发送多部分请求。在此示例中，我们尝试发送由文件支持的多部分请求。

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;

public class MultipartUploadExample {
 
   public static void main(String args[]) throws Exception{

      //Creating CloseableHttpClient object
      CloseableHttpClient httpclient = HttpClients.createDefault();
 
      //Creating a file object
      File file = new File("sample.txt");

      //Creating the FileBody object
      FileBody filebody = new FileBody(file, ContentType.DEFAULT_BINARY);

      //Creating the MultipartEntityBuilder
      MultipartEntityBuilder entitybuilder = MultipartEntityBuilder.create();

      //Setting the mode
      entitybuilder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);

      //Adding text
      entitybuilder.addTextBody("sample_text", "This is the text part of our file");

      //Adding a file
      entitybuilder.addBinaryBody("image", new File("logo.png"));

      //Building a single entity using the parts
      HttpEntity mutiPartHttpEntity = entitybuilder.build();

      //Building the RequestBuilder request object
      RequestBuilder reqbuilder = RequestBuilder.post("http://httpbin.org/post");

      //Set the entity object to the RequestBuilder
      reqbuilder.setEntity(mutiPartHttpEntity);

      //Building the request
      HttpUriRequest multipartRequest = reqbuilder.build();

      //Executing the request
      HttpResponse httpresponse = httpclient.execute(multipartRequest);

      //Printing the status and the contents of the response
      System.out.println(EntityUtils.toString(httpresponse.getEntity()));
      System.out.println(httpresponse.getStatusLine());
   }
}

输出

执行时，上述程序生成以下输出 -

{
   "args": {},
   "data": "",
   "files": {
      "image": "data:application/octets66PohrH3IWNk1FzpohfdXPIfv9X3490FGcuXsHn9X0piCwomF/xdgADZ9GsfSyvLYAAAAAE
      lFTkSuQmCC"
   },
   "form": {
      "sample_text": "This is the text part of our file"
   },
   "headers": {
      "Accept-Encoding": "gzip,deflate",
      "Connection": "close",
      "Content-Length": "11104", 
      "Content-Type": "multipart/form-data;
      boundary=UFJbPHT7mTwpVq70LpZgCi5I2nvxd1g-I8Rt",
      "Host": "httpbin.org",
      "User-Agent": "Apache-HttpClient/4.5.6 (Java/1.8.0_91)"
   },
   "json": null,
   "origin": "117.216.245.180",
   "url": "http://httpbin.org/post"
}
HTTP/1.1 200 OK