萬盛學電腦網

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

.NET JSON 序列化與反序列化完整指南:JavaScriptSerializer vs DataContractJsonSerializer vs System.Text.Json

三大序列化器比較

特性JavaScriptSerializerDataContractJsonSerializerSystem.Text.Json (.NET Core 3.0+)
命名空間System.Web.Script.SerializationSystem.Runtime.Serialization.JsonSystem.Text.Json
效能低 (反射、無優化)中 (契約快取)**高** (UTF-8 直接讀寫、Source Generator)
預設命名慣例PascalCase (屬性名不變)camelCase (DataMember Name)camelCase (可配置)
日期格式Microsoft 格式 `/Date(123)/`ISO 8601 `/Date(123)/`ISO 8601 `2023-01-01T00:00:00Z`
循環參考拋出例外拋出例外支援 `ReferenceHandler.Preserve`
多型/繼承不支援支援 `KnownType`支援 `JsonPolymorphism` (7.0+)
現代專案建議❌ 僅維舊系統⚠️ WCF 相容專案✅ **首選**

1. JavaScriptSerializer (舊專案維護用)


using System.Web.Script.Serialization;

public class Person { public int Id { get; set; } public string Name { get; set; } }

var person = new Person { Id = 1, Name = "小白" };
var serializer = new JavaScriptSerializer();

// 序列化
string json = serializer.Serialize(person); 
// {"Id":1,"Name":"小白"}

// 反序列化
Person p = serializer.Deserialize(json);

// 忽略屬性
public class Person { 
    [ScriptIgnore] public int Id { get; set; } 
    public string Name { get; set; } 
}
// 輸出: {"Name":"小白"}

2. DataContractJsonSerializer (WCF/舊版相容)


using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.IO;

[DataContract]
public class Person 
{
    [DataMember(Name = "id", Order = 1)] 
    public int Id { get; set; }
    
    [DataMember(Name = "name", Order = 2)]
    public string Name { get; set; }
    
    [IgnoreDataMember] // 不序列化
    public string InternalNote { get; set; }
}

var person = new Person { Id = 1, Name = "小白", InternalNote = "secret" };
var serializer = new DataContractJsonSerializer(typeof(Person));

// 序列化
string json;
using (var ms = new MemoryStream())
{
    serializer.WriteObject(ms, person);
    json = Encoding.UTF8.GetString(ms.ToArray());
}
// {"id":1,"name":"小白"}

// 反序列化
Person p;
using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(json)))
{
    p = (Person)serializer.ReadObject(ms);
}

3. System.Text.Json (現代標準,.NET Core 3.0+ / .NET 5+ 內建)


using System.Text.Json;
using System.Text.Json.Serialization;

public class Person 
{
    [JsonPropertyName("id")] 
    public int Id { get; set; }
    
    [JsonPropertyName("name")]
    public string Name { get; set; }
    
    [JsonIgnore] 
    public string InternalNote { get; set; }
    
    [JsonConverter(typeof(JsonStringEnumConverter))]
    public Status Status { get; set; }
}

var person = new Person { Id = 1, Name = "小白", Status = Status.Active };

// 序列化 (高效能、非同步)
string json = JsonSerializer.Serialize(person); 
// {"id":1,"name":"小白","status":"Active"}

// 反序列化
Person p = JsonSerializer.Deserialize(json);

// 進階選項
var options = new JsonSerializerOptions
{
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase, // 預設即為 CamelCase
    WriteIndented = true,                              // 格式化輸出
    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
    Converters = { new JsonStringEnumConverter() },
    ReferenceHandler = ReferenceHandler.Preserve       // 處理循環參考
};
string json2 = JsonSerializer.Serialize(person, options);

// 非同步串流 (適合大物件/高併發)
await using (var stream = File.Create("person.json"))
{
    await JsonSerializer.SerializeAsync(stream, person, options);
}

常見情境處理

日期時間格式統一


// System.Text.Json
var options = new JsonSerializerOptions
{
    Converters = { new JsonConverter() 
    {
        public override DateTime Read(ref Utf8JsonReader reader, Type type, JsonSerializerOptions options)
            => DateTime.Parse(reader.GetString()!);
        public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
            => writer.WriteStringValue(value.ToString("yyyy-MM-ddTHH:mm:ssZ"));
    }}
};

Dictionary 序列化 (Key 非字串)


// System.Text.Json 5.0+ 支援 Dictionary 直接序列化
var dict = new Dictionary { [1] = "一", [2] = "二" };
JsonSerializer.Serialize(dict); // {"1":"一","2":"二"}

動態物件 / 匿名類型


var data = new { Id = 1, Name = "測試", Items = new[] { "A", "B" } };
string json = JsonSerializer.Serialize(data); // 完美支援

效能基準參考 (100萬次序列化 Person 物件)

| 序列化器 | 平均耗時 | 記憶體配置 | |----------|----------|------------| | JavaScriptSerializer | ~450 ms | 高 | | DataContractJsonSerializer | ~180 ms | 中 | | **System.Text.Json** | **~45 ms** | **極低** | | System.Text.Json (Source Gen) | **~30 ms** | **極低** |

遷移建議

  1. **新專案**:直接使用 `System.Text.Json`,零相依、高效能、功能完整。
  2. **舊專案維護**:若已大量使用 `JavaScriptSerializer`,可維持現狀;新增功能模組建議引入 `System.Text.Json` (可透過 NuGet 安裝至 .NET Framework 4.7.2+)。
  3. **WCF 服務相容**:保留 `DataContractJsonSerializer` 於服務合約層,內部領域模型改用 `System.Text.Json`,邊界處轉換。
  4. **Source Generator** (.NET 6+):定義 `partial class` 實作 `JsonSerializable`,編譯期產生最佳化程式碼,再提升 30% 效能。

掌握三大序列化器差異與適用場景,能根據專案限制做出最佳技術選型,避免序列化成為效能瓶頸或相容性地雷。

copyright © 萬盛學電腦網 all rights reserved