C# 完整的 E142 類別序列化與反序列化實現

全面解析 E142 類別在 C# 中的序列化與反序列化技術

C%23+serialization+object+transformation

主要要點

多種序列化方法：介紹 JSON 和 BinaryFormatter 的應用場景與實現方式。
安全性考量：探討不同序列化方法的安全風險及其應對策略。
最佳實踐：提供高效、可維護的序列化與反序列化代碼示例。

序列化與反序列化概述

在軟體開發中，序列化（Serialization）是一種將物件轉換為可儲存或傳輸格式的過程，而反序列化（Deserialization）則是將這些格式轉換回原始物件的過程。這在分散式系統、資料儲存、遠端通訊等場景中尤為重要。

E142 類別定義

E142 類別是我們在這個範例中用來演示序列化與反序列化的核心類別。以下是其完整的定義：


// E142 類別定義
public class E142
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
}

此類別包含三個屬性：Id（整數類型）、Name（字符串類型）和Date（日期時間類型）。這些屬性將在序列化與反序列化過程中被轉換和恢復。

使用 JSON 進行序列化與反序列化

JSON（JavaScript Object Notation）是一種輕量級的數據交換格式，易於人閱讀和編寫，同時也易於機器解析和生成。在 .NET 中，System.Text.Json 命名空間提供了高效的 JSON 處理功能。

序列化成 JSON 字串

以下代碼示例展示了如何將 E142 類別的實例序列化為 JSON 字串：


using System;
using System.Text.Json;

public class Program
{
    public static void Main()
    {
        // 創建 E142 類別的實例
        var e142 = new E142
        {
            Id = 1,
            Name = "範例物件",
            Date = DateTime.Now
        };

        // 序列化物件為 JSON 字串
        string jsonString = JsonSerializer.Serialize(e142);
        Console.WriteLine("序列化後的 JSON:");
        Console.WriteLine(jsonString);
    }
}

執行上述程式後，將輸出類似以下的 JSON 字串：


序列化後的 JSON:
{"Id":1,"Name":"範例物件","Date":"2025-01-23T12:34:56.789Z"}

反序列化回 E142 物件

使用 JsonSerializer.Deserialize 方法，可以將 JSON 字串轉換回 E142 類別的實例：


using System;
using System.Text.Json;

public class Program
{
    public static void Main()
    {
        string jsonString = "{\"Id\":1,\"Name\":\"範例物件\",\"Date\":\"2025-01-23T12:34:56.789Z\"}";

        // 反序列化 JSON 字串為 E142 物件
        E142 deserializedE142 = JsonSerializer.Deserialize<E142>(jsonString);
        Console.WriteLine("\n反序列化後的 E142 物件:");
        Console.WriteLine($"Id: {deserializedE142.Id}, Name: {deserializedE142.Name}, Date: {deserializedE142.Date}");
    }
}

輸出結果將顯示反序列化後的物件屬性值：


反序列化後的 E142 物件:
Id: 1, Name: 範例物件, Date: 1/23/2025 12:34:56 PM

使用 BinaryFormatter 進行序列化與反序列化

BinaryFormatter 是 .NET 中傳統的序列化方法，能夠將物件序列化為二進位格式。然而，出於安全性考量，BinaryFormatter 在處理不受信任的數據時存在風險，微軟建議在新開發中避免使用。

定義可序列化的類別

為了使用 BinaryFormatter，類別必須標記為[Serializable]：


using System;
using System.Runtime.Serialization;

[Serializable]
public class E142
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
}

序列化成二進位數據

以下代碼展示了如何使用 BinaryFormatter 將 E142 物件序列化為二進位數據：


using System;
using System.IO;
using System.Runtime.Serialization.Formatters.Binary;

public class Program
{
    public static void Main()
    {
        E142 e142 = new E142
        {
            Id = 1,
            Name = "範例物件",
            Date = DateTime.Now
        };

        // 序列化物件為二進位數據
        byte[] serializedData = Serialize(e142);
        Console.WriteLine("序列化後的二進位數據: " + BitConverter.ToString(serializedData));
    }

    static byte[] Serialize(E142 obj)
    {
        using (MemoryStream stream = new MemoryStream())
        {
            BinaryFormatter formatter = new BinaryFormatter();
            formatter.Serialize(stream, obj);
            return stream.ToArray();
        }
    }
}

