写在前面的话:
根据对方的文档和示例,我们使用okhttp调用对方的http接口。http head和http body都自认无误后,始终是报400错误。请求无效 (Bad request); ---出现这个请求无效报错说明请求没有进入到后台服务里;
原因可能为以下两个:1)提交数据的字段名称或者是字段类型和服务端接口的实体类不一致;提交的参数跟服务端需要的参数个数不一致,导致无法接收;
2)提交的到服务端的数据应该是json字符串类型,而发送方没有将对象转化为字符串类型,最容易错误的是发送方以key-value的形式发送。
这里先科普下post请求的Content-Type数据类型:
1)application/x-www-form-urlencoded
这应该是最常见的 POST 提交数据的方式了。浏览器的原生 <form> 表单,如果不设置 enctype 属性,那么最终就会以 application/x-www-form-urlencoded 方式提交数据。请求类似于下面这样(无关的请求头在本文中都省略掉了):
BASHPOST 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 转码。
2)multipart/form-data
适用于文件上传
3)application/json
application/json 这个 Content-Type 作为响应头大家肯定不陌生。实际上,现在越来越多的人把它作为请求头,用来告诉服务端消息主体是序列化后的 JSON 字符串。由于 JSON 规范的流行,除了低版本 IE 之外的各大浏览器都原生支持 JSON.stringify,服务端语言也都有处理 JSON 的函数,使用 JSON 不会遇上什么麻烦。
JSON 格式支持比键值对复杂得多的结构化数据,这一点也很有用。记得我几年前做一个项目时,需要提交的数据层次非常深,我就是把数据 JSON 序列化之后来提交的。不过当时我是把 JSON 字符串作为 val,仍然放在键值对里,以 x-www-form-urlencoded 方式提交。
这种方案,可以方便的提交复杂的结构化数据,特别适合 RESTful 的接口。各大抓包工具如 Chrome 自带的开发者工具、Firebug、Fiddler,都会以树形结构展示 JSON 数据,非常友好。但也有些服务端语言还没有支持这种方式,例如 php 就无法通过 $_POST 对象从上面的请求中获得内容。这时候,需要自己动手处理下:在请求头中 Content-Type 为 application/json 时,从 php://input
里获得原始输入流,再 json_decode
成对象。一些 php 框架已经开始这么做了。
当然 AngularJS 也可以配置为使用 x-www-form-urlencoded 方式提交数据。
4)text/xml
我的博客之前提到过 XML-RPC(XML Remote Procedure Call)。它是一种使用 HTTP 作为传输协议,XML 作为编码方式的远程调用规范。典型的 XML-RPC 请求是这样的:
HTMLPOST 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 会更灵活方便。
回到我们本次的主题okhttp调用json数据格式的请求写法:
public byte[] POST(String baseUrl, Map<String, String> bodyParams, Map<String, String> headerMap) throws HttpGwsException, IOException {
okhttp3.FormBody.Builder bodyBuilder = new FormBody.Builder();
for (Map.Entry<String, String> item : bodyParams.entrySet()) {
bodyBuilder.addEncoded(item.getKey(), item.getValue());
}
FormBody formBody = bodyBuilder.build();
//发送请求
Request request = new Request.Builder().headers(Headers.of(headerMap))
.url(baseUrl).post(formBody)
.build();
Response response = ReqExecute(request);
if (!response.isSuccessful()) {
throw new HttpGwsException(response, "exception code:" + response.code());
}
return response.body().bytes();
}
报错信息是
[2018-09-28 10:00:17] INFO : action=uid=
sid=`msg=请求接口url=http://mcs.snssdk.com/v2/event/json,参数={header={"app_package":"com.youximao.demo"}, user={"user_unique_id":"3bf6c3f73c9ecad0d3724f47fabb5c2f"}, events={"event":"注册","local_time_ms":1538100017406,"params":"{"is_server":"yes","is_success":"yes","method":"手机注册"}"}}, header={X-MCS-AppKey=79b7ae4347f41143, Content-Type=application/json}
[2018-09-28 10:00:18] INFO : action=uid=
sid=msg=[hc request log,
reqId:430342367url:http://mcs.snssdk.com/v2/event/json,
content:`header=%7B%22app_package%22%3A%22com.youximao.demo%22%7D&user=%7B%22user_unique_id%22%3A%223bf6c3f73c9ecad0d3724f47fabb5c2f%22%7D&events=%7B%22event%22%3A%22%E6%B3%A8%E5%86%8C%22%2C%22local_time_ms%22%3A1538100017406%2C%22params%22%3A%22%7B%5C%22is_server%5C%22%3A%5C%22yes%5C%22%2C%5C%22is_success%5C%22%3A%5C%22yes%5C%22%2C%5C%22method%5C%22%3A%5C%22%E6%89%8B%E6%9C%BA%E6%B3%A8%E5%86%8C%5C%22%7D%22%7D]
[2018-09-28 10:00:18] INFO : action=uid=
sid=msg=[hc response log, reqId:430342367,
url:http://mcs.snssdk.com/v2/event/json,http code:400,
content:<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>400 Bad Request</title>
<h1>Bad Request</h1>
<p>Your request is malformed. argument of type 'NoneType' is not iterable</p>
,reqTime:625ms,
useTime:626ms]
错误的原因就在于Content-Type 不是application/json格式。
程序继续调整,正确写法是:
public final MediaType MEDIA_JSON = MediaType.parse("application/json; charset=utf-8");
public byte[] POST(String url, String jsonBody, Map<String, String> headerMap) throws IOException {
RequestBody body = RequestBody.create(MEDIA_JSON, jsonBody);
Request request = new Request.Builder().headers(Headers.of(headerMap))
.url(url)
.post(body)
.build();
Response response = ReqExecute(request);
if (!response.isSuccessful()) {
throw new HttpGwsException(response, "exception code:" + response.code());
}
return response.body().bytes();
}
注意在创建requestBody的MediaType contentType 必须等于MEDIA_JSON。
PS:
我们发起post请求的时候, 经常容易忽视了Content-Type的格式,切记服务端与客户端的交互需要定义好格式。
最后附上postman的几种格式的请求