直列化

Overview

このガイドでは、MongoDB .NET/C# ドライバーを使用して直列化を実行する方法を学習できます。 直列化は、C# オブジェクトを MongoDB にストレージ用の BSON ドキュメントにマッピングするプロセスです。

シリアライザー

シリアライザーは、C# オブジェクトと BSON ドキュメントの変換を処理するクラスです。 シリアライザーは IBsonSerializerインターフェースを実装します。 .NET/C# ドライバーには、プリミティブ型、コレクション型、カスタム クラスを処理するために作成された多数の組み込みシリアライザーがあります。

使用可能なシリアライザーの完全なリストについては、「 シリアライザーの名前空間 API ドキュメント 」を参照してください。

シリアライザー レジストリ

シリアライザー レジストリには、アプリケーションで使用できるすべての登録済みシリアライザーが含まれます。 組み込みシリアライザーの多くは、アプリケーションの起動時にシリアライザー レジストリに自動的に登録されます。 ただし、カスタム シリアライザーを使用する前に、次の例に示すように、それをシリアライザー レジストリに追加する必要があります。

BsonSerializer.RegisterSerializer(new CustomTypeSerializer());

シリアライザー レジストリにアクセスするには、次のようにBsonSerializerクラスのSerializerRegistryプロパティを使用します。

var intSerializer = BsonSerializer.SerializerRegistry.GetSerializer<int>();

class CustomRegularExpressionSerializer : SerializerBase<Regex>
{
    public override Regex Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
  {
      var type = context.Reader.GetCurrentBsonType();
      switch (type)
      {
          case BsonType.RegularExpression:
              return context.Reader.ReadRegularExpression().AsRegex;
          case BsonType.String:
              var pattern = context.Reader.ReadString();
              return new Regex(pattern);
          default:
              throw new NotSupportedException($"Cannot convert a {type} to a RegularExpression.");
      }
  }
  public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, Regex value)
  {
      context.Writer.WriteRegularExpression(value);
  }
}

オプトイン インターフェース

.NET/C# ドライバーには、シリアライザーが取り扱うデータ型に応じて、カスタム シリアライザー クラスで実装できるオプションのインターフェースがいくつかあります。

詳細情報

.NET/C# ドライバーを使用して C# オブジェクトを直列化する方法の詳細については、次のページを参照してください。

• クラスマッピング

• POCO

• 多形オブジェクト

• GUID

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

• SerializerRegistry

• BsonSerializer

• IBsonSerializer

• Serializer<T>