BinaryFormatter Класс

Определение

Сериализует и десериализует объект или полный граф связанных объектов в двоичном формате.

public ref class BinaryFormatter sealed : System::Runtime::Serialization::IFormatter
public ref class BinaryFormatter sealed : System::Runtime::Remoting::Messaging::IRemotingFormatter
public sealed class BinaryFormatter : System.Runtime.Serialization.IFormatter
public sealed class BinaryFormatter : System.Runtime.Remoting.Messaging.IRemotingFormatter
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class BinaryFormatter : System.Runtime.Remoting.Messaging.IRemotingFormatter
type BinaryFormatter = class
    interface IFormatter
type BinaryFormatter = class
    interface IRemotingFormatter
    interface IFormatter
[<System.Runtime.InteropServices.ComVisible(true)>]
type BinaryFormatter = class
    interface IRemotingFormatter
    interface IFormatter
Public NotInheritable Class BinaryFormatter
Implements IFormatter
Public NotInheritable Class BinaryFormatter
Implements IRemotingFormatter
Наследование
BinaryFormatter
Атрибуты
Реализации

Примеры

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization::Formatters::Binary;
using namespace System::Runtime::Serialization;
ref class App
{
public:
   static void Serialize()
   {
      
      // Create a hashtable of values that will eventually be serialized.
      Hashtable^ addresses = gcnew Hashtable;
      addresses->Add( "Jeff", "123 Main Street, Redmond, WA 98052" );
      addresses->Add( "Fred", "987 Pine Road, Phila., PA 19116" );
      addresses->Add( "Mary", "PO Box 112233, Palo Alto, CA 94301" );
      
      // To serialize the hashtable (and its keys/values),  
      // you must first open a stream for writing. 
      // In this case we will use a file stream.
      FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Create );
      
      // Construct a BinaryFormatter and use it to serialize the data to the stream.
      BinaryFormatter^ formatter = gcnew BinaryFormatter;
      try
      {
         formatter->Serialize( fs, addresses );
      }
      catch ( SerializationException^ e ) 
      {
         Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );
         throw;
      }
      finally
      {
         fs->Close();
      }

   }

   static void Deserialize()
   {
      
      // Declare the hashtable reference.
      Hashtable^ addresses = nullptr;
      
      // Open the file containing the data that we want to deserialize.
      FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Open );
      try
      {
         BinaryFormatter^ formatter = gcnew BinaryFormatter;
         
         // Deserialize the hashtable from the file and 
         // assign the reference to our local variable.
         addresses = dynamic_cast<Hashtable^>(formatter->Deserialize( fs ));
      }
      catch ( SerializationException^ e ) 
      {
         Console::WriteLine( "Failed to deserialize. Reason: {0}", e->Message );
         throw;
      }
      finally
      {
         fs->Close();
      }

      
      // To prove that the table deserialized correctly, display the keys/values.
      IEnumerator^ myEnum = addresses->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         DictionaryEntry ^ de = safe_cast<DictionaryEntry ^>(myEnum->Current);
         Console::WriteLine( " {0} lives at {1}.", de->Key, de->Value );
      }
   }

};


[STAThread]
int main()
{
   App::Serialize();
   App::Deserialize();
   return 0;
}
using System;
using System.IO;
using System.Collections;
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization;

public class App
{
    [STAThread]
    static void Main()
    {
        Serialize();
        Deserialize();
    }

    static void Serialize()
    {
        // Create a hashtable of values that will eventually be serialized.
        Hashtable addresses = new Hashtable();
        addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052");
        addresses.Add("Fred", "987 Pine Road, Phila., PA 19116");
        addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301");

        // To serialize the hashtable and its key/value pairs,
        // you must first open a stream for writing.
        // In this case, use a file stream.
        FileStream fs = new FileStream("DataFile.dat", FileMode.Create);

        // Construct a BinaryFormatter and use it to serialize the data to the stream.
        BinaryFormatter formatter = new BinaryFormatter();
        try
        {
            formatter.Serialize(fs, addresses);
        }
        catch (SerializationException e)
        {
            Console.WriteLine("Failed to serialize. Reason: " + e.Message);
            throw;
        }
        finally
        {
            fs.Close();
        }
    }

