読み込み中...

初心者でも簡単！C#でシリアライズをマスターする7つのステップ

C#におけるシリアライズの基本と応用を解説する記事のサムネイル C#
2023.12.14
この記事は約13分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

本記事のサンプルコードを活用して機能追加、目的を達成できるように作ってありますので、是非ご活用ください。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を満たす現役のプログラマチームによって監修されています。

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

この記事を読めば、C#でのシリアライズを理解し、実際に活用できるようになります。

シリアライズはデータを簡単かつ効率的に扱うための重要なプロセスです。

この記事では、C#におけるシリアライズの基本から応用まで、初心者にもわかりやすく解説します。

理論的な解説のほかに、実際のサンプルコードも交えて紹介しますので、理解を深めることができます。

●C#とシリアライズの基本

C#は、マイクロソフトが開発した汎用プログラミング言語です。

Windowsアプリケーションの開発に広く用いられており、その強力な機能と使いやすさから多くの開発者に支持されています。

C#は、オブジェクト指向プログラミングを採用しており、コードの再利用性やメンテナンスの容易さが特徴です。

○C#とは何か？

C#は、強力な型付け、オブジェクト指向、そして豊富なライブラリを備えています。

これらの特性は、C#を使って複雑なアプリケーションを効率的に開発するのに役立ちます。

C#は.NET Framework上で動作し、グラフィカルなウィンドウアプリケーション、ウェブアプリケーション、さらにはモバイルアプリケーションの開発にも適しています。

○シリアライズとは何か？

シリアライズは、オブジェクトの状態をバイト列に変換するプロセスです。

このプロセスにより、オブジェクトはファイルに保存したり、ネットワーク越しに送信したりすることが可能になります。

逆のプロセスであるデシリアライズでは、バイト列から元のオブジェクトの状態を復元します。

C#では、シリアライズとデシリアライズのプロセスがシンプルかつ効率的に行えるように設計されています。

●シリアライズの基本概念

シリアライズは、オブジェクトをバイト列に変換し、ファイルやネットワークを通じて保存や送信が可能になるプロセスです。

このプロセスは、データの持続性と移動性を実現するために不可欠です。

シリアライズによって、オブジェクトは簡単にデータストリームに変換され、異なるシステム間やアプリケーション間で簡単に転送されます。

オブジェクトのシリアライズは、そのプロパティ、フィールド、状態を含むすべての情報を取り込みます。

シリアライズされたデータは、テキスト形式（例えばXML、JSON）やバイナリ形式で保存されることがあります。

これにより、異なるプラットフォーム間でのデータの互換性が保たれ、アプリケーションの拡張性が向上します。

○データのシリアライズとデシリアライズ

データのシリアライズは、オブジェクトをバイト列に変換するプロセスであり、デシリアライズはその逆プロセスです。

デシリアライズにより、バイト列は元のオブジェクトの状態に戻されます。

この二つのプロセスは、データの保存と復元、データの転送と受信に不可欠です。

例えば、ウェブアプリケーションでは、クライアントとサーバー間でデータをやり取りする際にシリアライズが頻繁に用いられます。

○C#におけるシリアライズの役割

C#では、シリアライズが特に重要な役割を果たします。

C#には、データのシリアライズとデシリアライズを簡単に行うための多くの機能が組み込まれています。

例えば、.NETフレームワークは、XmlSerializer、DataContractSerializer、BinaryFormatterといった多様なシリアライザを提供します。

これにより、開発者はオブジェクトを簡単にシリアライズし、ファイルシステムやデータベース、ネットワーク越しにオブジェクトを送信できます。

●C#でのシリアライズの基本手順

C#におけるシリアライズのプロセスは、いくつかの明確なステップを経て行われます。

これらのステップを理解し、適切に実装することで、データのシリアライズを効率的かつ正確に行うことができます。

基本的に、シリアライズするオブジェクトを準備し、適切なシリアライザを選択して、そのオブジェクトをシリアライズし、最後にシリアライズされたデータを保存または転送します。

○サンプルコード1：オブジェクトをシリアライズする

まずは、シリアライズするオブジェクトを準備します。

ここでは、簡単なPersonクラスのインスタンスを作成し、それをシリアライズする方法を紹介します。

Personクラスは、名前（Name）と年齢（Age）の二つのプロパティを持つとします。

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

Person person = new Person { Name = "Taro", Age = 30 };

