MENU
  1. ホーム
  2. C#
  3. C#によるオブジェクトのシリアル化とデシリアル化を徹底解説

C#によるオブジェクトのシリアル化とデシリアル化を徹底解説

C#

C#でのオブジェクトのシリアル化とデシリアル化は、データの保存や通信において重要な役割を果たします。本記事では、シリアル化とデシリアル化の基本概念から、C#での具体的な実装方法、エラー処理や例外対策までを詳しく解説します。さらに、応用例や演習問題を通じて理解を深めることができます。

目次

シリアル化とデシリアル化の基本概念

シリアル化とは、オブジェクトの状態を保存や転送可能な形式（例えばバイト列や文字列）に変換するプロセスです。一方、デシリアル化は、シリアル化されたデータを元のオブジェクトに復元するプロセスです。これにより、プログラム間でオブジェクトの状態を簡単に共有したり、データをファイルやデータベースに保存したりすることが可能になります。

C#でのシリアル化の方法

C#では、シリアル化には主に標準ライブラリのSystem.Runtime.Serialization名前空間を使用します。これにより、オブジェクトをバイナリ、XML、JSONなどの形式にシリアル化することができます。シリアル化するためには、対象となるクラスにシリアル化可能な属性（[Serializable]）を付与する必要があります。さらに、より詳細な制御を行うために、ISerializableインターフェースを実装することもできます。

バイナリシリアル化の実装例

バイナリシリアル化は、オブジェクトをバイナリ形式に変換することで、高速かつ効率的にデータを保存および転送する方法です。C#では、BinaryFormatterクラスを使用してバイナリシリアル化を実現できます。以下に、バイナリシリアル化の実装例を示します。

バイナリシリアル化のコード例

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

[Serializable]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public class BinarySerializationExample
{
    public static void Main()
    {
        Person person = new Person() { Name = "John Doe", Age = 30 };

        // シリアル化
        BinaryFormatter formatter = new BinaryFormatter();
        using (FileStream stream = new FileStream("person.dat", FileMode.Create, FileAccess.Write))
        {
            formatter.Serialize(stream, person);
        }

        // デシリアル化
        using (FileStream stream = new FileStream("person.dat", FileMode.Open, FileAccess.Read))
        {
            Person deserializedPerson = (Person)formatter.Deserialize(stream);
            Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
        }
    }
}

この例では、Personクラスをバイナリ形式でシリアル化し、ファイルに保存しています。その後、ファイルからデシリアル化して、オブジェクトを復元しています。シリアル化とデシリアル化の操作は、それぞれSerializeメソッドとDeserializeメソッドで行います。

XMLシリアル化の実装例

XMLシリアル化は、オブジェクトをXML形式に変換することで、データの読みやすさと相互運用性を向上させます。C#では、XmlSerializerクラスを使用してXMLシリアル化を実現できます。以下に、XMLシリアル化の実装例を示します。

XMLシリアル化のコード例

using System;
using System.IO;
using System.Xml.Serialization;

[Serializable]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public class XmlSerializationExample
{
    public static void Main()
    {
        Person person = new Person() { Name = "Jane Doe", Age = 25 };

        // シリアル化
        XmlSerializer serializer = new XmlSerializer(typeof(Person));
        using (FileStream stream = new FileStream("person.xml", FileMode.Create, FileAccess.Write))
        {
            serializer.Serialize(stream, person);
        }

        // デシリアル化
        using (FileStream stream = new FileStream("person.xml", FileMode.Open, FileAccess.Read))
        {
            Person deserializedPerson = (Person)serializer.Deserialize(stream);
            Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
        }
    }
}

この例では、PersonクラスをXML形式でシリアル化し、ファイルに保存しています。その後、ファイルからデシリアル化して、オブジェクトを復元しています。シリアル化とデシリアル化の操作は、それぞれSerializeメソッドとDeserializeメソッドで行います。

JSONシリアル化の実装例

JSONシリアル化は、オブジェクトをJSON形式に変換することで、軽量かつ人間が読みやすい形式でデータを保存および転送する方法です。C#では、System.Text.Json名前空間のJsonSerializerクラスを使用してJSONシリアル化を実現できます。以下に、JSONシリアル化の実装例を示します。

JSONシリアル化のコード例

using System;
using System.Text.Json;
using System.IO;

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

