整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线:

HttpClient使用指南-POST请求

能会用到的相关包

import java.io.File;
import java.nio.charset.Charset;
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.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;

使用HttpClient发送一个表单POST请求

try {
	CloseableHttpClient client = HttpClients.createDefault();
	List<NameValuePair> paras = new ArrayList<NameValuePair>();
	paras.add(new BasicNameValuePair("testIn1", "表单1"));
	paras.add(new BasicNameValuePair("testIn2", "true"));
	paras.add(new BasicNameValuePair("testIn3", "3"));
	paras.add(new BasicNameValuePair("testIn4", "20210929010101"));
	paras.add(new BasicNameValuePair("testIn5", "5.1"));
	HttpUriRequest post = RequestBuilder.post("http://localhost:9092/test.jsp")//
			.setEntity(new UrlEncodedFormEntity(paras, "GBK"))//
			.build();
	HttpResponse res = client.execute(post);
	System.out.println(res.getEntity().getContentType().toString());
	System.out.println(EntityUtils.toString(res.getEntity()));
} catch (Exception e) {
	e.printStackTrace();
}
  1. 创建一个请求客户端:HttpClients.createDefault(),用来实际发起调用post请求,可以类比成浏览器。
  2. 组装表单请求数据:通过ArrayList容器组装NameValuePair类型的请求数据,一个NameValuePair对象里存的是一个键值对。
  3. 创建一个post请求:通过请求构造器RequestBuilderpost方法构造一个post请求,通过setEntity方法向post请求里放置请求参数,请求参数需要通过UrlEncodedFormEntity对象包装,并指定编码字符集(这里是指对方编码,通过addHeader方法向post请求里追加请求头信息,请求头信息比如双方约定的token,通过build方法返回请求对象。
  4. 发起post请求并获得响应:通过请求客户端的execute方法执行请求并获得返回值请求响应。
  5. 获取响应结果:获取响应对象的实体HttpEntity,通过EntityUtils的toString方法将实体转成字符串(例子里为请求的一个jsp(html)页面,实际返回为jsp页面里html内容),这里一般还要指定字符集,尤其是当实体里没有指定字符集时

使用HttpClient发送一个JSON数据格式的POST请求

try {
	CloseableHttpClient client = HttpClients.createDefault();
	JSONObject json = new JSONObject();
	json.put("str", "字符串");
	json.put("num", 123);
	json.put("bool", true);
	json.put("date", Calendar.getInstance().getTime());//日期类型的一般会约定会特定格式的字符串,这里仅是示例
	json.put("ja", new JSONArray());
	HttpUriRequest post = RequestBuilder.post("http://localhost:8181/auri")//
			.setEntity(new StringEntity(json.toString(), ContentType.APPLICATION_JSON))//json的content-type已经包含utf-8的编码了
			.build();            
	System.out.println(post.toString());
	HttpResponse res = client.execute(post);
	System.out.println("statusLine:" + res.getStatusLine().getStatusCode());
	System.out.println(res.getEntity().getContentType().toString());
	System.out.println(EntityUtils.toString(res.getEntity()));
} catch (Exception e) {
	e.printStackTrace();
}
  1. 创建一个请求客户端:HttpClients.createDefault(),用来实际发起调用post请求,可以类比成浏览器。
  2. 组装Json请求数据:通过JSONObject对象组装数据。
  3. 创建一个post请求:通过请求构造器RequestBuilder的post方法构造一个post请求,通过setEntity方法向post请求里放置请求实体,请求实体需要通过StringEntity对象包装,并指定content-type为json,通过build方法返回请求对象。
  4. 发起http请求并获得响应:通过请求客户端的execute方法执行请求并获得返回值请求响应。
  5. 获取响应结果:获取响应对象的实体HttpEntity,通过EntityUtils的toString方法将实体转成字符串,这里一般还要指定字符集,尤其是当返回的实体里没有指定字符集时。

使用HttpClient发送一个包含附件上传的POST请求

try {
	CloseableHttpClient client = HttpClients.createDefault();            
	MultipartEntityBuilder meb = MultipartEntityBuilder.create();
	meb.setMode(HttpMultipartMode.RFC6532);//must
	meb.addBinaryBody("file1", new File("D:/abc.jpg"));
	meb.addBinaryBody("file2", new File("D:/你好.jpg"));
	meb.addTextBody("testIn1", "上传表单1", ContentType.DEFAULT_TEXT.withCharset("GBK"));//GBK or UTF-8, either is ok
	meb.addTextBody("testIn2", "true");
	meb.addTextBody("aid", "3");
	meb.setCharset(Charset.forName("UTF-8"));//must

	HttpUriRequest multiPost = RequestBuilder.post("http://localhost:9092/web/test")//
			.setEntity(meb.build())//
			.build();     
	HttpResponse res = client.execute(multiPost);
	System.out.println("statusLine:" + res.getStatusLine().getStatusCode());
	System.out.println(EntityUtils.toString(res.getEntity()));
} catch (Exception e) {
	e.printStackTrace();
}

1.创建一个请求客户端:HttpClients.createDefault(),用来实际发起调用post请求,可以类比成浏览器。

2.组装表单请求数据:因需要传递文件,所以通过MultipartEntityBuilder构造器组装表单实体请求数据。

2.1 设置mode为HttpMultipartMode.RFC6532(必须);

2.2 设置字符集为UTF-8(必须);

2.3 通过addBinaryBody追加文件;

2.4 通过addTextBody追加文本参数,若文本为中文则必须指定字符集为GBK或者UTF-8。

3.创建一个post请求:通过请求构造器RequestBuilder的post方法构造一个post请求,通过setEntity方法向post请求里放置请求参数,通过addHeader方法向post请求里追加请求头信息,请求头信息比如双方约定的token,通过build方法返回请求对象。

4.发起post请求并获得响应:通过请求客户端的execute方法执行请求并获得返回值请求响应。

5.获取响应结果:获取响应对象的实体HttpEntity,通过EntityUtilstoString方法将实体转成字符串,这里一般还要指定字符集,尤其是当实体里没有指定字符集时。

注意MultipartEntityBuilder必须指定modeHttpMultipartMode.RFC6532,且必须设置字符集为UTF-8否则若传递的文件名包含中文,则文件名乱码;对于普通的文本参数,中文指定UTF-8或者GBK接收方均未发现乱码情况;接收方需要将请求转为MultipartHttpServetRequest方可获取到文件,示例代码如下:

public ModelAndView enterTest(HttpServletRequest req, HttpServletResponse res, DataObject para) throws Exception {
	System.out.println(req.getContentType());
	MultipartHttpServletRequest mr = (MultipartHttpServletRequest) req;
	MultipartFile mf = mr.getFile("file2");
	System.out.println("getOriginalFilename:" + mf.getOriginalFilename());
	System.out.println("getName:" + mf.getName());
	......
}

若感觉对您有用,可以转发并关注,您的关注是对我莫大的支持!

介:

HTTP/1.1 协议规定的 HTTP 请求方法有 OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT 这几种。其中 POST 一般用来向服务端提交数据,本文主要讨论 POST 提交数据的几种方式。

我们知道,HTTP 协议是以 ASCII 码传输,建立在 TCP/IP 协议之上的应用层规范。规范把 HTTP 请求分为三个部分:状态行、请求头、消息主体。类似于下面这样:

<method> <request-URL> <version><headers><entity-body>

协议规定 POST 提交的数据必须放在消息主体(entity-body)中,但协议并没有规定数据必须使用什么编码方式。实际上,开发者完全可以自己决定消息主体的格式,只要最后发送的 HTTP 请求满足上面的格式就可以。

但是,数据发送出去,还要服务端解析成功才有意义。一般服务端语言如 php、python 等,以及它们的 framework,都内置了自动解析常见数据格式的功能。服务端通常是根据请求头(headers)中的 Content-Type 字段来获知请求中的消息主体是用何种方式编码,再对主体进行解析。所以说到 POST 提交数据方案,包含了 Content-Type 和消息主体编码方式两部分。下面就正式开始介绍它们。

application/x-www-form-urlencoded

这应该是最常见的 POST 提交数据的方式了。浏览器的原生 <form> 表单,如果不设置 enctype 属性,那么最终就会以 application/x-www-form-urlencoded 方式提交数据。请求类似于下面这样(无关的请求头在本文中都省略掉了):

POST http://www.example.com HTTP/1.1

Content-Type: application/x-www-form-urlencoded;charset=utf-8

title=test&sub%5B%5D=1&sub%5B%5D=2&sub%5B%5D=3

首先,Content-Type 被指定为 application/x-www-form-urlencoded;其次,提交的数据按照 key1=val1&key2=val2 的方式进行编码,key 和 val 都进行了 URL 转码。大部分服务端语言都对这种方式有很好的支持。例如 PHP 中,$_POST['title'] 可以获取到 title 的值,$_POST['sub'] 可以得到 sub 数组。

很多时候,我们用 Ajax 提交数据时,也是使用这种方式。例如 JQuery 和 QWrap 的 Ajax,Content-Type 默认值都是「application/x-www-form-urlencoded;charset=utf-8」。

multipart/form-data

这又是一个常见的 POST 数据提交的方式。我们使用表单上传文件时,必须让 <form> 表单的 enctype 等于 multipart/form-data。直接来看一个请求示例:

POST http://www.example.com HTTP/1.1Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryrGKCBY7qhFd3TrwA------WebKitFormBoundaryrGKCBY7qhFd3TrwAContent-Disposition: form-data; name="text"title------WebKitFormBoundaryrGKCBY7qhFd3TrwAContent-Disposition: form-data; name="file"; filename="chrome.png"Content-Type: image/pngPNG ... content of chrome.png ...------WebKitFormBoundaryrGKCBY7qhFd3TrwA--

这个例子稍微复杂点。首先生成了一个 boundary 用于分割不同的字段,为了避免与正文内容重复,boundary 很长很复杂。然后 Content-Type 里指明了数据是以 multipart/form-data 来编码,本次请求的 boundary 是什么内容。消息主体里按照字段个数又分为多个结构类似的部分,每部分都是以 --boundary 开始,紧接着是内容描述信息,然后是回车,最后是字段具体内容(文本或二进制)。如果传输的是文件,还要包含文件名和文件类型信息。消息主体最后以 --boundary-- 标示结束。关于 multipart/form-data 的详细定义,请前往 rfc1867 查看。

这种方式一般用来上传文件,各大服务端语言对它也有着良好的支持。

上面提到的这两种 POST 数据的方式,都是浏览器原生支持的,而且现阶段标准中原生 <form> 表单也只支持这两种方式(通过 <form> 元素的 enctype 属性指定,默认为 application/x-www-form-urlencoded。其实 enctype 还支持 text/plain,不过用得非常少)。

随着越来越多的 Web 站点,尤其是 WebApp,全部使用 Ajax 进行数据交互之后,我们完全可以定义新的数据提交方式,给开发带来更多便利。

application/json

application/json 这个 Content-Type 作为响应头大家肯定不陌生。实际上,现在越来越多的人把它作为请求头,用来告诉服务端消息主体是序列化后的 JSON 字符串。由于 JSON 规范的流行,除了低版本 IE 之外的各大浏览器都原生支持 JSON.stringify,服务端语言也都有处理 JSON 的函数,使用 JSON 不会遇上什么麻烦。

JSON 格式支持比键值对复杂得多的结构化数据,这一点也很有用。记得我几年前做一个项目时,需要提交的数据层次非常深,我就是把数据 JSON 序列化之后来提交的。不过当时我是把 JSON 字符串作为 val,仍然放在键值对里,以 x-www-form-urlencoded 方式提交。

Google 的 AngularJS 中的 Ajax 功能,默认就是提交 JSON 字符串。例如下面这段代码:

var data = {'title':'test', 'sub' : [1,2,3]};$http.post(url, data).success(function(result) { ...});

最终发送的请求是:

POST http://www.example.com HTTP/1.1 Content-Type: application/json;charset=utf-8{"title":"test","sub":[1,2,3]}

这种方案,可以方便的提交复杂的结构化数据,特别适合 RESTful 的接口。各大抓包工具如 Chrome 自带的开发者工具、Firebug、Fiddler,都会以树形结构展示 JSON 数据,非常友好。但也有些服务端语言还没有支持这种方式,例如 php 就无法通过 $_POST 对象从上面的请求中获得内容。这时候,需要自己动手处理下:在请求头中 Content-Type 为 application/json 时,从 php://input 里获得原始输入流,再 json_decode 成对象。一些 php 框架已经开始这么做了。

text/xml

我的博客之前提到过 XML-RPC(XML Remote Procedure Call)。它是一种使用 HTTP 作为传输协议,XML 作为编码方式的远程调用规范。典型的 XML-RPC 请求是这样的:

HTML

POST http://www.example.com HTTP/1.1 Content-Type: text/xml<?xml version="1.0"?><methodCall> <methodName>examples.getStateName</methodName> <params> <param> <value><i4>41</i4></value> </param> </params></methodCall>

XML-RPC 协议简单、功能够用,各种语言的实现都有。它的使用也很广泛,如 WordPress 的 XML-RPC Api,搜索引擎的 ping 服务等等。JavaScript 中,也有现成的库支持以这种方式进行数据交互,能很好的支持已有的 XML-RPC 服务。不过,我个人觉得 XML 结构还是过于臃肿,一般场景用 JSON 会更灵活方便。

文主要介绍Fluent HTTP (Flurl)的使用,包括执行Get和Post等请求操作, Flurl允许您直接从连贯URL构建器链执行许多常见的HTTP任务。其下是HttpClient和相关类。正如您将看到的,Flurl使用方便的方法和流畅的优点增强了HttpClient,但并没有试图完全抽象它。

1、命名空间

using Flurl;
using Flurl.Http;

2、使用Nuget安装引用Flurl.Http(Fluent HTTP)

1)使用Nuget界面管理器

相关文档:VS(Visual Studio)中Nuget的使用

2)使用Package Manager命令安装

PM> Install-Package Flurl.Http -Version 2.4.2

3)使用.NET CLI命令安装

> dotnet add package Flurl.Http --version 2.4.2

3、执行GET和HEAD请求响应HttpResponseMessage

相关文档:HttpResponseMessage

var getResp = await "http://api.foo.com".GetAsync()
;
var headResp = await "http://api.foo.com".HeadAsync();

3、获取请求JSON数据

从JSON API获取强类型的poco对象:

T poco = await "http://api.foo.com".GetJsonAsync();

当创建类来匹配JSON时,非通用版本返回一个dynamic:

dynamic d = await "http://api.foo.com".GetJsonAsync();

从一个返回JSON数组的API获取一个动态列表:

var list = await "http://api.foo.com".GetJsonListAsync();

4、获取请求strings, bytes, 和streams

string text = await "http://site.com/readme.txt".GetStringAsync();
byte[] bytes = await "http://site.com/image.jpg".GetBytesAsync();
Stream stream = await "http://site.com/music.mp3".GetStreamAsync();

5、下载文件

// filename is optional here; it will default to the remote file name
var path = await "http://files.foo.com/image.jpg"
    .DownloadFileAsync("c:\\downloads", filename);