    static void Deserialize()
    {
        // Declare the hashtable reference.
        Hashtable addresses  = null;

        // Open the file containing the data that you want to deserialize.
        FileStream fs = new FileStream("DataFile.dat", FileMode.Open);
        try
        {
            BinaryFormatter formatter = new BinaryFormatter();

            // Deserialize the hashtable from the file and
            // assign the reference to the local variable.
            addresses = (Hashtable) formatter.Deserialize(fs);
        }
        catch (SerializationException e)
        {
            Console.WriteLine("Failed to deserialize. Reason: " + e.Message);
            throw;
        }
        finally
        {
            fs.Close();
        }

        // To prove that the table deserialized correctly,
        // display the key/value pairs.
        foreach (DictionaryEntry de in addresses)
        {
            Console.WriteLine("{0} lives at {1}.", de.Key, de.Value);
        }
    }
}
Imports System.IO
Imports System.Collections
Imports System.Runtime.Serialization.Formatters.Binary
Imports System.Runtime.Serialization


Module App

    Sub Main()
        Serialize()
        Deserialize()
    End Sub

    Sub Serialize()

        ' Create a hashtable of values that will eventually be serialized.
        Dim addresses As New Hashtable
        addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052")
        addresses.Add("Fred", "987 Pine Road, Phila., PA 19116")
        addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301")

        ' To serialize the hashtable (and its key/value pairs),  
        ' you must first open a stream for writing. 
        ' In this case, use a file stream.
        Dim fs As New FileStream("DataFile.dat", FileMode.Create)

        ' Construct a BinaryFormatter and use it to serialize the data to the stream.
        Dim formatter As New BinaryFormatter
        Try
            formatter.Serialize(fs, addresses)
        Catch e As SerializationException
            Console.WriteLine("Failed to serialize. Reason: " & e.Message)
            Throw
        Finally
            fs.Close()
        End Try
    End Sub



    Sub Deserialize()
        ' Declare the hashtable reference.
        Dim addresses As Hashtable = Nothing

        ' Open the file containing the data that you want to deserialize.
        Dim fs As New FileStream("DataFile.dat", FileMode.Open)
        Try
            Dim formatter As New BinaryFormatter

            ' Deserialize the hashtable from the file and 
            ' assign the reference to the local variable.
            addresses = DirectCast(formatter.Deserialize(fs), Hashtable)
        Catch e As SerializationException
            Console.WriteLine("Failed to deserialize. Reason: " & e.Message)
            Throw
        Finally
            fs.Close()
        End Try

        ' To prove that the table deserialized correctly, 
        ' display the key/value pairs.
        Dim de As DictionaryEntry
        For Each de In addresses
            Console.WriteLine("{0} lives at {1}.", de.Key, de.Value)
        Next
    End Sub
End Module

Комментарии

Предупреждение

BinaryFormatter является небезопасным и не может быть обеспечена безопасным. Дополнительные сведения см. в разделе BinaryFormatter Security Guide.

SoapFormatterКлассы и BinaryFormatter реализуют IRemotingFormatter интерфейс для поддержки вызовов удаленных процедур (RPC) и IFormatter интерфейс (наследуется IRemotingFormatter ) для поддержки сериализации графа объектов. SoapFormatterКласс также поддерживает вызовы RPC с ISoapMessage объектами без использования IRemotingFormatter функциональности.

Во время вызовов RPC IRemotingFormatter интерфейс позволяет определить два отдельных графа объектов: диаграмму объектов для сериализации и дополнительный граф, содержащий массив объектов заголовков, который передает сведения об удаленном вызове функции (например, идентификатор транзакции или сигнатура метода).

RPC, в которых используются BinaryFormatter отдельные части, — это вызовы методов, которые отправляются на сервер с удаленным объектом, содержащим вызываемый метод, и ответами методов, которые отправляются с сервера клиенту со сведениями о состоянии и ответе из вызываемого метода.

