DIV CSS 佈局教程網

jQuery getJSON 實戰:把 ASP.NET 的 DataTable 轉成 JSON 並在頁面渲染
編輯:JavaScript綜合知識     

本文以一個完整可運行的 demo,說明如何從 ASP.NET 後端把 DataSet/DataTable 序列化成 JSON,拋給前端由 jQuery 解析並顯示。

先認識 getJSON

jQuery.getJSON(url [, data] [, callback])
  • url:請求的位址
  • data:要一起送出的 key/value 參數
  • callback:載入成功時執行的回呼函數

它本質上是 $.ajax() 的快捷方式,差別是自動把 dataType 設為 "json",因此回呼收到的已經是解析好的物件。

步驟一:寫一個 DataTable 轉 JSON 的輔助方法

public static string DataTableToJson(string jsonName, DataTable dt)
{
    StringBuilder Json = new StringBuilder();
    Json.Append("{\"" + jsonName + "\":[");

    if (dt.Rows.Count > 0)
    {
        for (int i = 0; i < dt.Rows.Count; i++)
        {
            Json.Append("{");
            for (int j = 0; j < dt.Columns.Count; j++)
            {
                Json.Append("\"" + dt.Columns[j].ColumnName + "\":\""
                           + dt.Rows[i][j].ToString() + "\"");
                if (j < dt.Columns.Count - 1) Json.Append(",");
            }
            Json.Append("}");
            if (i < dt.Rows.Count - 1) Json.Append(",");
        }
    }

    Json.Append("]}");
    return Json.ToString();
}

邏輯是雙層迴圈:外層跑列、內層跑欄,用「是否為最後一項」決定要不要補逗號,最後包成 {"jsonName":[...]} 的結構。

但這個寫法有兩個必須正視的問題:一是沒有做跳脫處理,只要資料中包含雙引號、反斜線或換行,產生的 JSON 就是無效的;二是把所有值都當字串輸出,數字變成 "16" 而非 16。正式環境請改用內建的序列化器,例如 System.Web.Script.Serialization.JavaScriptSerializer 或 Json.NET:

var serializer = new JavaScriptSerializer();
string json = serializer.Serialize(dt);   // 跳脫與型別都自動處理

步驟二:準備資料來源

public static DataSet BindData()
{
    DataTable dtData = new DataTable();
    dtData.Columns.Add("id");
    dtData.Columns.Add("name");
    dtData.Columns.Add("sex");

    DataRow drData = dtData.NewRow();
    drData[0] = 16; drData[1] = "zhaoliu"; drData[2] = "man";
    dtData.Rows.Add(drData);

    drData = dtData.NewRow();
    drData[0] = 19; drData[1] = "zhangsan"; drData[2] = "women";
    dtData.Rows.Add(drData);

    DataSet ds = new DataSet();
    ds.Tables.Add(dtData);
    return ds;
}

實務上這段會換成從資料庫或服務層取得資料,這裡手動建立只是為了讓 demo 能獨立運行。

步驟三:前端頁面

<input id="btn"  type="button" value="解析 json" />
<input id="btn2" type="button" value="查看 json 字串" />
<label id="txt"></label>
<label id="txt2"></label>

<script src="Scripts/jquery-1.4.1.min.js"></script>
<script>
$(function () {
    // 解析並渲染
    $("#btn").click(function () {
        $.getJSON("GetJsonDemo.aspx", { Action: "action" }, function (data) {
            var txt = "";
            $.each(data, function (k, v) {
                $.each(v, function (m, n) {
                    txt += "id :" + n.id + ";name :" + n.name + ";sex :" + n.sex + "<br/>";
                });
            });
            $("#txt").html(txt);
        });
    });

    // 只看原始字串
    $("#btn2").click(function () {
        $.get("GetJsonDemo.aspx", { Action: "action" }, function (data) {
            $("#txt2").text(data);
        });
    });
});
</script>

這裡用雙層 $.each 是因為後端輸出的結構是 {"json":[{...},{...}]}:外層拿到 key 與陣列,內層才拿到每一筆物件。如果後端直接回傳陣列,一層 $.each 就夠了。

第二個按鈕刻意用 $.get 而非 $.getJSON,這樣拿到的是未經解析的原始字串,方便確認後端到底輸出了什麼——這在除錯時非常有用。

步驟四:後端輸出

private void JsonAjax()
{
    string action = Request["Action"];
    if (!string.IsNullOrEmpty(action) && action == "action")
    {
        string str = DataTableConvertJson.DataTableToJson(
            "json", Data.BindData().Tables[0]);
        Response.Write(str);
        Response.End();
    }
}

最終輸出的格式如下:

{"json":[{"id":"16","name":"zhaoliu","sex":"man"},
         {"id":"19","name":"zhangsan","sex":"women"}]}

實務上的幾點檢討

  • 請用專用的 Web 服務端點。把資料輸出寫在 aspx 的 Page_Load 裡並呼叫 Response.End(),是早期常見但脆弱的手法。改用 WebMethod、Web API 或 ashx 一般處理常式,能少掉整份頁面生命週期的負擔。
  • 設定正確的 Content-Type。輸出 JSON 時應加上 Response.ContentType = "application/json; charset=utf-8",否則中文編碼容易出問題。
  • 不要組字串,要用序列化器。如上所述,手刻 JSON 幾乎必然在跳脫與型別上出錯。
  • 用 $.each 時留意 this 的指向。若要保留外層變數,先存成區域變數或使用箭頭函數。
  • 渲染大量資料時改用 DOM 建立節點。用字串拼接 html() 時,若資料含使用者輸入內容,務必先做 HTML 編碼以防 XSS。
  • 新專案可直接用 fetch() 搭配 await response.json(),不必依賴 jQuery 的 Ajax 模組。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved