DIV CSS 佈局教程網

依 Content-Type 回應不同邏輯的 jQuery.ajax 寫法
編輯:JQuery入門技巧     

用 HTML5 搭配 ASP.NET Generic Handler 開發專案時,前後端透過 Ajax 溝通。有一次的需求是:同一個介面可能回傳 JSON,也可能回傳其他型別的內容,前端要依型別走不同的處理分支。記錄一下實作方式。

關鍵:success 回呼的第三個參數

$.ajax 的 success 回呼除了資料本身,還會收到 status 與 xhr(XMLHttpRequest 物件)。利用 xhr.getResponseHeader 就能讀取回應標頭,判斷伺服器到底回了什麼。

 $.ajax({
    url: 'GetWatermarkInfo.ashx',
    type: 'post',
    data: { 'bgstyle': bgstyle, 'watermark': watermark },
    success: function (data, status, xhr) {
        // 用 XMLHttpRequest 的 getResponseHeader 取得 content-type
        var ct = xhr.getResponseHeader("content-type") || "";

        if (ct.indexOf('application/json') > -1) {
            if (data.Status == 'error') {
                alert(data.Message);
            } else if (data.Status == 'ok') {
                $('#watermarkImg').attr('src',
                    'GenerateWatermark.ashx?bgstyle=' + bgstyle + '&watermark=' + watermark);
            } else {
                alert('unknown error!');
            }
        } else {
            alert('unexpected content-type!');
        }
    },
    error: function (message) {
        alert('error: ' + message);
    }
}); 

更好的做法:讓 jQuery 幫你判斷

手動讀標頭是可行的,但其實 jQuery 預設就會依 Content-Type 自動決定如何解析回應。若一開始就不指定 dataType,jQuery 會依回應標頭處理:回傳 application/json 時,data 已經是物件;回傳 text/html 時則是字串。

因此多數情況只需要判斷 typeof data:

 success: function (data) {
    if (typeof data === 'object') {
        // JSON 分支
        if (data.Status === 'ok') { /* ... */ }
    } else {
        // 文字或 HTML 分支
    }
} 

如果你希望強制以特定格式解析,也可以明確指定 dataType: 'json';反之,若回應格式可能變化,就別指定,讓 jQuery 依標頭自動處理。

幾個實務提醒

1. 標頭名稱不分大小寫,但值可能帶 charset。實際回傳的常是 application/json; charset=utf-8,所以用 indexOf 比對比用全等判斷安全。

2. 用 HTTP 狀態碼表達錯誤更合適。把「發生錯誤」的資訊塞在 200 回應的 body 裡,會讓快取、監控與重試機制全部失效。比較好的設計是:成功回 200 加 JSON,失敗回 4xx 或 5xx 並在 error 回呼中統一處理。

3. Handler 中要明確設定 Content-Type。在 ashx 中記得寫 context.Response.ContentType = "application/json";,否則可能回傳成 text/html,讓前端的型別判斷失準。

4. 別忘了錯誤處理。範例中的 error 回呼直接 alert 了錯誤物件,實務上建議取出 errorThrown 的訊息,並針對不同的 textStatus(timeout、parsererror、abort)給出不同的提示或重試策略。

結論

依 Content-Type 分流的技術含量不高,關鍵在於知道 success 回呼拿到了哪些資訊。但更值得養成的習慣是:把型別判斷交給 jQuery 的自動解析,把錯誤狀態交給 HTTP 狀態碼,前端程式碼會乾淨很多,也更容易維護。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved