BinaryFormatter Klasse

  • Referenz

Definition

Namespace:
System.Runtime.Serialization.Formatters.Binary
Assembly:
System.Runtime.Serialization.Formatters.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Serialisiert und deserialisiert ein Objekt oder ein ganzes Diagramm verbundener Objekte im binären Format.

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
Vererbung
Object
BinaryFormatter
Attribute
ComVisibleAttribute
Implementiert
IFormatter IRemotingFormatter

Beispiele

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

Hinweise

Warnung

BinaryFormatter ist unsicher und kann nicht sicher gemacht werden. Weitere Informationen finden Sie im BinaryFormatter-Sicherheitshandbuch.

BinaryFormatter Die SoapFormatter und Klassen implementieren die IRemotingFormatter Schnittstelle, um Remoteprozeduraufrufe (RPCs) und die Schnittstelle (geerbt durch den IFormatter IRemotingFormatter) zu unterstützen, um die Serialisierung eines Diagramms von Objekten zu unterstützen. Die SoapFormatter Klasse unterstützt auch RPCs mit ISoapMessage Objekten, ohne die IRemotingFormatter Funktionalität zu verwenden.

Während DER RPCs ermöglicht die IRemotingFormatter Schnittstelle die Spezifikation von zwei separaten Objektdiagrammen: das Diagramm von Objekten zum Serialisieren und ein zusätzliches Diagramm, das ein Array von Headerobjekten enthält, die Informationen über den Remotefunktionsaufruf (z. B. Transaktions-ID oder eine Methodensignatur) vermitteln.

RPCs, die die BinaryFormatter separate in zwei verschiedenen Teile verwenden: Methodenaufrufe, die an den Server mit dem Remoteobjekt gesendet werden, das die Methode aufgerufen hat, und Methodenantworten, die vom Server an den Client mit den Status- und Antwortinformationen aus der aufgerufenen Methode gesendet werden.

Während der Serialisierung einer Methode muss das erste Objekt des Objektdiagramms die IMethodCallMessage Schnittstelle unterstützen. Um einen Methodenaufruf zu deserialisieren, verwenden Sie die Deserialize Methode mit dem HeaderHandler Parameter. Die Remoting-Infrastruktur verwendet den Stellvertretung, um ein Objekt zu erstellen, das die HeaderHandler ISerializable Schnittstelle unterstützt. Wenn die BinaryFormatter HeaderHandler Stellvertretung aufgerufen wird, gibt sie den URI des Remoteobjekts mit der aufgerufenen Methode zurück. Das erste Objekt im zurückgegebenen Diagramm unterstützt die IMethodCallMessage Schnittstelle.

Die Serialisierungsprozedur für eine Methodenantwort ist identisch mit dem eines Methodenaufrufs, außer das erste Objekt des Objektdiagramms muss die IMethodReturnMessage Schnittstelle unterstützen. Um eine Methodenantwort zu deserialisieren, verwenden Sie die DeserializeMethodResponse Methode. Details zum Speichern von Zeit werden während des Methodenaufrufs nicht an das Remoteobjekt gesendet. Diese Details werden stattdessen aus dem IMethodCallMessage ursprünglichen Methodenaufruf abgerufen, der an die DeserializeMethodResponse Methode im Parameter übergeben wird. Das erste Objekt im von der DeserializeMethodResponse Methode zurückgegebenen Diagramm unterstützt die IMethodReturnMessage Schnittstelle.

Wichtig

Mithilfe der binären Serialisierung können nicht vertrauenswürdige Daten zu Sicherheitsrisiken führen. Weitere Informationen finden Sie unter Überprüfen aller Eingaben und des BinaryFormatter-Sicherheitshandbuchs.

Unbezahlte Surrogate

Alle unbezahlten Surrogatezeichen gehen in der binären Serialisierung verloren. Beispielsweise enthält die folgende Zeichenfolge ein hoch surrogates Unicode-Zeichen (\ud800zwischen den beiden Test Wörtern:

Test\ud800Test

Vor der Serialisierung ist das Bytearray der Zeichenfolge wie folgt:

Byte-Arraywert Zeichen
84 T
101 e
115 s
116 t
55296 \ud800
84 T
101 e
115 s
116 t

Nach der Deerialisierung geht das hohe Unicode-Zeichen verloren:

Byte-Arraywert Zeichen
84 T
101 e
115 s
116 t
84 T
101 e
115 s
116 t

Konstruktoren

BinaryFormatter()

Initialisiert eine neue Instanz der BinaryFormatter-Klasse mit Standardwerten.
BinaryFormatter(ISurrogateSelector, StreamingContext)

Initialisiert eine neue Instanz der BinaryFormatter-Klasse mit einer angegebenen Surrogatauswahl und angegebenem Streamingkontext.

Eigenschaften

AssemblyFormat

Ruft das Verhalten des Deserialisierungsprogramms bezüglich des Suchens und Ladens von Assemblys ab oder legt dieses fest.
Binder

(Unsicher) Ruft ein Objekt vom Typ SerializationBinder ab, das die Bindung eines serialisierten Objekts an einen Typ steuert, oder legt dieses fest.
Context

Ruft den StreamingContext für dieses Formatierungsprogramm ab oder legt diesen fest.
FilterLevel

Ruft das TypeFilterLevel der automatischen Deserialisierung ab, das vom BinaryFormatter ausgeführt wird, oder legt dieses fest.
SurrogateSelector

Ruft den ISurrogateSelector ab, der die Typersetzung während der Serialisierung und Deserialisierung steuert, oder legt diesen fest.
TypeFormat

Ruft das Format für das Layout von Typbeschreibungen im serialisierten Stream ab oder legt dieses fest.

Methoden

Deserialize(Stream)
Veraltet.

Deserialisiert den angegebenen Stream in ein Objektdiagramm.
Deserialize(Stream, HeaderHandler)

Deserialisiert den angegebenen Stream in ein Objektdiagramm. Der bereitgestellte HeaderHandler behandelt sämtliche Header in diesem Stream.
DeserializeMethodResponse(Stream, HeaderHandler, IMethodCallMessage)

Deserialisiert eine Antwort auf einen Remotemethodenaufruf aus dem bereitgestellten Stream.
Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
Serialize(Stream, Object)
Veraltet.

Serialisiert das Objekt oder das Objektdiagramm mit dem angegebenen obersten Element (Stamm) in den angegebenen Stream.
Serialize(Stream, Object, Header[])

Serialisiert das Objekt bzw. das Objektdiagramm mit dem angegebenen obersten Element (Stamm) in den angegebenen Stream, wobei die bereitgestellten Header angefügt werden.
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)
UnsafeDeserialize(Stream, HeaderHandler)

Deserialisiert den angegebenen Stream in ein Objektdiagramm. Der bereitgestellte HeaderHandler behandelt sämtliche Header in diesem Stream.
UnsafeDeserializeMethodResponse(Stream, HeaderHandler, IMethodCallMessage)

Deserialisiert eine Antwort auf einen Remotemethodenaufruf aus dem bereitgestellten Stream.

Gilt für: