四种常见的 POST 提交数据方式
HTTP 协议是以 ASCII 码传输,建立在 TCP/IP 协议之上的应用层规范。规范把 HTTP 请求分为三个部分:状态行、请求头、消息主体。协议规定 POST 提交的数据必须放在消息主体(entity-body)中,但协议并没有规定数据必须使用什么编码方式。实际上,开发者完全可以自己决定消息主体的格式,只要最后发送的 HTTP 请求满足上面的格式就可以。
但是,数据发送出去,还要服务端解析成功才有意义。一般服务端语言如 php、python 等,以及它们的 framework,都内置了自动解析常见数据格式的功能。服务端通常是根据请求头(headers)中的 Content-Type 字段来获知请求中的消息主体是用何种方式编码,再对主体进行解析。所以说到 POST 提交数据方案,包含了 Content-Type 和消息主体编码方式两部分。下面我们一起来看看ajax中POST请求中的Content-Type。
(1)application/x-www-form-urlencoded
这应该是最常见的 POST 提交数据的方式了。浏览器的原生 form 表单,如果不设置 enctype 属性,那么最终就会以 application/x-www-form-urlencoded 方式提交数据。请求类似于下面这样:
application/x-www-form-urlencoded.png
首先,Content-Type 被指定为 application/x-www-form-urlencoded;其次,提交的数据按照 key1=val1&key2=val2 的方式进行编码,key 和 val 会进行了 URL 转码。大部分服务端语言都对这种方式有很好的支持。例如 PHP 中,$_POST['XXX'] 可以获取到相应的值。
很多时候,我们用 Ajax 提交数据时,也是使用这种方式。例如 JQuery 和 QWrap 的 Ajax,Content-Type 默认值都是「application/x-www-form-urlencoded;charset=utf-8」。如果你用js写ajax要用这种方式,一定要注意加上setRequestHeader("Content-type","application/x-www-form-urlencoded");否则无法正常解析。
由于form表单会有默认事件,需要阻止默认事件(js用e.preventDefault()或return false;(ie) / jq用return false;),我们就直接在form表单上加οnsubmit="return false;"。或者也可以直接不用form标签。
html:
<form id="myform" onsubmit="return false;">
用户名:<input type="text" id="username" name="username"/>
密码:<input type="password" id="psw" name="psw"/><br/>
<!-- 头像:<input type="file" name="head"></form> -->
<div class="button">
<button class="btn btn-primary" id="register">注册</button>
</div>
</form>
js:
js.png
jq:
jq.png
(2)multipart/form-data
这也是一个常见的 POST 数据提交的方式。我们使用表单上传文件时,就要让 form 的 enctype 等于这个值。直接来看一个请求示例:
multipart/form-data.png
这个例子稍微复杂点。首先生成了一个 boundary 用于分割不同的字段,为了避免与正文内容重复,boundary 很长很复杂。然后 Content-Type 里指明了数据是以 mutipart/form-data 来编码,本次请求的 boundary 是什么内容。消息主体里按照字段个数又分为多个结构类似的部分,每部分都是以 --boundary 开始,紧接着内容描述信息,然后是回车,最后是字段具体内容(文本或二进制)。如果传输的是文件,还要包含文件名和文件类型信息。消息主体最后以 --boundary-- 标示结束。FormData 对象的更多内容点击FormData 对象的使用。
我们来看看具体实现:
js:
document.getElementById("register").addEventListener("click", function () {
let form=document.getElementById("myform");
let formData = new FormData(form);
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if ((xhr.status >= 200 && xhr.status < 300) || xhr.status == 304) {
console.log(xhr.responseText);
} else {
alert("Response was unsuccessful:" + xhr.status);
}
}
};
xhr.open("post", "test.php", true);
xhr.setRequestHeader("Content-Type","multipart/form-data");
xhr.send(formData);
})
或jq:
$(document).ready(function(){
$("#register").click(function(){
var data = new FormData($('#myform')[0]);
$.ajax({
url: 'test.php',
type: 'POST',
data: data,
dataType: 'JSON',
cache: false,
processData: false,
contentType: false
});
return false;
});
});
这种方式一般用来上传文件,各大服务端语言对它也有着良好的支持。
上面提到的这两种 POST 数据的方式,都是浏览器原生支持的,而且现阶段原生 form 表单也只支持这两种方式。但是随着越来越多的 Web 站点,尤其是 WebApp,全部使用 Ajax 进行数据交互之后,我们完全可以定义新的数据提交方式,给开发带来更多便利。
(3)application/json
application/json 这个 Content-Type 作为响应头大家肯定不陌生。实际上,现在越来越多的人把它作为请求头,用来告诉服务端消息主体是序列化后的 JSON 字符串。由于 JSON 规范的流行,除了低版本 IE 之外的各大浏览器都原生支持 JSON.stringify,服务端语言也都有处理 JSON 的函数,使用 JSON 不会遇上什么麻烦。
JSON 格式支持比键值对复杂得多的结构化数据,这一点也很有用。
在angular中,$http的contentType默认值是application/json;charset=UTF-8。例如下面这段代码:
var data = {'title':'test', 'sub' : [1,2,3]};
$http.post(url, data).success(function(result) {
...
});
我们在来看看js和jq中怎样实现:
document.getElementById("register").onclick = function() {
var request = new XMLHttpRequest();
request.open("POST", "test.php");
var data = {"username" :document.getElementById("username").value ,
"pwd" : document.getElementById("psw").value,
}
data=JSON.stringify(data);
request.setRequestHeader("Content-type","application/json");
request.send(data);
request.onreadystatechange = function() {
if (request.readyState===4) {
if (request.status===200) {
var data = JSON.parse(request.responseText);
if (data.id) {
console.log(data.msg);
} else {
console.log("出现错误:" + data.msg);
}
} else {
alert("发生错误:" + request.status);
}
}
}
}
$("#register").click(function(){
var data={
"username": $("#username").val(),
"pwd": $("#psw").val()
};
data=JSON.stringify(data);
$.ajax({
type: "POST",
url: "test.php",
data:data,
dataType: "json",
contentType:"application/json;charset=utf-8",
success: function(data){
if (data.id) {
console.log(data.msg);
} else {
console.log("出现错误:" + data.msg);
}
},
error: function(jqXHR){
alert("发生错误:" + jqXHR.status);
},
});
});
application/json.png
这种方案,可以方便的提交复杂的结构化数据,特别适合 RESTful 的接口。各大抓包工具如 Chrome 自带的开发者工具、Firebug、Fiddler,都会以树形结构展示 JSON 数据,非常友好。但也有些服务端语言还没有支持这种方式,例如 php 就无法通过 $_POST 对象从上面的请求中获得内容。这时候,需要自己动手处理下:在请求头中 Content-Type 为 application/json 时,从 php://input 里获得原始输入流,再 json_decode 成对象。一些 php 框架已经开始这么做了。
(4)text/xml
相比于JSON,XML不能更好的适用于数据交换,它包含了太多的包装, 而且它跟大多数编程语言的数据模型不匹配,让大多数程序员感到诧异,XML是面向数据的,JSON是面向对象和结构的,后者会给程序员一种更加亲切的感觉。
我们现在一般这样来使用:
1、XML 存储数据,存储配置文件等需要结构化存储的地方使用;
2、数据传输、数据交互使用JSON;
下面就是ajax Content-Type为text/xml的请求:
text/xml.png
js:
document.getElementById("register").addEventListener("click",function (e){
var xhr = new XMLHttpRequest();
xhr.onreadystatechange=function(){
if(xhr.readyState==4){//返回
if(xhr.status==200){//响应代码正常
var xmlObj=xhr.responseXML;
//后台返回<res><mes>success</mes><user>patty</user></res>
var res=xmlObj.getElementsByTagName("res")[0];
var mes=res.childNodes[0].childNodes[0].nodeValue;
var user=res.childNodes[1].childNodes[0].nodeValue;
console.log(mes+" 用户:"+user);
}
}
};
xhr.open("post", "test.php", true);
var name=document.getElementsByName("username")[0].value;
var pwd=document.getElementsByName("psw")[0].value;
var xml="<user><name>"+name+"</name><pwd>"+pwd+"</pwd></user>";
xhr.setRequestHeader("Content-Type", "text/xml");
xhr.send(xml);
});
jq:
$(document).ready(function(){
$("#register").click(function(){
var user=$("#username").val();
var pwd=$("#psw").val();
var data="<user><name>"+user+"</name><pwd>"+pwd+"</pwd></user>";
$.ajax({
type: "POST",
url: "test.php",
data:data,
contentType:"text/xml",
dataType: "XML",
success: function(data){
var mes=$(data).find("res").children("mes").text();
var user=$(data).find("res").children("user").text()
console.log(mes+" 用户:"+user);
},
error: function(jqXHR){
alert("发生错误:" + jqXHR.status);
},
});
});
});