XMLHttpRequest Level 2 使用指南

阮一峰發表於2012-09-08

XMLHttpRequest是一個瀏覽器介面,使得Javascript可以進行HTTP(S)通訊。

最早,微軟在IE 5引進了這個介面。因為它太有用,其他瀏覽器也模仿部署了,ajax操作因此得以誕生。

但是,這個介面一直沒有標準化,每家瀏覽器的實現或多或少有點不同。HTML 5的概念形成後,W3C開始考慮標準化這個介面。2008年2月,就提出了XMLHttpRequest Level 2 草案。

這個XMLHttpRequest的新版本,提出了很多有用的新功能,將大大推動網際網路革新。本文就對這個新版本進行詳細介紹。

XMLHttpRequest Level 2 使用指南

一、老版本的XMLHttpRequest物件

在介紹新版本之前,我們先回顧一下老版本的用法。

首先,新建一個XMLHttpRequest的例項。

  var xhr = new XMLHttpRequest();

然後,向遠端主機發出一個HTTP請求。

  xhr.open('GET', 'example.php');

  xhr.send();

接著,就等待遠端主機做出回應。這時需要監控XMLHttpRequest物件的狀態變化,指定回撥函式。

  xhr.onreadystatechange = function(){

    if ( xhr.readyState == 4 && xhr.status == 200 ) {

      alert( xhr.responseText );

    } else {

      alert( xhr.statusText );

    }

  };

上面的程式碼包含了老版本XMLHttpRequest物件的主要屬性:

  * xhr.readyState:XMLHttpRequest物件的狀態,等於4表示資料已經接收完畢。

  * xhr.status:伺服器返回的狀態碼,等於200表示一切正常。

  * xhr.responseText:伺服器返回的文字資料

  * xhr.responseXML:伺服器返回的XML格式的資料

  * xhr.statusText:伺服器返回的狀態文字。

二、老版本的缺點

老版本的XMLHttpRequest物件有以下幾個缺點:

  * 只支援文字資料的傳送,無法用來讀取和上傳二進位制檔案。

  * 傳送和接收資料時,沒有進度資訊,只能提示有沒有完成。

  * 受到"同域限制"(Same Origin Policy),只能向同一域名的伺服器請求資料。

三、新版本的功能

新版本的XMLHttpRequest物件,針對老版本的缺點,做出了大幅改進。

  * 可以設定HTTP請求的時限。

  * 可以使用FormData物件管理表單資料。

  * 可以上傳檔案。

  * 可以請求不同域名下的資料(跨域請求)。

  * 可以獲取伺服器端的二進位制資料。

  * 可以獲得資料傳輸的進度資訊。

下面,我就一一介紹這些新功能。

四、HTTP請求的時限

有時,ajax操作很耗時,而且無法預知要花多少時間。如果網速很慢,使用者可能要等很久。

新版本的XMLHttpRequest物件,增加了timeout屬性,可以設定HTTP請求的時限。

  xhr.timeout = 3000;

上面的語句,將最長等待時間設為3000毫秒。過了這個時限,就自動停止HTTP請求。與之配套的還有一個timeout事件,用來指定回撥函式。

  xhr.ontimeout = function(event){

    alert('請求超時!');

  }

目前,Opera、Firefox和IE 10支援該屬性,IE 8和IE 9的這個屬性屬於XDomainRequest物件,而Chrome和Safari還不支援。

五、FormData物件

ajax操作往往用來傳遞表單資料。為了方便表單處理,HTML 5新增了一個FormData物件,可以模擬表單。

首先,新建一個FormData物件。

  var formData = new FormData();

然後,為它新增表單項。

  formData.append('username', '張三');

  formData.append('id', 123456);

最後,直接傳送這個FormData物件。這與提交網頁表單的效果,完全一樣。

  xhr.send(formData);

FormData物件也可以用來獲取網頁表單的值。

  var form = document.getElementById('myform');

  var formData = new FormData(form);

  formData.append('secret', '123456'); // 新增一個表單項

  xhr.open('POST', form.action);

  xhr.send(formData);

六、上傳檔案

新版XMLHttpRequest物件,不僅可以傳送文字資訊,還可以上傳檔案。

假定files是一個"選擇檔案"的表單元素(input[type="file"]),我們將它裝入FormData物件。

  var formData = new FormData();

  for (var i = 0; i < files.length;i++) {

    formData.append('files[]', files[i]);

  }

然後,傳送這個FormData物件。

  xhr.send(formData);

七、跨域資源共享(CORS)

新版本的XMLHttpRequest物件,可以向不同域名的伺服器發出HTTP請求。這叫做"跨域資源共享"(Cross-origin resource sharing,簡稱CORS)。

