클래스 매핑

개요

이 가이드 에서는 MongoDB .NET/ C# 드라이버 BSON 문서를 C# 클래스와 매핑하는 방식을 사용자 지정하는 방법을 학습 수 있습니다. 이 페이지를 읽고 기본값 클래스 매핑 동작에 대해 자세히 학습 운전자 데이터를 직렬화 또는 역직렬화하는 방식을 사용자 지정해야 하는지 여부를 확인할 수 있습니다.

POCO 속성을 사용하여 직렬화 동작을 설정하다 수도 있습니다. 자세한 학습 은 POCO 가이드 참조하세요.

자동 클래스 매핑

BsonDocument가 아닌 클래스를 사용하여 MongoDB 컬렉션의 데이터를 나타내는 경우, .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");
});

클래스 직렬화 사용자 지정

클래스에 속성을 적용하거나 클래스 맵을 등록하는 동안 메서드를 호출하여 운전자 클래스 수준에서 문서를 직렬화 및 역직렬화하는 방법을 사용자 지정할 수 있습니다.

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.UnmapMember(p => p.Age);
});

[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);
});

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.MapIdMember(p => p.Identifier);
});

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.IdMemberMap.SetSerializer(new StringSerializer(BsonType.ObjectId));
});

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.MapIdMember(p => p.Identifier).SetIdGenerator(StringObjectIdGenerator.Instance);
});

BsonClassMap.RegisterClassMap<Person>(classMap =>
{
     classMap.AutoMap();
     classMap.IdMemberMap.SetSerializer(new GuidSerializer(GuidRepresentation.Standard));
});

생성자를 사용한 매핑

기본적으로 .NET/C# 드라이버는 클래스에 인수가 없는 생성자가 있는 경우에만 클래스를 자동으로 매핑할 수 있습니다. 드라이버가 하나 이상의 인수를 허용하는 생성자를 사용하도록 하려면 생성자에 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