public class JsonSerializationExample
{
    public static void Main()
    {
        Person person = new Person() { Name = "Alice Smith", Age = 28 };

        // シリアル化
        string jsonString = JsonSerializer.Serialize(person);
        File.WriteAllText("person.json", jsonString);

        // デシリアル化
        jsonString = File.ReadAllText("person.json");
        Person deserializedPerson = JsonSerializer.Deserialize<Person>(jsonString);
        Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
    }
}

この例では、PersonクラスをJSON形式でシリアル化し、ファイルに保存しています。その後、ファイルからJSONデータを読み込み、デシリアル化してオブジェクトを復元しています。シリアル化とデシリアル化の操作は、それぞれJsonSerializer.SerializeメソッドとJsonSerializer.Deserializeメソッドで行います。

カスタムシリアル化

カスタムシリアル化は、特定の要件に応じてオブジェクトのシリアル化プロセスを細かく制御する方法です。C#では、ISerializableインターフェースを実装することで、カスタムシリアル化を実現できます。これにより、通常のシリアル化プロセスではカバーできない特殊なケースに対応することができます。

カスタムシリアル化のコード例

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

[Serializable]
public class CustomPerson : ISerializable
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Secret { get; set; }

    public CustomPerson() { }

    // カスタムシリアル化コンストラクタ
    protected CustomPerson(SerializationInfo info, StreamingContext context)
    {
        Name = info.GetString("Name");
        Age = info.GetInt32("Age");
        // Secretはシリアル化しないため、復元しない
    }

    // ISerializableインターフェースの実装
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        info.AddValue("Name", Name);
        info.AddValue("Age", Age);
        // Secretはシリアル化しない
    }
}

public class CustomSerializationExample
{
    public static void Main()
    {
        CustomPerson person = new CustomPerson() { Name = "Bob Brown", Age = 40, Secret = "TopSecret" };

        // シリアル化
        BinaryFormatter formatter = new BinaryFormatter();
        using (FileStream stream = new FileStream("customPerson.dat", FileMode.Create, FileAccess.Write))
        {
            formatter.Serialize(stream, person);
        }

        // デシリアル化
        using (FileStream stream = new FileStream("customPerson.dat", FileMode.Open, FileAccess.Read))
        {
            CustomPerson deserializedPerson = (CustomPerson)formatter.Deserialize(stream);
            Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
            // Secretはシリアル化されていないため、nullまたはデフォルト値
        }
    }
}

この例では、CustomPersonクラスがISerializableインターフェースを実装しており、シリアル化とデシリアル化の過程で特定のフィールド（Secret）を除外しています。これにより、特定のデータをシリアル化から除外するなどのカスタム処理が可能です。

デシリアル化の実装例

デシリアル化は、シリアル化されたデータを元のオブジェクトに復元するプロセスです。C#では、各シリアル化形式に応じたデシリアル化方法が用意されています。ここでは、バイナリ、XML、およびJSONのデシリアル化の実装例を紹介します。

バイナリデシリアル化のコード例

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

[Serializable]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public class BinaryDeserializationExample
{
    public static void Main()
    {
        using (FileStream stream = new FileStream("person.dat", FileMode.Open, FileAccess.Read))
        {
            BinaryFormatter formatter = new BinaryFormatter();
            Person deserializedPerson = (Person)formatter.Deserialize(stream);
            Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
        }
    }
}

XMLデシリアル化のコード例

using System;
using System.IO;
using System.Xml.Serialization;

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

public class XmlDeserializationExample
{
    public static void Main()
    {
        using (FileStream stream = new FileStream("person.xml", FileMode.Open, FileAccess.Read))
        {
            XmlSerializer serializer = new XmlSerializer(typeof(Person));
            Person deserializedPerson = (Person)serializer.Deserialize(stream);
            Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
        }
    }
}

JSONデシリアル化のコード例

using System;
using System.Text.Json;
using System.IO;

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

public class JsonDeserializationExample
{
    public static void Main()
    {
        string jsonString = File.ReadAllText("person.json");
        Person deserializedPerson = JsonSerializer.Deserialize<Person>(jsonString);
        Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
    }
}

これらの例では、それぞれの形式でシリアル化されたデータをファイルから読み込み、元のオブジェクトに復元しています。バイナリ、XML、およびJSON形式のシリアル化およびデシリアル化を適切に使い分けることで、さまざまなシナリオに対応できます。

エラー処理と例外対策

シリアル化およびデシリアル化の過程でエラーが発生することがあります。これらのエラーに適切に対処するためには、エラーハンドリングと例外処理が重要です。以下に、一般的なエラーとその対処法について説明します。

