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有三种模式:严格,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 分段上传的完整例子

以下示例演示如何使用 HttpClient 发送多部分请求。在这个例子中,我们试图发送一个由文件支持的多部分请求。

package com.yiidian;

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;

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("d:/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());
   }
} 

输出结果为:

一点教程,一个分享编程知识的公众号。跟着站长一起学习和进步。

通俗易懂,深入浅出,一篇文章只讲一个知识点。

在公交、在地铁、在厕所都可以阅读,随时随地涨姿势。

文章不涉及代码,不烧脑细胞,人人都可以学习。

当你决定关注「一点教程」,你已然超越了90%的程序员!

一点教程二维码