このコードでは、PersonクラスにSerializable属性を付け、シリアライズ可能なオブジェクトであることを示しています。

次に、Personクラスのインスタンスを作成し、名前と年齢を設定します。

続いて、このオブジェクトをシリアライズする必要があります。

C#では、BinaryFormatterやXmlSerializerなど、様々なシリアライザが利用可能です。

下記のコードは、BinaryFormatterを使用してPersonオブジェクトをシリアライズする例を表しています。

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

BinaryFormatter formatter = new BinaryFormatter();
using (FileStream stream = new FileStream("person.dat", FileMode.Create))
{
    formatter.Serialize(stream, person);
}

このコードでは、BinaryFormatterを使ってPersonオブジェクトをバイナリ形式でシリアライズし、person.datファイルに保存しています。

このプロセスを通じて、オブジェクトの状態はバイト列に変換され、ファイルシステムに永続的に保存されることになります。

○サンプルコード2：シリアライズしたデータをデシリアライズする

シリアライズされたデータを元のオブジェクトに戻すには、デシリアライズのプロセスを行う必要があります。

下記のコードは、先ほどのperson.datファイルからデータを読み込み、デシリアライズして元のPersonオブジェクトを復元する方法を表しています。

using (FileStream stream = new FileStream("person.dat", FileMode.Open))
{
    Person deserializedPerson = (Person)formatter.Deserialize(stream);
    Console.WriteLine($"Name: {deserializedPerson.Name}, Age: {deserializedPerson.Age}");
}

このコードでは、FileStreamを使ってperson.datファイルを開き、BinaryFormatterのDeserializeメソッドを用いてデータをデシリアライズしています。

デシリアライズされたオブジェクトはPerson型にキャストされ、そのプロパティの値がコンソールに出力されます。

●シリアライズの応用例

シリアライズは、C#プログラミングにおいて多様な形で活用されます。

基本的なシリアライズのプロセスを理解した後、様々なフォーマットや用途でのシリアライズの応用を探ることが重要です。

XML形式でのシリアライズ、JSON形式でのシリアライズ、そしてバイナリ形式でのシリアライズは、それぞれ異なるシナリオやニーズに合わせて選択されます。

○サンプルコード3：XML形式でのシリアライズ

XML形式のシリアライズは、データの可読性と柔軟性を提供します。

下記のサンプルコードは、PersonオブジェクトをXML形式でシリアライズする方法を表しています。

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

XmlSerializer xmlSerializer = new XmlSerializer(typeof(Person));
using (StreamWriter writer = new StreamWriter("person.xml"))
{
    xmlSerializer.Serialize(writer, person);
}

このコードでは、XmlSerializerを使用してPersonオブジェクトをXML形式でシリアライズし、person.xmlファイルに保存しています。

XML形式は、人間が読みやすく、また編集も容易なため、設定ファイルやデータ交換のフォーマットとして広く用いられています。

○サンプルコード4：JSON形式でのシリアライズ

JSON形式のシリアライズは、ウェブベースのアプリケーションで一般的に使用され、軽量でありながら効率的なデータ交換を可能にします。

下記のサンプルコードは、PersonオブジェクトをJSON形式でシリアライズする方法を表しています。

using System.Text.Json;

string jsonString = JsonSerializer.Serialize(person);
File.WriteAllText("person.json", jsonString);

このコードでは、System.Text.JsonライブラリのJsonSerializerを使ってPersonオブジェクトをJSON文字列にシリアライズし、その結果をperson.jsonファイルに保存しています。

JSONはウェブAPIとの通信や、軽量データストレージに最適なフォーマットです。

○サンプルコード5：バイナリ形式でのシリアライズ

バイナリ形式のシリアライズは、データのサイズを最小限に抑えるために有効です。

これは、特に大量のデータを扱うアプリケーションや、ネットワークを介してデータを送信する際に重要です。

ここでは、Personオブジェクトをバイナリ形式でシリアライズし、ファイルに保存するためのサンプルコードを紹介します。

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

Person person = new Person { Name = "Taro", Age = 30 };
BinaryFormatter formatter = new BinaryFormatter();

using (FileStream stream = new FileStream("person.bin", FileMode.Create))
{
    formatter.Serialize(stream, person);
}

このコードでは、BinaryFormatterクラスを使用してPersonオブジェクトをシリアライズしています。

シリアライズされたデータはFileStreamを通じてperson.binというファイルに書き込まれます。

