本文將重點說明 JSON 資料格式的相關內容與實作方式。隨著 JSON 的不斷演進,編程技巧也衍生出多樣形式,而在處理這類輕量級資料交換格式時,有幾個環節特別值得留意。
這次的工作目標,是把某份資料解析成 .NET 可以使用的形式。由於返回的資料除了 header 之外其餘部分都是可變的——也就是說結構並非固定,完全由使用者自行選擇,因此我們決定動態生成 DataTable 來承載這些資料。
核心做法是利用 .NET 內建的 JavaScriptSerializer 進行反序列化,把 JSON 文字拆解為字典結構,再逐步組裝成強型別的結果物件。以下展示 GeneralSearchResult 類別的實作:
using System;
using System.Collections.Generic;
using System.Text;
using System.Data;
using System.Web.Script.Serialization;
namespace Tencent.Itil.Cmsi.Common
{
public class GeneralSearchResult
{
public Header header = new Header();
private DataTable fIEldDefine = new DataTable();
/// <summary>
/// 返回的資料結構定義,無資料
/// </summary>
public DataTable FIEldDefine
{
get { return fIEldDefine; }
set { fIEldDefine = value; }
}
private DataTable retrunData = new DataTable();
/// <summary>
/// 返回的資料,格式為 DataTable,結構和 FIEldDefine 中的結構一樣
/// </summary>
public DataTable RetrunData
{
get { return retrunData; }
set { retrunData = value; }
}
/// <summary>
/// 將 JSON 資料轉換為定義好的物件,資料轉換為 DataTable
/// </summary>
/// <param name="JsonText"></param>
/// <returns></returns>
public static GeneralSearchResult GetTransformData(string JsonText)
{
GeneralSearchResult gsr = new GeneralSearchResult();
JavaScriptSerializer s = new JavaScriptSerializer();
Dictionary<string, object> jsonData =
(Dictionary<string, object>)s.DeserializeObject(JsonText);
Dictionary<string, object> dataSet =
(Dictionary<string, object>)jsonData["dataSet"];
Dictionary<string, object> header =
(Dictionary<string, object>)dataSet["header"];
gsr.header.Version = header["version"].ToString();
gsr.header.ErrorInfo = header["errorInfo"].ToString();
gsr.header.ReturnCode = header["returnCode"].ToString();
gsr.header.ReturnRows = Convert.ToInt16(header["returnRows"]);
gsr.header.TotalRows = Convert.ToInt16(header["totalRows"]);
Dictionary<string, object> dicFIEldDefine =
(Dictionary<string, object>)dataSet["fIEldDefine"];
foreach (KeyValuePair<string, object> ss in dicFIEldDefine)
{
gsr.FIEldDefine.Columns.Add(ss.Key, typeof(string));
}
// ... 其餘資料行的組裝略
return gsr;
}
}
}
完成類別設計後,使用起來就非常直觀:
GeneralSearchResult gsr = new GeneralSearchResult();
gsr = GeneralSearchResult.GetTransformData(text);
透過這種「先反序列化為字典、再動態映射為 DataTable」的策略,即使返回結構隨使用者選擇而變化,也能彈性地完成 JSON 資料格式到強型別物件的轉換。