NetDataContractSerializer 類別

定義

利用提供的 .NET 類型,將某個型別的實例序列化並反序列化為 XML 串流或文件。 此類別無法獲得繼承。

public ref class NetDataContractSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer, System::Runtime::Serialization::IFormatter
public sealed class NetDataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer, System.Runtime.Serialization.IFormatter
type NetDataContractSerializer = class
    inherit XmlObjectSerializer
    interface IFormatter
Public NotInheritable Class NetDataContractSerializer
Inherits XmlObjectSerializer
Implements IFormatter
繼承
NetDataContractSerializer
實作

範例

以下範例程式碼顯示一個名為 Person 的型別,該型別被序列化為 NetDataContractSerializer。 屬性 DataContractAttribute 套用到類別,而 則 DataMemberAttribute 套用到成員(包括一個私有成員)以指示 NetDataContractSerializer 要序列化的 what。

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the NetDataContractSerializer.
[DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
class Person : IExtensibleDataObject
{
    [DataMember()]
    public string FirstName;
    [DataMember]
    public string LastName;
    [DataMember()]
    public int ID;

    public Person(string newfName, string newLName, int newID)
    {
        FirstName = newfName;
        LastName = newLName;
        ID = newID;
    }

    private ExtensionDataObject extensionData_Value;

    public ExtensionDataObject ExtensionData
    {
        get
        {
            return extensionData_Value;
        }
        set
        {
            extensionData_Value = value;
        }
    }
}

public sealed class Test
{
    private Test() { }

    public static void Main()
    {
        try
        {
            WriteObject("NetDataContractSerializerExample.xml");
            ReadObject("NetDataContractSerializerExample.xml");
        }

        catch (SerializationException serExc)
        {
            Console.WriteLine("Serialization Failed");
            Console.WriteLine(serExc.Message);
        }
        catch (Exception exc)
        {
            Console.WriteLine(
            "The serialization operation failed: {0} StackTrace: {1}",
            exc.Message, exc.StackTrace);
        }

        finally
        {
            Console.WriteLine("Press <Enter> to exit....");
            Console.ReadLine();
        }
    }

    public static void WriteObject(string fileName)
    {
        Console.WriteLine(
            "Creating a Person object and serializing it.");
        Person p1 = new Person("Zighetti", "Barbara", 101);
        FileStream fs = new FileStream(fileName, FileMode.Create);
        XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
        NetDataContractSerializer ser =
            new NetDataContractSerializer();
        ser.WriteObject(writer, p1);
        writer.Close();
    }

    public static void ReadObject(string fileName)
    {
        Console.WriteLine("Deserializing an instance of the object.");
        FileStream fs = new FileStream(fileName,
        FileMode.Open);
        XmlDictionaryReader reader =
            XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
        NetDataContractSerializer ser = new NetDataContractSerializer();

        // Deserialize the data and read it from the instance.
        Person deserializedPerson =
            (Person)ser.ReadObject(reader, true);
        fs.Close();
        Console.WriteLine(String.Format("{0} {1}, ID: {2}",
        deserializedPerson.FirstName, deserializedPerson.LastName,
        deserializedPerson.ID));
    }
}
' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the NetDataContractSerializer.
<DataContract(Name := "Customer", [Namespace] := "http://www.contoso.com")>  _
Class Person
    Implements IExtensibleDataObject
    <DataMember()>  _
    Public FirstName As String
    <DataMember()>  _
    Public LastName As String
    <DataMember()>  _
    Public ID As Integer
    
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, _
       ByVal newID As Integer) 
        FirstName = newfName
        LastName = newLName
        ID = newID
    
    End Sub 
    
    Private extensionData_Value As ExtensionDataObject
    
    
    Public Property ExtensionData() As ExtensionDataObject _
     Implements IExtensibleDataObject.ExtensionData
        Get
            Return extensionData_Value
        End Get
        Set
            extensionData_Value = value
        End Set
    End Property
End Class 