反序列化回 E142 物件

使用 BinaryFormatter，可以將二進位數據反序列化回 E142 物件：


using System;
using System.IO;
using System.Runtime.Serialization.Formatters.Binary;

public class Program
{
    public static void Main()
    {
        byte[] serializedData = /* 二進位數據源 */;
        
        // 反序列化二進位數據為 E142 物件
        E142 deserializedE142 = Deserialize(serializedData);
        Console.WriteLine("反序列化後的 E142 物件:");
        Console.WriteLine($"Id: {deserializedE142.Id}, Name: {deserializedE142.Name}, Date: {deserializedE142.Date}");
    }

    static E142 Deserialize(byte[] data)
    {
        using (MemoryStream stream = new MemoryStream(data))
        {
            BinaryFormatter formatter = new BinaryFormatter();
            return (E142)formatter.Deserialize(stream);
        }
    }
}

注意：BinaryFormatter 存在安全風險，特別是在處理來自不受信任來源的數據時，因此在新項目中建議使用其他序列化方法，如 JSON 或 Protobuf。

序列化與反序列化的比較

不同的序列化方法各有優缺點，以下表格比較了 JSON 和 BinaryFormatter 的特性：

特性	JSON 序列化	BinaryFormatter 序列化
可讀性	高，易於人類閱讀和編寫	低，為二進位格式
性能	高效，特別適合網路傳輸	較高效，但受限於安全性
安全性	較高，尤其在使用嚴格的反序列化設定時	低，存在反序列化攻擊風險
跨平台支持	優秀，廣泛支持各種平台和語言	局限於 .NET 環境
資料大小	較小，適合網絡傳輸	視資料而定，但通常較大

最佳實踐與安全性考量

在實現序列化與反序列化時，遵循最佳實踐能夠提升應用程序的效率和安全性。

選擇合適的序列化方法

根據應用場景選擇合適的序列化方法是關鍵。例如，若需要跨平台支持和人類可讀性，JSON 是理想選擇；而如果性能和儲存效率更為重要，則可以考慮其他二進位序列化方法，如 Protobuf。

處理敏感數據

在序列化過程中，應避免在數據中包含敏感信息，或採用加密技術保護數據。另外，反序列化時應嚴格驗證輸入數據，以防範反序列化攻擊。

使用異常處理

序列化與反序列化過程中可能會發生各種異常，如數據格式錯誤、類型不匹配等。應使用 try-catch 塊來捕獲並妥善處理這些異常，確保應用程序的穩定性。

優化序列化性能

對於大型物件或高頻次的序列化操作，可以採用以下方法優化性能：

使用緩存：重複使用序列化器實例，避免頻繁創建新的實例。
精簡物件結構：僅序列化必要的屬性，減少數據量。
選擇高效的序列化格式：如 BinaryFormatter 或 Protobuf。

示範完整的實作範例

綜合上述內容，以下是一個完整的實作範例，展示如何在 C# 中對 E142 類別進行序列化與反序列化，包括 JSON 和 BinaryFormatter 方法：


// 定義可序列化的 E142 類別
[Serializable]
public class E142
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
}

public class E142Serializer
{
    // JSON 序列化方法
    public static string SerializeToJson(E142 obj)
    {
        return JsonSerializer.Serialize(obj);
    }
    
    // JSON 反序列化方法
    public static E142 DeserializeFromJson(string jsonString)
    {
        return JsonSerializer.Deserialize<E142>(jsonString);
    }

    // BinaryFormatter 序列化方法
    public static byte[] SerializeToBinary(E142 obj)
    {
        using (MemoryStream stream = new MemoryStream())
        {
            BinaryFormatter formatter = new BinaryFormatter();
            formatter.Serialize(stream, obj);
            return stream.ToArray();
        }
    }

    // BinaryFormatter 反序列化方法
    public static E142 DeserializeFromBinary(byte[] data)
    {
        using (MemoryStream stream = new MemoryStream(data))
        {
            BinaryFormatter formatter = new BinaryFormatter();
            return (E142)formatter.Deserialize(stream);
        }
    }
}

public class Program
{
    public static void Main()
    {
        // 創建 E142 物件
        E142 e142 = new E142
        {
            Id = 1,
            Name = "綜合範例物件",
            Date = DateTime.Now
        };

        // JSON 序列化
        string jsonString = E142Serializer.SerializeToJson(e142);
        Console.WriteLine("JSON 序列化後的結果:");
        Console.WriteLine(jsonString);

        // JSON 反序列化
        E142 deserializedJson = E142Serializer.DeserializeFromJson(jsonString);
        Console.WriteLine("\nJSON 反序列化後的物件:");
        Console.WriteLine($"Id: {deserializedJson.Id}, Name: {deserializedJson.Name}, Date: {deserializedJson.Date}");

        // BinaryFormatter 序列化
        byte[] binaryData = E142Serializer.SerializeToBinary(e142);
        Console.WriteLine("\nBinaryFormatter 序列化後的二進位數據:");
        Console.WriteLine(BitConverter.ToString(binaryData));

        // BinaryFormatter 反序列化
        E142 deserializedBinary = E142Serializer.DeserializeFromBinary(binaryData);
        Console.WriteLine("\nBinaryFormatter 反序列化後的物件:");
        Console.WriteLine($"Id: {deserializedBinary.Id}, Name: {deserializedBinary.Name}, Date: {deserializedBinary.Date}");
    }
}

這段程式碼展示了如何同時使用 JSON 和 BinaryFormatter 進行序列化與反序列化操作。實際運行時，將看到序列化後的 JSON 字串、二進位數據以及反序列化後的物件屬性值。

常見問題解答

1. 為什麼選擇 JSON 而不是 BinaryFormatter？

JSON 提供了更好的可讀性和廣泛的跨平台支持，適合用於網路傳輸和儲存數據。此外，JSON 在安全性方面比 BinaryFormatter 更為穩健，特別是在反序列化時能更好地防範惡意數據。

2. 如何處理序列化過程中的異常情況？

在序列化與反序列化過程中，應使用 try-catch 塊來捕獲並處理可能出現的異常。這包括數據格式錯誤、類型不匹配等情況。例如：


try
{
    // JSON 反序列化
    E142 obj = E142Serializer.DeserializeFromJson(jsonString);
}
catch (JsonException ex)
{
    Console.WriteLine($"JSON 反序列化錯誤: {ex.Message}");
}
catch (Exception ex)
{
    Console.WriteLine($"一般錯誤: {ex.Message}");
}

3. 如何自訂序列化選項，如日期格式？

在使用 JsonSerializer 進行序列化時，可以通過 JsonSerializerOptions 來自訂序列化行為。例如，設置日期格式：


var options = new JsonSerializerOptions
{
    WriteIndented = true,
    Converters =
    {
        new JsonStringEnumConverter(),
        new DateTimeConverter("yyyy-MM-dd HH:mm:ss")
    }
};

string jsonString = JsonSerializer.Serialize(e142, options);

需要注意的是，可能需要實現自訂的 JsonConverter 來支持特定的日期格式。

4. BinaryFormatter 是否仍被建議使用？

不建議在新的開發中使用 BinaryFormatter，因為它存在安全風險，特別是在處理來自不受信任來源的數據時。建議使用更安全的序列化方法，如 JSON (使用 System.Text.Json) 或 Protobuf 等。

擴展資源

以下是一些有用的資源，可以幫助您更深入理解序列化與反序列化在 C# 中的應用：

這些資源提供了更多關於序列化技術的詳細信息和實踐指南，適合進一步學習和參考。

結論

序列化與反序列化是現代軟體開發中不可或缺的技術，特別是在數據傳輸和儲存方面。選擇合適的序列化方法，並遵循最佳實踐，能夠確保應用程序的性能、安全性和可維護性。本指南通過全面的範例和詳細的解釋，展示了如何在 C# 中對 E142 類別進行有效的序列化與反序列化操作，期望能夠對您的開發工作提供實質性的幫助。

參考資料

learn.microsoft.com

Serialize and deserialize JSON using C# - .NET | Microsoft Learn

medium.com

How to Implement Serialization and Deserialization in C# - Medium

dev.to

Serialization and Deserialization in C#: A Comprehensive Guide

learn.microsoft.com

BinaryFormatter Security Guide - Microsoft Learn

Last updated January 23, 2025