一般的なエラーと例外

  • ファイルが見つからない: デシリアル化するファイルが存在しない場合、このエラーが発生します。
  • フォーマットの不一致: シリアル化されたデータのフォーマットが期待されるフォーマットと異なる場合、例外がスローされます。
  • アクセス権の問題: ファイルへのアクセス権が不足している場合、このエラーが発生します。

例外処理のコード例

以下に、バイナリデシリアル化の過程での例外処理の例を示します。

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

[Serializable]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public class BinaryDeserializationWithExceptionHandling
{
    public static void Main()
    {
        try
        {
            using (FileStream stream = new FileStream("person.dat", FileMode.Open, FileAccess.Read))
            {
                BinaryFormatter formatter = new BinaryFormatter();
                Person deserializedPerson = (Person)formatter.Deserialize(stream);
                Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
            }
        }
        catch (FileNotFoundException ex)
        {
            Console.WriteLine("Error: The file was not found.");
            Console.WriteLine(ex.Message);
        }
        catch (SerializationException ex)
        {
            Console.WriteLine("Error: Deserialization failed.");
            Console.WriteLine(ex.Message);
        }
        catch (UnauthorizedAccessException ex)
        {
            Console.WriteLine("Error: Access to the file is denied.");
            Console.WriteLine(ex.Message);
        }
        catch (Exception ex)
        {
            Console.WriteLine("An unexpected error occurred.");
            Console.WriteLine(ex.Message);
        }
    }
}

この例では、FileNotFoundException、SerializationException、UnauthorizedAccessExceptionなどの一般的な例外をキャッチして適切に処理しています。また、予期しないエラーが発生した場合にも対応するため、一般的なExceptionもキャッチしています。

応用例と演習問題

シリアル化とデシリアル化の基礎を理解したら、実際のプロジェクトでの応用例や演習問題を通じてさらに理解を深めましょう。ここでは、実際のプロジェクトでの使用例と、シリアル化とデシリアル化に関する演習問題を紹介します。

応用例

  1. 設定ファイルの管理: アプリケーションの設定をJSON形式でシリアル化し、ファイルとして保存することで、設定の永続化と再利用が可能になります。
  2. データのキャッシュ: 頻繁にアクセスされるデータをバイナリ形式でキャッシュし、高速なデータ読み書きを実現します。
  3. データの通信: オブジェクトをXML形式でシリアル化し、Webサービス間でデータを交換することで、互換性の高いデータ通信を実現します。

演習問題

  1. 演習1: JSONシリアル化とデシリアル化
    • クラスProductを作成し、プロパティNameとPriceを定義します。
    • このクラスのオブジェクトをJSON形式でシリアル化し、ファイルに保存します。
    • ファイルからデシリアル化して、元のProductオブジェクトを復元します。
    public class Product { public string Name { get; set; } public decimal Price { get; set; } } // シリアル化とデシリアル化のコードを実装してください
  2. 演習2: XMLシリアル化とデシリアル化
    • クラスOrderを作成し、プロパティOrderIdとOrderDateを定義します。
    • このクラスのオブジェクトをXML形式でシリアル化し、ファイルに保存します。
    • ファイルからデシリアル化して、元のOrderオブジェクトを復元します。
    public class Order { public int OrderId { get; set; } public DateTime OrderDate { get; set; } } // シリアル化とデシリアル化のコードを実装してください
  3. 演習3: カスタムシリアル化
    • クラスEmployeeを作成し、プロパティNameとSalaryを定義します。
    • ISerializableインターフェースを実装し、Salaryプロパティをシリアル化から除外します。
    • このクラスのオブジェクトをバイナリ形式でシリアル化し、ファイルに保存します。
    • ファイルからデシリアル化して、元のEmployeeオブジェクトを復元します。
    [Serializable] public class Employee : ISerializable { public string Name { get; set; } public decimal Salary { get; set; }// カスタムシリアル化のコードを実装してください}

これらの応用例と演習問題を通じて、シリアル化とデシリアル化の技術を実践的に学び、さまざまな場面で応用できるスキルを身につけてください。

まとめ

本記事では、C#によるオブジェクトのシリアル化とデシリアル化の基本概念から具体的な実装方法、カスタムシリアル化、エラー処理、応用例までを詳細に解説しました。シリアル化とデシリアル化は、データの保存、通信、設定管理など、多くの場面で役立つ重要な技術です。提供したコード例や演習問題を通じて、実践的なスキルを身につけ、さまざまなプロジェクトで活用してください。

C#
プログラミング JSON バイナリ XML C# シリアル化 デシリアル化

コメント

コメントする

目次