DIV CSS 佈局教程網

C# 中 JSON 序列化與反序列化的實作解析
編輯:JavaScript綜合知識     

前後端資料交換幾乎離不開 JSON。.NET 內建的 DataContractJsonSerializer 就能勝任序列化與反序列化,不必額外拉第三方套件。本文用兩個擴充方法把流程包乾淨,再示範一次完整的 GET / POST 往返。

兩個擴充方法

序列化:把物件寫進 MemoryStream,再以 UTF-8 還原成字串送往前端。

/// <summary>
/// Json 序列化,用於發送到客戶端
/// </summary>
public static string ToJsJson(this object item)
{
    DataContractJsonSerializer serializer =
        new DataContractJsonSerializer(item.GetType());
    using (MemoryStream ms = new MemoryStream())
    {
        serializer.WriteObject(ms, item);
        StringBuilder sb = new StringBuilder();
        sb.Append(Encoding.UTF8.GetString(ms.ToArray()));
        return sb.ToString();
    }
}

反序列化:泛型版本,把字串還原成指定型別的物件。

/// <summary>
/// Json 反序列化,用於接收客戶端 Json 後生成對應的物件
/// </summary>
public static T FromJsonTo<T>(this string jsonString)
{
    DataContractJsonSerializer ser =
        new DataContractJsonSerializer(typeof(T));
    MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(jsonString));
    T jsonObject = (T)ser.ReadObject(ms);
    ms.Close();
    return jsonObject;
}

資料契約類別

要能被序列化,類別與屬性都必須掛上 DataContract / DataMember:

[DataContract]
public class TestObj
{
    [DataMember] public string make { get; set; }
    [DataMember] public string model { get; set; }
    [DataMember] public int year { get; set; }
    [DataMember] public string color { get; set; }
}

方向一:後端吐 JSON 給前端

用 ashx 泛型處理常式實作,把物件序列化後直接寫回 Response:

public class getJsonHandler : IHttpHandler
{
    public void ProcessRequest(HttpContext context)
    {
        TestObj obj = new TestObj();
        obj.make = "Make is Value";
        obj.model = "Model is Value";
        obj.year = 999;
        obj.color = "Color is Value";
        context.Response.Write(obj.ToJsJson());
    }

    public bool IsReusable { get { return false; } }
}
// 輸出:{"color":"Color is Value","make":"Make is Value","model":"Model is Value","year":999}

前端用 $.ajax 指定 dataType: 'json',成功回呼中就能直接以點號取值:

$('#getJson').click(function() {
    $.ajax({
        url: "getJsonHandler.ashx",
        type: 'GET',
        data: {},
        dataType: 'json',
        timeout: 1000,
        error: function(XMLHttpRequest, textStatus, errorThrown) {
            alert(textStatus)
        },
        success: function(result) {
            alert(result.make);
            alert(result.model);
            alert(result.year);
            alert(result.color);
        }
    });
});

方向二:前端送 JSON 給後端

前端先組出物件,再用 JSON.stringify(或 json2.js)轉成字串送出:

$('#postJson').click(function() {
    var m_obj = { make: "Dodge", model: "Coronet R/T", year: 1968, color: "yellow" };
    var jsonStr = JSON.stringify(m_obj);
    $.ajax({
        url: "postJsonHandler.ashx",
        type: 'POST',
        data: { postjson: jsonStr },
        dataType: 'json',
        timeout: 1000,
        error: function(XMLHttpRequest, textStatus, errorThrown) {
            alert(textStatus)
        },
        success: function(result) {
            alert(result.success);
        }
    });
});

後端取回字串、反序列化,再進行欄位驗證:

public class postJsonHandler : IHttpHandler
{
    public void ProcessRequest(HttpContext context)
    {
        string jsonStr = context.Request["postjson"];
        TestObj obj = jsonStr.FromJsonTo<TestObj>();

        if (string.IsNullOrEmpty(obj.make) || string.IsNullOrEmpty(obj.model)
            || string.IsNullOrEmpty(obj.color) || obj.year < 0)
        {
            context.Response.Write("{success:false}");
        }
        else
        {
            context.Response.Write("{success:true}");
        }
    }

    public bool IsReusable { get { return false; } }
}

兩個實務上的地雷

第一,後端若手動拼接 JSON 字串,字串值一定要用雙引號包住,否則前端解析必然失敗。第二,依名稱對應賦值意味著多一個或少一個欄位都不會報錯,反而容易留下安靜的錯誤,值得在後端補上驗證。

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