Как сериализовывать и десериализовывать объекты в двоичный поток и из него (платформа Entity Framework)

Типы сущностей, созданные с помощью средства генератора модель EDM (сущностная модель данных) (модель EDM) (EdmGen.exe) и мастера моделей EDM, поддерживают двоичную сериализацию. При сериализации объекта в поток двоичных данных все связанные объекты, загруженные в контекст объекта в это время, тоже будут сериализованы. Дополнительные сведения см. в разделе Сериализация объектов (платформа Entity Framework).

Пример в этом разделе основан на модели Adventure Works Sales. Чтобы запустить код из данного примера, нужно сначала добавить к проекту модель AdventureWorks Sales и настроить его для использования платформы Entity Framework. Для этого выполните инструкции из разделов Как вручную настроить проект Entity Framework и Как определить модель и файлы сопоставления вручную (платформа Entity Framework). Необходимо также добавить в код инструкцию using (Imports в Visual Basic) для следующих пространств имен:

Пример

В этом примере метод SerializeToBinaryStream выполняет запрос к объекту Contact для указанного значения фамилии и возвращает двоичный поток MemoryStream. Поток MemoryStream содержит граф объектов для объекта Contact и связанных с ним объектов SalesOrderHeader и SalesOrderDetail.

Public Shared Sub ReadFromBinaryStream()
    Dim formatter As New BinaryFormatter()
    Using context As New AdventureWorksEntities()
        Try
            ' Get the object graph for the selected customer 
            ' as a binary stream. 
            Dim stream As MemoryStream = SerializeToBinaryStream("Adams")

            ' Read from the begining of the stream. 
            stream.Seek(0, SeekOrigin.Begin)

            ' Deserialize the customer graph from the binary stream 
            ' and attach to an ObjectContext. 
            Dim contact As Contact = DirectCast(formatter.Deserialize(stream), Contact)
            context.Attach(contact)

            ' Display information for each item 
            ' in the orders that belong to the first contact. 
            For Each order As SalesOrderHeader In contact.SalesOrderHeaders
                Console.WriteLine(String.Format("PO Number: {0}", order.PurchaseOrderNumber))
                Console.WriteLine(String.Format("Order Date: {0}", order.OrderDate.ToString()))
                Console.WriteLine("Order items:")
                For Each item As SalesOrderDetail In order.SalesOrderDetails
                    Console.WriteLine(String.Format("Product: {0}, Quantity: {1}", _
                                                      item.ProductID.ToString(), item.OrderQty.ToString()))
                Next
            Next
        Catch ex As SerializationException
            Console.WriteLine("The object graph could not be deserialized from " & _
                              "the binary stream because of the following error:")
            Console.WriteLine(ex.ToString())
        End Try
    End Using
End Sub
Private Shared Function SerializeToBinaryStream(ByVal lastName As String) As MemoryStream
    Dim formatter As New BinaryFormatter()
    Dim stream As New MemoryStream()

    Using context As New AdventureWorksEntities()
        ' Specify a timeout for queries in this context, in seconds. 
        context.CommandTimeout = 120

        ' Define a customer contact. 
        Dim customer As Contact

        ' Create a Contact query with a path that returns 
        ' orders and items for a contact. 
        Dim query As ObjectQuery(Of Contact) = context.Contacts.Include("SalesOrderHeaders.SalesOrderDetails")

        Try
            ' Return the first contact with the specified last name 
            ' along with its related orders and items. 
            customer = query.Where("it.LastName = @lastname", New ObjectParameter("lastname", lastName)).First()

            ' Serialize the customer object graph. 
            formatter.Serialize(stream, customer)
        Catch ex As EntitySqlException
            Throw New InvalidOperationException("The object query failed", ex)
        Catch ex As EntityCommandExecutionException
            Throw New InvalidOperationException("The object query failed", ex)
        Catch ex As SerializationException
            Throw New InvalidOperationException("The object graph could not be serialized", ex)
        End Try

        ' Return the streamed object graph. 
        Return stream
    End Using
End Function
public static void ReadFromBinaryStream()
{
    BinaryFormatter formatter = new BinaryFormatter();
    using (AdventureWorksEntities context = new AdventureWorksEntities())
    {
        try
        {
            // Get the object graph for the selected customer
            // as a binary stream.
            MemoryStream stream = SerializeToBinaryStream(@"Adams");

            // Read from the begining of the stream.
            stream.Seek(0, SeekOrigin.Begin);

            // Deserialize the customer graph from the binary stream
            // and attach to an ObjectContext.
            Contact contact = (Contact)formatter.Deserialize(stream);
            context.Attach(contact);

            // Display information for each item 
            // in the orders that belong to the first contact.
            foreach (SalesOrderHeader order in contact.SalesOrderHeaders)
            {
                Console.WriteLine(String.Format("PO Number: {0}",
                    order.PurchaseOrderNumber));
                Console.WriteLine(String.Format("Order Date: {0}",
                    order.OrderDate.ToString()));
                Console.WriteLine("Order items:");
                foreach (SalesOrderDetail item in order.SalesOrderDetails)
                {
                    Console.WriteLine(String.Format("Product: {0} "
                        + "Quantity: {1}", item.ProductID.ToString(),
                        item.OrderQty.ToString()));
                }
            }
        }

        catch (SerializationException ex)
        {
            Console.WriteLine("The object graph could not be deserialized from "
                          + "the binary stream because of the following error:");
            Console.WriteLine(ex.ToString());
        }
    }
}
private static MemoryStream SerializeToBinaryStream(string lastName)
{
    BinaryFormatter formatter = new BinaryFormatter();
    MemoryStream stream = new MemoryStream();

    using (AdventureWorksEntities context = new AdventureWorksEntities())
    {
        // Specify a timeout for queries in this context, in seconds.
        context.CommandTimeout = 120;

        // Define a customer contact.
        Contact customer;

        // Create a Contact query with a path that returns 
        // orders and items for a contact.
        ObjectQuery<Contact> query =
            context.Contacts.Include("SalesOrderHeaders.SalesOrderDetails");

        try
        {
            // Return the first contact with the specified last name
            // along with its related orders and items.
            customer = query.Where("it.LastName = @lastname",
                new ObjectParameter("lastname", lastName)).First();

            // Serialize the customer object graph.
            formatter.Serialize(stream, customer);
        }
        catch (EntitySqlException ex)
        {
            throw new InvalidOperationException("The object query failed", ex);
        }
        catch (EntityCommandExecutionException ex)
        {
            throw new InvalidOperationException("The object query failed", ex);
        }
        catch (SerializationException ex)
        {
            throw new InvalidOperationException("The object graph could not be serialized", ex);
        }

        // Return the streamed object graph.
        return stream;
    }
}

См. также

Основные понятия

Работа с объектами (платформа Entity Framework)