6、Post提交数据(JSON、Html Form)

POST提交JSON数据

await "http://api.foo.com".PostJsonAsync(new { a = 1, b = 2 });

模拟HTML表单post提交

await "http://site.com/login".PostUrlEncodedAsync(new { 
    user = "user", 
    pass = "pass"
});

上述Post方法返回一个任务<HttpResponseMessage>。当然,您可能希望在响应体中返回一些数据:

T poco = await url.PostJsonAsync(data).ReceiveJson<T>();
dynamic d = await url.PostUrlEncodedAsync(data).ReceiveJson();
string s = await url.PostUrlEncodedAsync(data).ReceiveString();

7、配置http请求头(header)

// one:
await url.WithHeader("Accept", "text/plain").GetJsonAsync();
// multiple:
await url.WithHeaders(new { Accept = "text/plain", User_Agent = "Flurl" }).GetJsonAsync();

在上面的第二个示例中,User_Agent将自动呈现为User-Agent标题名称。(连字符在标头名称中非常常见,但在C#标识符中不允许;下划线,恰恰相反)。

使用Basic authentication验证

await url.WithBasicAuth("username", "password").GetJsonAsync();

OAuth 2.0 bearer token:

await url.WithOAuthBearerToken("mytoken").GetJsonAsync();

8、配置Fluent HTTP (Flurl)

设置超时(timeout)时间

await url.WithTimeout(10).DownloadFileAsync(); // 10 seconds
await url.WithTimeout(TimeSpan.FromMinutes(2)).DownloadFileAsync();

设置cookies

// one:
await url.WithCookie("name", "value", expDate).HeadAsync();
// multiple:
await url.WithCookies(new { c1 = 1, c2 = 2 }, expDate).HeadAsync();
// date is optional; excluding it makes it a session cookie.

取消请求

var cts = new CancellationTokenSource();
var task = url.GetAsync(cts.Token);
...
cts.Cancel();

一些不太常见的场景:

// 使用 "raw" System.Net.Http.HttpContent object
await url.PostAsync(httpContent);
// 使用HttpMethod指定请求方式
await url.SendJsonAsync(HttpMethod.Options, poco);
// 执行更复杂配置的请求
await url.SendAsync(
    HttpMethod.Trace,
    httpContent, // optional
    cancellationToken,  // optional
    HttpCompletionOption.ResponseHeaderRead);  // optional

相关文档

https://flurl.dev/docs/fluent-http/
.Net(C#)后台发送Get和Post请求的几种方法总结