HTTP contentType

摘要：规范把请求分为三个部分状态行请求头消息主体。消息主体最后以标示结束。格式支持比键值对复杂得多的结构化数据，这一点也很有用。例如下面这段代码最终发送的请求是这种方案，可以方便的提交复杂的结构化数据，特别适合的接口。

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

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

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

Content-Type 内容类型，一般是指网页中存在的 Content-Type，用于定义网络文件的类型和网页的编码，决定浏览器将以什么形式、什么编码读取这个文件。

ContentType 属性指定响应的 HTTP内容类型。如果未指定 ContentType，默认为TEXT/HTML。

下面是几个常见的 Content-Type:

text/html
text/plain
text/css
text/javascript
application/x-www-form-urlencoded
multipart/form-data
application/json
application/xml

前面几个都很好理解，都是html，css，javascript 的文件类型，后面四个是POST的发包方式。

那么前端在开发过程中应该使用哪种 contentType 类型？

选择 contentType 类型要结合项目实际来确定，要考虑参数的数据结构、传递方式，更重要的是要跟后台开发人员配合，不可能多带带由某一方来确定，前后台需要共同约定参数的数据结构和传递方式，是使用 json 形式，还是使用字符串，或者使用数组等等。确定了参数形式以及对应的后端处理方式，contentType 类型也就基本上确定了。
其实选择哪种 contentType 类型，主要就是考虑参数形式和后端的处理方式，比如使用 application/json 这种类型，将嵌套的 json 对象参数序列化处理之后传递，那么只要后端能够正确的接收和处理前端传递的参数，那么使用这种类型就是可以的。

示例-1 （后台 .net 开发，参数约定为数组形式，序列化之后拼接 "data="）

     var request = $.extend({}, ajaxParams, {
       // 实际进行传递的参数
       data: "data=" + escape(ajaxRequest.json.stringify(requestData)),
       success: success,
       error: error
     });

    defaultOpts: {
      url: "../AjaxHandler.aspx?r=" + Math.random(),
      dataType: "json", // 这里指定从服务器返回的数据类型
      type: "POST",
      // 这里原本是使用 application/json，但后端不能正确的处理接收到的参数，并且处理后的参数也不符合 json 规范
      contentType: "application/x-www-form-urlencoded; charset=UTF-8"
    }

// 示例-2 （后台 .net 开发，参数约定为序列化 json 字符串，且后端能够正确处理）

    // 同示例-1一样，这里只是展示了部分相关代码
    var request = $.extend({}, ajaxParams, {
        data: servicebusProxy.json.stringify(requestData),
        success: success,
        error: error
    });

    defaultOpts: {
        url: "ServiceBusExpoHttpHandler.ashx?r=" + Math.random(),
        dataType: "json",
        type: "POST",
        contentType: "application/json; charset=UTF-8"
    },

这应该是最常见的 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」。

JQuery Ajax 中的 contentType：

contentType (default: "application/x-www-form-urlencoded; charset=UTF-8")
Type: Boolean or String
当将数据发送到服务器时，使用该内容类型。默认值是"application/x-www-form-urlencoded; charset=UTF-8"，适合大多数情况。如果你明确地传递了一个内容类型（Content-Type）给 $.ajax()，那么他总是会发送给服务器（即使没有数据要发送）。从 jQuery 1.6 开始，你可以传递false来告诉jQuery，没有设置任何内容类型头信息。 注意：W3C的XMLHttpRequest的规范规定，数据将总是使用UTF-8字符集传递给服务器；指定其他字符集无法强制浏览器更改编码。 注意:对于跨域请求，内容类型设置为application/x-www-form-urlencoded, multipart/form-data, 或 text/plain以外， 将触发浏览器发送一个预检OPTIONS请求到服务器。

这又是一个常见的 POST 数据提交的方式。我们使用表单上传文件时，必须让 form 的 enctyped 等于这个值。
来看一个请求示例：

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

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

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

上面提到的这两种 POST 数据的方式，都是浏览器原生支持的，而且现阶段原生 form 表单也只支持这两种方式。但是随着越来越多的 Web 站点，尤其是 WebApp，全部使用 Ajax 进行数据交互之后，我们完全可以定义新的数据提交方式，给开发带来更多便利。

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

JSON 格式支持比键值对复杂得多的结构化数据，这一点也很有用。
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 框架已经开始这么做了。

XML-RPC（XML Remote Procedure Call）是一种使用 HTTP 作为传输协议，XML 作为编码方式的远程调用规范。典型的 XML-RPC 请求是这样的：

    POST http://www.example.com HTTP/1.1
    Content-Type: text/xml
 
    
    
        examples.getStateName
        
            
                41
            
        
    

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