クラスマッピング

Overview

このガイドでは、MongoDB .NET/C# ドライバーで BSON ドキュメントと C# クラス間のマッピングをカスタマイズする方法を学習できます。デフォルトのクラスマッピング動作の詳細を確認したり、ドライバーでデータを直列化または逆直列化化する方法をカスタマイズしたりする必要がある場合にお読みください。

自動クラスマッピング

MongoDB コレクション内のデータを表すために、 BsonDocument ではなくクラスを使用すると、.NET/C# ドライバーは、データの直列化または逆直列化に使用するクラス マップを自動的に作成します。このマッピングは、ドキュメント内のフィールドの名前をクラス内のプロパティの名前と照合することで行われます。

クラスマップの手動作成

ドライバーの自動クラスマッピング機能をバイパスし、RegisterClassMap() メソッドを使用してクラス マップを手動で定義できます。

次の例では、Person クラスを定義しています。

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
}

次のコードは、 Person クラスのクラス マップを登録する方法を示しています。

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
    classMap.MapMember(p => p.Name);
    classMap.MapMember(p => p.Age);
    classMap.MapMember(p => p.Hobbies);
});

ドライバーで残りのプロパティを自動的にマッピングできるようにしながら、クラス プロパティのサブセットを手動でマッピングすることもできます。それには、クラス マップを登録して AutoMap() メソッドを呼び出してから、プロパティを手動で指定します。

次のコード例では、 AutoMap() メソッドが Person クラスのすべてのプロパティをマッピングし、 Hobbies フィールドのマッピングを手動で調整します。

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
    classMap.AutoMap();
    classMap.MapMember(p => p.Hobbies).SetElementName("favorite_hobbies");
});

クラス直列化をカスタマイズする

クラスの属性を使用するか、クラス マップの登録時にメソッドを呼び出すことで、ドライバーがクラス レベルでドキュメントを直列化および逆直列化化する方法をカスタマイズできます。

[BsonIgnoreExtraElements]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
}

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.SetIgnoreExtraElements(true);
});

コンストラクタによるマッピング

デフォルトでは、.NET/C# ドライバーは、クラスに引数のないコンストラクタがある場合にのみ、クラスを自動的にマッピングできます。1 つ以上の引数を受け入れるコンストラクタをドライバーで使用したい場合は、BsonConstructor 属性をコンストラクタに追加できます。この場合はドライバーで型が分析され、コンストラクタの引数をクラスのプロパティまたはフィールドにマッピングする方法が決定されます。

ドライバーは、次の Person クラスのクラス マップを作成する際、 BsonConstructor 属性でマークされたコンストラクターを使用します。name 引数は Name プロパティにマッピングされ、age 引数は Age プロパティにマッピングされます。

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
    [BsonConstructor]
    public Person(string name, string age)
    {
        Name = name;
        Age = age;
    }
}

クラス マップの登録時に使用するコンストラクタを指定することもできます。

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
    public Person(string name, string age)
    {
        Name = name;
        Age = age;
    }
}
BsonClassMap.RegisterClassMap<Person>(classMap =>
{
    classMap.AutoMap();
    classMap.MapCreator(p => new Person(p.Name, p.Age));
});

プロパティ直列化をカスタマイズする

プロパティに属性を追加することで、ドライバーがクラス プロパティを直列化する方法もカスタマイズできます。カスタム プロパティの直列化の詳細については、「カスタム直列化」を参照してください。

public class Person
{
    public string Name { get; set;
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
    [BsonExtraElements]
    public BsonDocument ExtraElements {get; set;}
}

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
    classMap.AutoMap();
    classMap.MapExtraElementsMember(p => p.ExtraElements);
});

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies {get; set;}
    public bool ShouldSerializeAge()
    {
       return Age != 0;
    }
}

BsonClassMap.RegisterClassMap<Employee>(classMap =>
{
    classMap.AutoMap();
    classMap.MapMember(p => c.Age).SetShouldSerializeMethod(
        obj => ((Person) obj).Age != 0
    );
});

詳細情報

C# クラスの使用方法の詳細については、「POCO」を参照してください。

API ドキュメント

• BsonClassMap

• RegisterClassMap

• AutoMap