Serialização

Visão geral

Neste guia, você pode aprender a usar o driver MongoDB .NET/C# para realizar a serialização. Serialização é o processo de mapeamento de um objeto C# em um documento BSON para armazenamento no MongoDB.

Serializadores

Os serializadores são classes que lidam com a tradução de objetos C# de e para documentos BSON. Os serializadores implementam a interface IBsonSerializer . O driver .NET/C# tem muitos serializadores integrados feitos para lidar com tipos primitivos, tipos de collection e classes personalizadas.

Para obter uma lista completa dos serializadores disponíveis, consulte a documentação da API do namespace Serializadores.

ObjectSerializer

A classe ObjectSerializer permite serialização e desserialização somente dos tipos que são considerados seguros. Ao construir um ObjectSerializer, você pode passar um delegado do tipo Func<Type, bool>. Este delegado aceita um tipo de objeto e retorna um valor booleano indicando se o tipo é seguro para serialização.

Na maioria dos casos, passe no ObjectSerializer.DefaultAllowedTypes() delegado. Este método retorna verdadeiro para vários tipos de estruturas conhecidas que consideramos seguras. Para serializar tipos personalizados, crie uma expressão booleana que avalia true para os tipos que você deseja incluir. Em seguida, adicione esta expressão ao final do delegado que você passa para o ObjectSerializer construtor .

No exemplo abaixo, o ObjectSerializer serializará e desserializará qualquer tipo permitido pelo ObjectSerializer.DefaultAllowedTypes() ou cujo nome completo comece com "MyNamespace":

var objectSerializer = new ObjectSerializer(type => ObjectSerializer.DefaultAllowedTypes(type)
    || type.FullName.StartsWith("MyNamespace"));
BsonSerializer.RegisterSerializer(objectSerializer);

Para permitir que tipos anônimos sejam serializados, adicione a expressão boolean type.FullName.StartsWith("<>f__AnonymousType")) ao seu delegado, como indicado no exemplo abaixo:

var objectSerializer = new ObjectSerializer(type => ObjectSerializer.DefaultAllowedTypes(type)
    || type.FullName.StartsWith("<>f__AnonymousType"));
BsonSerializer.RegisterSerializer(objectSerializer);

Crie e registre seu ObjectSerializer no início do seu programa, antes de fazer qualquer outra coisa.

SerializerRegistry

O registro de serializadores contém todos os serializadores registrados que estão disponíveis para o seu aplicativo. Muitos dos serializadores incorporados são registrados automaticamente no registro de serializadores durante a inicialização do aplicativo.

BsonSerializer.RegisterSerializer(new CustomTypeSerializer());

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

class CustomRegularExpressionSerializer : IBsonSerializer
{
   public Type ValueType => typeof(Regex);
   public object Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
   {
      var type = context.Reader.CurrentBsonType;
      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 void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
   {
      var regex = (Regex) value;
      context.Writer.WriteRegularExpression(regex);
   }
}

Interfaces Opt-in

O driver .NET/C# tem várias interfaces opcionais que sua classe de serializador personalizado pode implementar, dependendo do tipo de dados que o serializador manipula.

Convenções

Os pacotes de convenções permitem definir e aplicar convenções às suas classes e seus membros que o driver usa durante a serialização. As convenções especificam como os dados são mapeados entre seus objetos C# e documentos MongoDB sem exigir que você decore cada classe com atributos.

O driver .NET/C# fornece convenções internas que você pode usar para personalizar o processo de serialização . A tabela a seguir descreve algumas das convenções integradas:

Para visualizar uma lista completa de convenções disponíveis, consulte a referência da classe Convenções na documentação da API.

Você pode registrar uma convenção instanciando um ConventionPack com as convenções especificadas e, em seguida, passando-a para o método ConventionRegistry.Register(), conforme mostrado no exemplo a seguir:

var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
ConventionRegistry.Register("CamelCaseConvention", camelCaseConvention, t => true);

Melhorar o desempenho da serialização da matriz

Você pode melhorar o desempenho do seu aplicativo representando matrizes de primitivos como estruturas Memória<T> e ReadOnlyMemory<T> em vez de usar tipos como matrizes C# padrão ou objetos BsonArray. O driver implementa caminhos rápidos de serialização e desserialização para Memory<T> e ReadOnlyMemory<T>, o que aumenta a velocidade e reduz o uso da memória.

Você pode efetuar essas melhorias de desempenho armazenando os seguintes tipos primitivos em estruturas Memory<T> ou ReadOnlyMemory<T>:

• bool

• sbyte

• byte

• char

• short

• ushort

• int

• uint

• long

• ulong

• float

• double

• decimal

O exemplo a seguir define um Line POCO que contém campos de array modelados pelas estruturas Memory e ReadOnlyMemory:

public class Line
{
  public ObjectId Id { get; set; }
  public Memory<int> X { get; set; }
  public ReadOnlyMemory<float> Y { get; set; }
}

O documento a seguir representa como um objeto Line de amostra é representado no MongoDB:

{
  "_id": ...,
  "X": [ 1, 2, 3, 4, 5 ],
  "Y": [ 1, 1.409999966621399, 1.7300000190734863, 2, 2.240000009536743 ]
}

Informações adicionais

Para saber mais sobre como usar o driver .NET/C# para serializar objetos C#, consulte as seguintes páginas:

• Mapeamento de classe

• POCOs

• Objetos polimórficos

• GUIDs

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

• SerializerRegistry

• BsonSerializer

• IBsonSerializer

• ConventionPack

• Registro de convenções

• Registrar()