NotInheritable Public Class Test

    Private Sub New() 
    
    End Sub
     
    Public Shared Sub Main() 
        Try
            WriteObject("NetDataContractSerializerExample.xml")
            ReadObject("NetDataContractSerializerExample.xml")
        
        Catch serExc As SerializationException
            Console.WriteLine("Serialization Failed")
            Console.WriteLine(serExc.Message)
        Catch exc As Exception
            Console.WriteLine("The serialization operation failed: {0} StackTrace: {1}", exc.Message, exc.StackTrace)
        
        Finally
            Console.WriteLine("Press <Enter> to exit....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Public Shared Sub WriteObject(ByVal fileName As String) 
        Console.WriteLine("Creating a Person object and serializing it.")
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()

        ser.WriteObject(writer, p1)
        writer.Close()
    
    End Sub     

    Public Shared Sub ReadObject(ByVal fileName As String) 
        Console.WriteLine("Deserializing an instance of the object.")
        Dim fs As New FileStream(fileName, FileMode.Open)
        Dim reader As XmlDictionaryReader = _
           XmlDictionaryReader.CreateTextReader(fs, New XmlDictionaryReaderQuotas())
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()
        
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
    
    End Sub 
End Class

備註

安全性

NetDataContractSerializer 不安全感。 如需詳細資訊,請參閱 BinaryFormatter 安全性指南

NetDataContractSerializerDataContractSerializer 一點重要差異:在 NetDataContractSerializer 序列化 XML 中包含 CLR 類型資訊,而 則 DataContractSerializer 沒有。 因此,只有當序列化與反序列化兩端共享相同的 CLR 類型時,才能 NetDataContractSerializer 使用

序列化器可以序列化已套用 or SerializableAttribute 屬性的DataContractAttribute類型。 它也會序列化實作 ISerializable的型別。

欲了解更多序列化相關資訊,請參閱 序列化與反序列化

與 XElement 不相容

XElement 類別用於撰寫 XML。 然而,無法 NetDataContractSerializer 序列化該類型的實例。 因此,以下程式碼在例外情況下失敗:「根型別 'System.Xml.Linq.XElement' 在 NetDataContractSerializer 頂層不支援,因為它可透過 IsAny=true IXmlSerializiz,且必須寫入所有內容,包括根元素。」

FileStream fs = new FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite);
XElement myElement = new XElement("Parent", new XElement("child1", "form"),
    new XElement("child2", "base"),
    new XElement("child3", "formbase")
    );
NetDataContractSerializer dcs = new NetDataContractSerializer();
dcs.WriteObject(fs, myElement);
Dim fs As New FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite)
Dim myElement As New XElement("Parent", New XElement("child1", "form"), _
    New XElement("child2", "base"), _
    New XElement("child3", "formbase") _
    )
Dim ser As New System.Runtime.Serialization. _
  NetDataContractSerializer()
ser.WriteObject(fs, myElement)

然而,如果 被 XElement 用作類別欄位或屬性的型別,該欄位或屬性所包含的資料會被序列化。 這是因為作為類別成員,資料並非類別的頂層。

建構函式

名稱 Description
NetDataContractSerializer()

初始化 NetDataContractSerializer 類別的新執行個體。

NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

初始化使用所提供的上下文資料的新類別實例 NetDataContractSerializer ;此外,指定物件中要序列化的最大項目數量,以及參數以指定是否忽略額外資料,組合語言載入方法,以及代理選擇器。

NetDataContractSerializer(StreamingContext)

用提供的串流上下文資料初始化類別的新實例 NetDataContractSerializer

NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

以提供的上下文資料、根名稱與命名空間初始化該類別的新實例 NetDataContractSerializer ;此外,指定物件中要序列化的最大項目數量,以及參數以指定是否忽略額外資料、組合載入方法,以及代理選擇器。

NetDataContractSerializer(String, String)

初始化一個新的類別實例 NetDataContractSerializer ,使用提供的 XML 根元素與命名空間。

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

初始化一個新的類別實例 NetDataContractSerializer ,包含所提供的上下文資料、根名稱與命名空間(作為 XmlDictionaryString 參數);此外,指定物件中要序列化的最大項目數量,以及參數以指定是否忽略額外資料、組合語言載入方法,以及代理選擇器。

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

初始化一個新的類別實例 NetDataContractSerializer ,使用兩個參數為 的 XmlDictionaryString 型別,包含根元素與用來指定內容的命名空間。

屬性

名稱 Description
AssemblyFormat

會得到一個值,指定一種定位與裝載組件的方法。

Binder

取得或設定一個物件來控制類別載入。

Context

取得或設定一個物件,使得在序列化或反序列化時傳遞有用的上下文資料。

IgnoreExtensionDataObject

會得到一個值,指定物件擴充所提供的資料是否被忽略。

MaxItemsInObjectGraph

取得物件中被序列化的最大允許項目數量。

SurrogateSelector

取得或設定一個物件,協助格式化器在選擇序列化代理檔時使用。

方法

名稱 Description
Deserialize(Stream)

將 XML 文件或串流反序列化成物件。

Equals(Object)

判斷指定的 物件是否等於目前的物件。

(繼承來源 Object)
GetHashCode()

做為預設雜湊函式。

(繼承來源 Object)
GetType()

取得目前實例的 Type

(繼承來源 Object)
IsStartObject(XmlDictionaryReader)

判斷是否 XmlDictionaryReader 位於可使用指定讀取器反序列化的物件上。

IsStartObject(XmlReader)

判斷是否 XmlReader 位於可使用指定讀取器反序列化的物件上。

MemberwiseClone()

建立目前 Object的淺層複本。

(繼承來源 Object)
ReadObject(Stream)

讀取帶有 的 Stream XML 串流或文件,並回傳反序列化的物件。

(繼承來源 XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

讀取 XML XmlDictionaryReader 串流或文件,並回傳反序列化的物件;同時檢查物件資料是否符合建立序列化器的名稱與命名空間。

ReadObject(XmlDictionaryReader)

讀取 XML 文件或串流, XmlDictionaryReader 並回傳反序列化的物件。

(繼承來源 XmlObjectSerializer)
ReadObject(XmlReader, Boolean)

讀取 XML XmlDictionaryReader 串流或文件,並回傳反序列化的物件;同時檢查物件資料是否符合建立序列化器的名稱與命名空間。

ReadObject(XmlReader)

讀取 XML 串流或文件 XmlDictionaryReader ,並回傳反序列化的物件。

Serialize(Stream, Object)

使用指定的寫入者序列化指定的物件圖。

ToString()

傳回表示目前 物件的字串。

(繼承來源 Object)
WriteEndObject(XmlDictionaryWriter)

使用 XmlDictionaryWriter. 來寫入結尾的 XML 元素。

WriteEndObject(XmlWriter)

使用 XmlWriter. 來寫入結尾的 XML 元素。

WriteObject(Stream, Object)

將物件的完整內容(起始、內容及結束)寫入 XML 文件或串流,並指定為 Stream

(繼承來源 XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

將物件的完整內容(起始、內容及結束)寫入 XML 文件或串流,並指定為 XmlDictionaryWriter

(繼承來源 XmlObjectSerializer)
WriteObject(XmlWriter, Object)

將物件的完整內容(起始、內容及結束)寫入 XML 文件或串流,並指定為 XmlWriter

WriteObjectContent(XmlDictionaryWriter, Object)

使用 XmlDictionaryWriter. 來撰寫 XML 內容。

WriteObjectContent(XmlWriter, Object)

使用 XmlWriter. 來撰寫 XML 內容。

WriteStartObject(XmlDictionaryWriter, Object)

使用 XmlDictionaryWriter. 來寫入開頭的 XML 元素。

WriteStartObject(XmlWriter, Object)

使用 XmlWriter. 來寫入開頭的 XML 元素。

適用於

另請參閱