バイナリ形式でシリアライズされたデータは、テキストベースのフォーマット（XMLやJSON）と比較してよりコンパクトであり、読み込みと書き込みのパフォーマンスも高速です。

●シリアライズの注意点と対処法

シリアライズを行う際には、いくつかの重要な注意点を理解し、適切な対処法を採ることが不可欠です。

データの整合性と安全性の確保、そしてパフォーマンスとメモリ管理は、シリアライズを行う上での主要な懸念事項です。

○データの整合性と安全性

データの整合性を保つためには、シリアライズとデシリアライズのプロセスが一致していることを確認する必要があります。

不整合が発生すると、デシリアライズ時に予期せぬエラーが発生する可能性があります。

また、外部からの不正なデータがシリアライズされたオブジェクトに注入されることを防ぐため、セキュリティ対策も重要です。

セキュリティの観点からは、特に外部ソースからのデータをデシリアライズする場合に注意が必要です。

悪意のあるデータがシステム内部で実行されることを防ぐため、入力の検証とサニタイズが推奨されます。

また、信頼できるソースからのデータのみを扱うようにし、不必要なデータの公開を避けることも重要です。

○パフォーマンスとメモリ管理

シリアライズにおけるパフォーマンスとメモリ管理は、特に大規模なデータや複雑なオブジェクト構造を扱う場合に重要です。

効率的なシリアライズ手法の選択は、システムのパフォーマンスに直接影響を及ぼします。

例えば、バイナリ形式のシリアライズはテキストベースのフォーマットよりも高速であり、データのサイズも小さくなりますが、可読性は低下します。

メモリ管理に関しては、特に大量のデータをシリアライズする際には、メモリ使用量に注意する必要があります。

大きなオブジェクトを一度にシリアライズする代わりに、データをチャンクに分割して処理することで、メモリの過剰な消費を防ぐことができます。

また、不要になったリソースは適切に解放することで、メモリリークを防止します。

●C#でのシリアライズのカスタマイズ方法

C#でのシリアライズ処理は、さまざまな方法でカスタマイズすることが可能です。

特定の要件に合わせてシリアライズの挙動を変更することで、アプリケーションの柔軟性と効率性を高めることができます。

ここでは、カスタムシリアライザの作成とシリアライズの設定のカスタマイズについて説明します。

○サンプルコード6：カスタムシリアライザの作成

特定のオブジェクトのシリアライズ処理をカスタマイズするには、カスタムシリアライザを作成します。

例えば、Personクラスのオブジェクトに対して特別なシリアライズ処理を実装する場合、次のようにカスタムシリアライザを定義することができます。

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

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

    [OnSerializing]
    internal void OnSerializingMethod(StreamingContext context)
    {
        // シリアライズ処理前に実行されるロジック
    }

    [OnSerialized]
    internal void OnSerializedMethod(StreamingContext context)
    {
        // シリアライズ処理後に実行されるロジック
    }
}

このコードでは、OnSerializingとOnSerializedの属性を使用して、シリアライズの前後に特定の処理を実行できるようにしています。

これにより、シリアライズプロセスを細かく制御し、特定の要件に合わせたデータの処理が可能になります。

○サンプルコード7：シリアライズの設定をカスタマイズする

シリアライズのプロセス中に特定のプロパティを除外したり、特定の方法で処理したりするためには、シリアライズの設定をカスタマイズします。

たとえば、JSONシリアライズの際に特定のプロパティを無視するには、次のように設定をカスタマイズします。

using System.Text.Json;

var options = new JsonSerializerOptions
{
    IgnoreReadOnlyProperties = true, // 読み取り専用のプロパティを無視
};

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

このコードでは、JsonSerializerOptionsを使用してシリアライズのオプションをカスタマイズしています。

この例では、読み取り専用のプロパティをシリアライズから除外しています。

まとめ

この記事では、C#におけるシリアライズの基本から応用、さらにカスタマイズ方法に至るまでを詳細に解説しました。

シリアライズはデータの保存や通信に不可欠なプロセスであり、C#では様々な形式でその実装が可能です。

この記事を通して、読者の皆様がC#でのシリアライズの基本から応用、カスタマイズ方法に至るまでの知識を深め、実際のプログラミングに役立てていただければ幸いです。

C#プログラミングでは、データの扱いが非常に重要であり、シリアライズはその中心的な役割を担っています。

今後もC#の学習を続けて、より高度なプログラミングスキルを身につけていただければと思います。