HttpClient使用管道流提交Multipart请求

HttpClient 是JDK11提供的一个全新HTTP客户端Api,超级好用。

Multipart 请求

HttpClient 并没有提供 Multipart 请求体的构建Api。但是可以使用apache的开源httpmime库来进行构建。

<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpmime -->
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpmime</artifactId>
    <version>4.5.13</version>
</dependency>

构建一个 MultipartBody

// 构建Multipart请求
HttpEntity httpEntity = MultipartEntityBuilder.create()
        // 表单数据
        .addPart("name", new StringBody(UriUtils.encode("SpringBoot中文社区", StandardCharsets.UTF_8), ContentType.APPLICATION_FORM_URLENCODED))
        // JSON数据
        .addPart("info", new StringBody("{\"site\": \"https://springboot.io\", \"now\": 2021}", ContentType.APPLICATION_JSON))
        // 文件数据
        .addBinaryBody("file", file, ContentType.APPLICATION_OCTET_STREAM, "eclipse-jee-2019-12-R-win32-x86_64.zip")
        .build();

ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream((int) httpEntity.getContentLength());

// 把body写入到内存
httpEntity.writeTo(byteArrayOutputStream);

Multipart 请求可以一次性post多个子body,通常用来上传本地磁盘上的文件。所以这种请求体可能会异常庞大。甚至内存不能完整的存入整个请求体。那么这个时候有2种办法可以解决。

  1. 先把构建好的Body数据写入到磁盘,再通过IO磁盘数据,提交给服务器
  2. 使用管道流,在读取磁盘数据进行body构建的时候,直接通过管道提交到远程服务器

管道流

管道流,顾名思义,可以往一边写,从另一边读。

// 创建读取流
PipedInputStream pipedInputStream = new PipedInputStream();
// 创建写入流
PipedOutputStream pipedOutputStream = new PipedOutputStream();
// 连接写入和读取流
pipedInputStream.connect(pipedOutputStream);

通过往pipedOutputStream写入数据,就可以在pipedInputStream 读取。

不能使用单线程既读又写,因为读写都是阻塞方法。任何一方阻塞住了了,另一方就会一直处于等待状态,导致死锁

完整Demo

客户端

package io.springcloud.test;

import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;

import org.apache.http.HttpEntity;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.StringBody;
import org.springframework.web.util.UriUtils;

public class MainTest {


    public static void main(String[] args) throws Exception {
        
        // 管道流
        PipedInputStream pipedInputStream = new PipedInputStream();
        PipedOutputStream pipedOutputStream = new PipedOutputStream();
        pipedInputStream.connect(pipedOutputStream);
        
        // 本地文件
        InputStream file =  Files.newInputStream(Paths.get("D:\\eclipse-jee-2019-12-R-win32-x86_64.zip"));
        
        // 构建Multipart请求
        HttpEntity httpEntity = MultipartEntityBuilder.create()
                // 表单数据
                .addPart("name", new StringBody(UriUtils.encode("SpringBoot中文社区", StandardCharsets.UTF_8), ContentType.APPLICATION_FORM_URLENCODED))
                // JSON数据
                .addPart("info", new StringBody("{\"site\": \"https://springboot.io\", \"now\": 2021}", ContentType.APPLICATION_JSON))
                // 文件数据
                .addBinaryBody("file", file, ContentType.APPLICATION_OCTET_STREAM, "eclipse-jee-2019-12-R-win32-x86_64.zip")
                .build();
        
        // 异步写入数据到管道流
        new Thread(() -> {
            try (file; pipedOutputStream){
                httpEntity.writeTo(pipedOutputStream);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }).start();
        
        HttpClient httpClient = HttpClient.newHttpClient();
        
        try (pipedInputStream){
            // 创建请求和请求体
            HttpRequest request = HttpRequest
                        .newBuilder(new URI("http://localhost/upload"))
                        // 设置ContentType
                        .header("Content-Type", httpEntity.getContentType().getValue())
                        .header("Accept", "text/plain")   
                        // 从管道流读取数据,提交给服务器
                        .POST(BodyPublishers.ofInputStream(() -> pipedInputStream))
                        .build();
            
            // 执行请求,获取响应
            HttpResponse<String> responseBody = httpClient.send(request, BodyHandlers.ofString(StandardCharsets.UTF_8));
            
            System.out.println(responseBody.body());
        }
    }
}

服务端

package io.springcloud.web.controller;

import java.nio.charset.StandardCharsets;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.util.UriUtils;

import com.google.gson.JsonObject;


@RestController
@RequestMapping("/upload")
public class UploadController {
    
    private static final Logger LOGGER = LoggerFactory.getLogger(UploadController.class);
    
    @PostMapping
    public Object upload (@RequestPart("file") MultipartFile file,
                        @RequestPart("info") JsonObject info,
                        @RequestPart("name") String name) {
        
        LOGGER.info("file: name={}, size={}", file.getOriginalFilename(), file.getSize());
        LOGGER.info("info: {}", info.toString());
        LOGGER.info("name: {}", UriUtils.decode(name, StandardCharsets.UTF_8));
        
        return ResponseEntity.ok("success");
    }
}

启动服务端后,执行客户端请求,服务端日志输出

2021-09-24 13:38:15.067  INFO 2660 --- [  XNIO-1 task-1] i.s.web.controller.UploadController      : file: name=eclipse-jee-2019-12-R-win32-x86_64.zip, size=369653147
2021-09-24 13:38:15.067  INFO 2660 --- [  XNIO-1 task-1] i.s.web.controller.UploadController      : info: {"site":"https://springboot.io","now":2021}
2021-09-24 13:38:15.067  INFO 2660 --- [  XNIO-1 task-1] i.s.web.controller.UploadController      : name: SpringBoot中文社区

首发:https://springboot.io/t/topic/4185

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容