萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

.NET DataSet/DataTable 轉 JSON 輸出:手工序列化與 Json.NET 現代化最佳實踐

手工序列化實作 (無第三方相依)

using System;
using System.Data;
using System.Text;

public class JsonUtil
{
    // DataSet → JSON { "TableName": [ {col:val}, ... ], ... }
    public string ToJson(DataSet ds)
    {
        if (ds == null || ds.Tables.Count == 0) return "{}";

        var sb = new StringBuilder("{");
        foreach (DataTable dt in ds.Tables)
        {
            sb.Append($"\"{dt.TableName}\":");
            sb.Append(ToJson(dt));
            sb.Append(",");
        }
        if (sb[sb.Length - 1] == ',') sb.Length--; // 移除尾逗號
        sb.Append("}");
        return sb.ToString();
    }

    // DataTable → JSON [ {col:val}, ... ]
    public string ToJson(DataTable dt)
    {
        if (dt == null || dt.Rows.Count == 0) return "[]";

        var sb = new StringBuilder("[");
        foreach (DataRow row in dt.Rows)
        {
            sb.Append("{");
            for (int c = 0; c < dt.Columns.Count; c++)
            {
                string colName = dt.Columns[c].ColumnName;
                object val = row[c];
                string jsonVal = FormatJsonValue(val, dt.Columns[c].DataType);
                sb.Append($"\"{JsonEscape(colName)}\":{jsonVal},");
            }
            if (sb[sb.Length - 1] == ',') sb.Length--;
            sb.Append("},");
        }
        if (sb[sb.Length - 1] == ',') sb.Length--;
        sb.Append("]");
        return sb.ToString();
    }

    private string FormatJsonValue(object value, Type type)
    {
        if (value == null || value == DBNull.Value) return "null";

        // 字串、日期、Guid、Enum → 加雙引號並跳脫
        if (type == typeof(string) || type == typeof(DateTime) || type == typeof(Guid) || type.IsEnum)
            return $"\"{JsonEscape(value.ToString())}\"";

        // 布林值
        if (type == typeof(bool))
            return (bool)value ? "true" : "false";

        // 數值型別 (int, long, float, double, decimal 等)
        return value.ToString(); // 依賴 CurrentCulture,建議用 InvariantCulture
    }

    private string JsonEscape(string s)
    {
        return s.Replace("\\", "\\\\")
                .Replace("\"", "\\\"")
                .Replace("\n", "\\n")
                .Replace("\r", "\\r")
                .Replace("\t", "\\t")
                .Replace("\b", "\\b")
                .Replace("\f", "\\f");
    }
}

使用方式

var util = new JsonUtil();
Response.ContentType = "application/json; charset=utf-8";
Response.Write(util.ToJson(myDataSet));

現代化首選:Newtonsoft.Json (Json.NET)

// NuGet: Install-Package Newtonsoft.Json
using Newtonsoft.Json;

string json = JsonConvert.SerializeObject(dataSet, Formatting.Indented, 
    new JsonSerializerSettings
    {
        NullValueHandling = NullValueHandling.Include,
        DateFormatString = "yyyy-MM-ddTHH:mm:ss",
        ContractResolver = new DefaultContractResolver { NamingStrategy = new CamelCaseNamingStrategy() }
    });

Response.Write(json);

ASP.NET Core / .NET 5+ 內建 System.Text.Json

using System.Text.Json;

var options = new JsonSerializerOptions
{
    WriteIndented = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};

string json = JsonSerializer.Serialize(dataSet, options); // DataSet 需 .NET 6+ 支援,或先轉 List
Response.Write(json);

效能與功能比較

特性手工 StringBuilderNewtonsoft.JsonSystem.Text.Json
效能低 (大量字串操作、無快取)高 (表達式樹快取、流式寫入)極高 (Span-based、零複製、UTF-8 直接輸出)
日期格式手動控制豐富設定ISO 8601 預設,可自訂
循環參考需自行處理ReferenceLoopHandlingReferenceHandler.Preserve
DataTable/DataSet 直接支援需自行實作完美支援.NET 6+ 完整支援
依賴無NuGet 套件內建 (Core/5+)

常見陷阱與修正

  • DataTable 序列化為物件陣列而非字典:`JsonConvert.SerializeObject(dt)` 產生 `[{"Col1":"Val1","Col2":"Val2"}, ...]`,符合前端表格元件預期格式。
  • 日期時區:`DateTime.Kind` 影響序列化結果,建議統一使用 UTC (`DateTime.UtcNow`) 或 `DateTimeOffset`。
  • 循環參考:實體類別雙向導航屬性會導致無限遞迴,設定 `ReferenceLoopHandling.Ignore` 或使用 DTO 斷開循環。
  • 大小寫一致性:前端 JS 慣用 camelCase,後端 PascalCase,配置 `CamelCaseNamingStrategy` 或 `JsonNamingPolicy.CamelCase` 自動轉換。

總結

手工序列化適合**零相依、極簡、資料量小、格式固定**的舊專案維護。所有新專案、高效能需求、複雜物件圖、標準化 API 開發,**請直接使用 Newtonsoft.Json 或 System.Text.Json**,獲得更佳效能、正確性、擴充性與維護性。

copyright © 萬盛學電腦網 all rights reserved