使用"跨域資源共享"的前提,是瀏覽器必須支援這個功能,而且伺服器端必須同意這種"跨域"。如果能夠滿足上面的條件,則程式碼的寫法與不跨域的請求完全一樣。

  xhr.open('GET', 'http://other.server/and/path/to/script');

目前,除了IE 8和IE 9,主流瀏覽器都支援CORS,IE 10也將支援這個功能。伺服器端的設定,請參考《Server-Side Access Control》

八、接收二進位制資料(方法A:改寫MIMEType)

老版本的XMLHttpRequest物件,只能從伺服器取回文字資料(否則它的名字就不用XML起首了),新版則可以取回二進位制資料。

這裡又分成兩種做法。較老的做法是改寫資料的MIMEType,將伺服器返回的二進位制資料偽裝成文字資料,並且告訴瀏覽器這是使用者自定義的字符集。

  xhr.overrideMimeType("text/plain; charset=x-user-defined");

然後,用responseText屬性接收伺服器返回的二進位制資料。

  var binStr = xhr.responseText;

由於這時,瀏覽器把它當做文字資料,所以還必須再一個個位元組地還原成二進位制資料。

  for (var i = 0, len = binStr.length; i < len; ++i) {

    var c = binStr.charCodeAt(i);

    var byte = c & 0xff;

  }

最後一行的位運算"c & 0xff",表示在每個字元的兩個位元組之中,只保留後一個位元組,將前一個位元組扔掉。原因是瀏覽器解讀字元的時候,會把字元自動解讀成Unicode的0xF700-0xF7ff區段。

八、接收二進位制資料(方法B:responseType屬性)

從伺服器取回二進位制資料,較新的方法是使用新增的responseType屬性。如果伺服器返回文字資料,這個屬性的值是"TEXT",這是預設值。較新的瀏覽器還支援其他值,也就是說,可以接收其他格式的資料。

你可以把responseType設為blob,表示伺服器傳回的是二進位制物件。

  var xhr = new XMLHttpRequest();

  xhr.open('GET', '/path/to/image.png');

  xhr.responseType = 'blob';

接收資料的時候,用瀏覽器自帶的Blob物件即可。

  var blob = new Blob([xhr.response], {type: 'image/png'});

注意,是讀取xhr.response,而不是xhr.responseText。

你還可以將responseType設為arraybuffer,把二進位制資料裝在一個陣列裡。

  var xhr = new XMLHttpRequest();

  xhr.open('GET', '/path/to/image.png');

  xhr.responseType = "arraybuffer";

接收資料的時候,需要遍歷這個陣列。

  var arrayBuffer = xhr.response;

  if (arrayBuffer) {

    var byteArray = new Uint8Array(arrayBuffer);

    for (var i = 0; i < byteArray.byteLength; i++) {

      // do something

    }
  }

更詳細的討論,請看Sending and Receiving Binary Data

九、進度資訊

新版本的XMLHttpRequest物件,傳送資料的時候,有一個progress事件,用來返回進度資訊。

它分成上傳和下載兩種情況。下載的progress事件屬於XMLHttpRequest物件,上傳的progress事件屬於XMLHttpRequest.upload物件。

我們先定義progress事件的回撥函式。

  xhr.onprogress = updateProgress;

  xhr.upload.onprogress = updateProgress;

然後,在回撥函式里面,使用這個事件的一些屬性。

  function updateProgress(event) {

    if (event.lengthComputable) {

      var percentComplete = event.loaded / event.total;

    }

  }

上面的程式碼中,event.total是需要傳輸的總位元組,event.loaded是已經傳輸的位元組。如果event.lengthComputable不為真,則event.total等於0。

與progress事件相關的,還有其他五個事件,可以分別指定回撥函式:

  * load事件:傳輸成功完成。

  * abort事件:傳輸被使用者取消。

  * error事件:傳輸中出現錯誤。

  * loadstart事件:傳輸開始。

  * loadEnd事件:傳輸結束,但是不知道成功還是失敗。

十、閱讀材料

  1. Introduction to XMLHttpRequest Level 2: 新功能的綜合介紹。

  2. New Tricks in XMLHttpRequest 2:一些用法的介紹。

  3. Using XMLHttpRequest:一些高階用法,主要針對Firefox瀏覽器。

  4. HTTP Access Control:CORS綜述。

  5. DOM access control using cross-origin resource sharing:CORS的9種HTTP頭資訊

  6. Server-Side Access Control:伺服器端CORS設定。

  7. Enable CORS:服務端CORS設定。

(完)

相關文章