Во время сериализации вызова метода первый объект графа объекта должен поддерживать IMethodCallMessage интерфейс. Чтобы десериализовать вызов метода, используйте Deserialize метод с HeaderHandler параметром. Инфраструктура удаленного взаимодействия использует HeaderHandler делегат для создания объекта, поддерживающего ISerializable интерфейс. Когда BinaryFormatter вызывает HeaderHandler делегат, он возвращает универсальный код ресурса (URI) удаленного объекта с вызываемым методом. Первый объект в возвращенном графе поддерживает IMethodCallMessage интерфейс.

Процедура сериализации для ответа метода идентична процедуре вызова метода, за исключением того, что первый объект графа объекта должен поддерживать IMethodReturnMessage интерфейс. Чтобы десериализовать ответ метода, используйте DeserializeMethodResponse метод. Чтобы сэкономить время, сведения о вызывающем объекте не отправляются удаленному объекту во время вызова метода. Эти сведения вместо этого получаются из исходного вызова метода, который передается в DeserializeMethodResponse метод в IMethodCallMessage параметре. Первый объект в графе, возвращенном DeserializeMethodResponse методом, поддерживает IMethodReturnMessage интерфейс.

Важно!

Использование двоичной сериализации для десериализации ненадежных данных может привести к угрозам безопасности. Дополнительные сведения см. в статье Проверка данных и BinaryFormatter Security Guide.

Непарные суррогаты

Все непарные суррогатные символы теряются в двоичной сериализации. Например, следующая строка содержит верхний суррогатный символ Юникода (\ud800 ) между двумя Test словами:

Test\ud800Test

Перед сериализацией массив байтов строки выглядит следующим образом:

Значение массива байтов Символ
84 T
101 й
115 s
116 t
55296 \ud800
84 T
101 й
115 s
116 t

После десериализации верхний суррогатный символ Юникода теряется:

Значение массива байтов Символ
84 T
101 й
115 s
116 t
84 T
101 й
115 s
116 t

Конструкторы

BinaryFormatter()

Инициализирует новый экземпляр класса BinaryFormatter со значениями по умолчанию.

BinaryFormatter(ISurrogateSelector, StreamingContext)

Инициализирует новый экземпляр класса BinaryFormatter с заданными суррогатным селектором и потоковым контекстом.

Свойства

AssemblyFormat

Получает или задает поведение десериализатора в части, касающейся поиска и загрузки сборок.

Binder

(Небезопасно) Получает или задает объект типа SerializationBinder, который управляет привязкой сериализованного объекта к типу.

Context

Получает или задает StreamingContext для этого форматера.

FilterLevel

Получает или задает уровень TypeFilterLevel автоматической десериализации, которая осуществляется BinaryFormatter.

SurrogateSelector

Получает или задает ISurrogateSelector, управляющий подстановкой типа при сериализации и десериализации.

TypeFormat

Получает или задает формат, в котором описания типов раскладываются в сериализованном потоке.

Методы

Deserialize(Stream)
Является устаревшей.

Десериализует заданный поток в граф объекта.

Deserialize(Stream, HeaderHandler)

Десериализует заданный поток в граф объекта. Предоставленный HeaderHandler обрабатывает любые заголовки в этом потоке.

DeserializeMethodResponse(Stream, HeaderHandler, IMethodCallMessage)

Десериализует ответ удаленному вызову метода от предоставленного Stream.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
Serialize(Stream, Object)
Является устаревшей.

Сериализует объект или граф объектов с указанной вершиной (корнем) в заданный поток.

Serialize(Stream, Object, Header[])

Сериализует объект или граф объектов с указанной вершиной (корнем) в заданный поток, присоединяя предоставленные заголовки.

ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)
UnsafeDeserialize(Stream, HeaderHandler)

Десериализует заданный поток в граф объекта. Предоставленный HeaderHandler обрабатывает любые заголовки в этом потоке.

UnsafeDeserializeMethodResponse(Stream, HeaderHandler, IMethodCallMessage)

Десериализует ответ удаленному вызову метода от предоставленного Stream.

Применяется к