Ajax 的核心是 XMLHttpRequest 物件(簡稱 XHR)。透過 XHR 取得伺服器資料,再用 DOM 把資料放進頁面呈現。名稱裡雖然有 XML,但 Ajax 的溝通其實與資料格式無關,XML、JSON 都可以。
XHR 的具體作用包括:不重新載入頁面就更新網頁、在頁面載入後向伺服器請求資料、接收資料,以及背景送出資料。
XHR 是一個 JavaScript 物件,最初由微軟設計,後被 Mozilla、Apple、Google 採用,W3C 正在標準化它。建立實例很簡單:
var req = new XMLHttpRequest();
有人會立刻反應:IE6 不支援原生 XHR。確實如此,後面會給出相容寫法。
建立物件後接著呼叫初始化方法 open(),其簽名如下:
void open(
DOMString method, // "GET", "POST", "PUT", "DELETE"
DOMString url,
optional boolean async,
optional DOMString user,
optional DOMString password
);
其中 method 與 url 必填。以下針對 myxhrtest.aspx 送出 GET 請求:
var req = new XMLHttpRequest();
req.open("GET", "myxhrtest.aspx", false);
兩點要留意:一是 url 相對於執行該程式碼的當前頁面;二是呼叫 open() 並不會真正送出請求,只是完成送出的準備。此外,只能向同一網域、同端口、同協定的 url 發送請求,否則會引發安全錯誤。
真正送出要靠 send()。它接受一個參數,即請求主體的內容;若無需主體,必須傳 null:
var req = new XMLHttpRequest();
req.open("GET", "myxhrtest.aspx", false);
req.send(null);
送出後要判斷是否成功,先看 status:一般以 HTTP 狀態碼 200 為成功,此時回應主體會存在 responseText 中;304 表示資源未被修改,可直接使用瀏覽器快取。
if (req != null) {
req.onreadystatechange = function () {
if ((req.status >= 200 && req.status < 300) || req.status == 304) {
// 處理資料
} else {
alert("Request was unsuccessful: " + req.status);
}
};
req.open("GET", "myxhrtest.aspx", true);
req.send(null);
}
異步請求下,JavaScript 會繼續往下執行,此時要透過 readyState 判斷狀態:
| readyState | 描述 |
|---|---|
| 0 | 未初始化,尚未呼叫 open() |
| 1 | 已啟動,尚未呼叫 send() |
| 2 | 已送出,但尚未收到回應 |
| 3 | 接收中,已收到部分資料 |
| 4 | 完成,已收到全部資料 |
同步請求會等伺服器執行完畢才繼續;異步請求則不必等待。因此異步寫法要多一層 readyState == 4 的判斷:
if (req != null) {
req.onreadystatechange = function () {
if (req.readyState == 4) {
if ((req.status >= 200 && req.status < 300) || req.status == 304) {
// 處理資料
} else {
alert("Request was unsuccessful: " + req.status);
}
}
};
req.open("GET", "myxhrtest.aspx", true);
req.send(null);
}
我們在網址列輸入 url 並按 Enter,瀏覽器發送請求,伺服器回傳頁面。這個過程裡頁面是逐段載入的,而 Ajax 正是用來做這種局部異步載入。以下以 AdventureWorks 的 Product 表為例,示範如何把資料以 JSON 送到前端。
public class ProductDao
{
public ProductDao() { }
public int Id { get; set; } // 產品 Id
public string Name { get; set; } // 名稱
public string SerialNumber { get; set; } // 序號
public short Qty { get; set; } // 銷售數量
}
public class ProductManager
{
private const string Query =
"SELECT ProductID, Name, ProductNumber, SafetyStockLevel FROM Production.Product";
private IList<ProductDao> _products = new List<ProductDao>();
public IList<ProductDao> GetAllProducts()
{
using (var con = new SqlConnection(
ConfigurationManager.ConnectionStrings["SQLCONN"].ToString()))
using (var com = new SqlCommand(Query, con))
{
con.Open();
using (var reader = com.ExecuteReader(CommandBehavior.CloseConnection))
{
while (reader.Read())
{
_products.Add(new ProductDao
{
Id = (int)reader["ProductID"],
Name = (string)reader["Name"],
SerialNumber = (string)reader["ProductNumber"],
Qty = (short)reader["SafetyStockLevel"]
});
}
}
}
return _products;
}
}
一般處理常式(ASHX)很適合這類場景:產生動態圖片、回傳 REST 風格的 XML 或 JSON、輸出客製 HTML。
<%@ WebHandler Language="C#" Class="ProductInfo" %>
using System.Runtime.Serialization.Json;
using System.Web;
using ASP.App_Code;
public class ProductInfo : IHttpHandler {
public void ProcessRequest(HttpContext context) {
context.Response.ContentType = "application/json";
var manager = new ProductManager();
var products = manager.GetAllProducts();
var json = new DataContractJsonSerializer(products.GetType());
json.WriteObject(context.Response.OutputStream, products);
}
public bool IsReusable { get { return false; } }
}
ProductInfo 實作 IHttpHandler,其中 ProcessRequest() 處理傳入的 Http 請求,預先把內容類型改為 application/json,再把資料以 JSON 寫入輸出流;IsReusable 表示同一處理常式能否被多個請求共用,設為 false 較安全,若為了效能也可設為 true。
IE6 及更早版本不支援 XMLHttpRequest(),需透過 MSXML 的 ActiveX 物件,而 IE 上可能出現三種版本(MSXML2.XMLHttp6.0、3.0 與 MSXML2.XMLHttp):
function createXHR() {
if (typeof XMLHttpRequest != "undefined") {
return new XMLHttpRequest();
} else if (typeof ActiveXObject != "undefined") {
if (typeof arguments.callee.activeXString != "string") {
var versions = ["MSXML2.XMLHttp6.0", "MSXML2.XMLHttp3.0", "MSXML2.XMLHttp"];
for (var i = 0; i < versions.length; i++) {
try {
var xhr = new ActiveXObject(versions[i]);
arguments.callee.activeXString = versions[i];
return xhr;
} catch (ex) {
throw new Error(ex.toString());
}
}
return new ActiveXObject(arguments.callee.activeXString);
} else {
throw new Error("No XHR object available");
}
}
return null;
}
$(document).ready(function () { GetDataFromServer(); });
function GetDataFromServer() {
var req = new createXHR();
if (req != null) {
req.onreadystatechange = function () {
if (req.readyState == 4) {
if ((req.status >= 200 && req.status < 300) || req.status == 304) {
var jsonTextDiv = document.getElementById("jsonText");
var data = JSON.parse(req.responseText);
for (var i = 0; i < data.length; i++) {
var item = data[i];
var div = document.createElement("div");
div.setAttribute("class", "dataItem");
div.innerHTML = item.Name + " sold " + item.Qty
+ "; Product number: " + item.SerialNumber;
jsonTextDiv.appendChild(div);
}
} else {
alert("Request was unsuccessful: " + req.status);
}
}
};
req.open("GET", "ProductInfo.ashx", true);
req.send(null);
}
}
取得 responseText 後,用 JSON.parse() 轉成 JavaScript 物件,再逐筆塞進 div。加上一點 CSS 之後,畫面就清爽多了:
#header { width:100%; background-color:#480082; color:#FFFFFF; }
div#jsonText {
background-color:#d9d9d9; border-radius:6px;
border:1px solid #d9d9d9; margin:10px 0 0 0; padding:0;
}
div.dataItem { font-family:Verdana, Helvetica, sans-serif; color:#434343; padding:10px; }
div.dataItem:nth-child(2n) { background-color:#fafafa; }
同源策略阻止從一個網域載入的腳本取得或操作另一個網域的文件屬性。也就是說,被請求的 url 必須與當前頁面的網域、端口、協定完全相同,瀏覽器藉此隔離不同來源的內容。
跨源資源共享(CORS)是一項瀏覽器技術規範,定義了讓 Web 伺服器允許其他網域的頁面存取其資源的方法,讓瀏覽器與伺服器能彼此協商是否允許跨源請求。
同源請求裡我們用的是 JSON,跨源請求卻常見 JSONP,兩者的關係值得說清:JSON 是一種資料格式,而 JSONP 像是用一個方法名把 JSON 包起來。由於瀏覽器允許跨源請求 <script> 資源(我們頁面裡載入 Google 的 jQuery 就是例子),伺服器回傳資料時無法預知接收資料的方法名,所以我們必須把方法名告訴它。
常見的跨域解法有:JSONP、表單 POST、伺服器端代理、HTML5 的 XDomainRequest、Flash request 等。
JSONP(JSON with Padding)是非官方協議,允許伺服器端整合 script 標籤回傳客戶端,以 JavaScript callback 的形式實現跨域存取。由於同源策略限制 XHR 只能請求當前來源,改用 script 標籤繞過限制,再由伺服器輸出 JSON 並執行回呼,跨域資料請求就成立了。
假設某站提供 https://www.cnblogs.com/hotblogs/json? 供開發者取得熱門博文,最直觀的呼叫方式是告訴伺服器接收資料的方法名:
https://www.cnblogs.com/hotblogs/json?callback=myFunction
function myFunction(data) {
// 在這裡處理資料
}
想在頁面加上微博的公共微博訊息,可先查 API 文件找到 statuses/public_timeline,它支援 JSON 與 XML。參數中僅 source(AppKey)為必填,count 預設 20、最大 200。
微博的資料結構由基礎型別與 user 這個複合型別組成,資訊相當豐富。實作時先定義一個全域物件,包含 numWeibo、appendTo、appKey 三個屬性,以及 loadWeibo()、timeAgo()、clean() 三個方法:
JQWeibo = {
numWeibo: 15,
appendTo: '#jsWeibo',
appKey: YourAppKey,
loadWeibo: function () {
$.ajax({
url: "https://api.t.sina.com.cn/statuses/public_timeline.json",
type: "GET",
dataType: "jsonp",
data: { source: JQWeibo.appKey, count: JQWeibo.numWeibo },
success: function (data) {
var html =
'<div class="weibo">' +
'<a href="https://weibo.com/DOMAIN" target="_blank">USER</a>' +
':WEIBO_TEXT<div class="time">AGO</div></div>';
for (var i = 0; i < data.length; i++) {
$(JQWeibo.appendTo).append(
html.replace('WEIBO_TEXT', JQWeibo.ify.clean(data[i].text))
.replace(/DOMAIN/g, data[i].user.domain)
.replace(/USER/g, data[i].user.screen_name)
.replace('AGO', JQWeibo.timeAgo(data[i].created_at))
);
}
}
});
},
timeAgo: function (dateString) { /* 轉相對時間 */ },
ify: { clean: function (weibo) { return weibo; } }
};
頁面只需預留容器並載入 jQuery:
<!DOCTYPE HTML> <html> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Weibo Feed</title> <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script> <link rel="stylesheet" type="text/css" href="css/WeiboFeed.css"> </head> <body> <div id="jsWeibo"></div> </body> </html>
以員工資料為例:
[
{ "id": "82105", "name": { "lastName": "Huang", "firstName": "JK" } },
{ "id": "82106", "name": { "lastName": "Leung", "firstName": "Cindy" } }
]
對應的模型:
public class Employee {
public int Id { get; set; }
public Name FullName { get; set; }
}
public class Name {
public string FirstName { get; set; }
public string LastName { get; set; }
}
JavaScriptSerializer(ASP.NET AJAX):
var serializer = new JavaScriptSerializer(); var employees = serializer.Deserialize<Employee[]>(data);
Json.NET:
using (var stringReader = new StringReader(data))
using (var jsonTextReader = new JsonTextReader(stringReader))
{
var serializer = new JsonSerializer();
var employees = serializer.Deserialize<Employee[]>(jsonTextReader);
}
DataContractJsonSerializer(WCF)需在模型上加 DataContract 與 DataMember:
[DataContract]
public class Employee {
[DataMember(Name = "id")] public int Id { get; set; }
[DataMember(Name = "fullname")] public Name FullName { get; set; }
}
[DataContract]
public class Name {
[DataMember(Name = "firstName")] public string FirstName { get; set; }
[DataMember(Name = "lastName")] public string LastName { get; set; }
}
using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(data)))
{
var serializer = new DataContractJsonSerializer(typeof(List<Employee>));
var employee = (List<Employee>)serializer.ReadObject(ms);
}
Ajax 在同源請求中幾乎沒有障礙,但跨源時受限於同源策略。JSONP 是最經典的繞道方案,代價是無法可靠地處理錯誤;若環境允許,伺服器端 CORS 標頭會是更乾淨的選擇。至於資料格式,JSON 比 XML 精簡許多,在 JavaScript 端也有原生支援,已成為實務上的主流。