System.Xml.Serialization.XmlSerializer 類別

本文提供此 API 參考文件的補充備註。

XML 串行化是將物件的公用屬性和欄位轉換成儲存或傳輸的序列格式（在此案例中為 XML）的程式。反序列化會從 XML 輸出中重新建立物件的原始狀態。您可以將串行化視為將物件狀態儲存至數據流或緩衝區的方式。例如，ASP.NET 使用類別 XmlSerializer 來編碼 XML Web 服務訊息。

對象中的數據是利用程式設計語言的構造來描述，例如類別、欄位、屬性、基本類型、陣列，甚至是以XmlElement或XmlAttribute物件形式內嵌的 XML。您可以選擇建立自己的類別、以屬性標註，或使用 XML 架構定義工具（Xsd.exe）根據現有的 XML 架構定義（ XSD）檔案產生類別。如果您有一個 XML 架構，您可以執行 Xsd.exe，以生成一組與該架構強型別匹配的類別，並在序列化時加上符合架構的屬性註解。

若要在物件與 XML 之間傳輸數據，需要將程式語言結構映射到 XML 架構，並將 XML 架構映射回程式語言結構。 XmlSerializer 及 Xsd.exe 等相關工具在設計時間和執行時間提供這兩種技術之間的橋樑。在設計時間，使用 Xsd.exe 從自定義類別產生 XML 架構檔（.xsd），或從指定的架構產生類別。不論是哪一種情況，類別都以自定義屬性標註，以指示 XmlSerializer 如何在 XML 架構系統與 Common Language Runtime 之間對應。在運行時間，類別的實例可以串行化為遵循指定架構的 XML 檔。同樣地，這些 XML 檔也可以反序列化為運行時間物件。請注意，XML 架構是選擇性的，在設計時間或運行時間不需要。

控件產生的 XML

若要控制產生的 XML，您可以將特殊屬性套用至類別和成員。例如，若要指定不同的 XML 項目名稱，請將套用 XmlElementAttribute 至公用字段或屬性，並設定 ElementName 屬性。如需類似屬性的完整清單，請參閱控制 XML 串行化的屬性。您也可以實作 IXmlSerializable 介面來控制 XML 輸出。

如果產生的 XML 必須符合萬維網協會文件的第 5 節，簡單物件存取協定（SOAP）1.1，您必須使用 XmlSerializer來建構 XmlTypeMapping。若要進一步控制編碼的SOAP XML，請使用控制編碼SOAP串行化之屬性中列出的屬性。

使用XmlSerializer，您可以充分利用強型別類別的優勢，同時仍然享有 XML 的彈性。在您的強類型化類別中，使用類型為 XmlElement、XmlAttribute 或 XmlNode 的欄位或屬性，可以將 XML 檔的一部分直接讀入 XML 物件。

如果您使用可延伸的 XML 架構，也可以使用 XmlAnyElementAttribute 和 XmlAnyAttributeAttribute 屬性來序列化和反序列化原始架構中找不到的元素或屬性。若要使用物件，請將套用 XmlAnyElementAttribute 至傳回物件陣列的 XmlElement 欄位，或將套用 XmlAnyAttributeAttribute 至傳回物件陣列的 XmlAttribute 欄位。

如果屬性或欄位傳回複雜物件（例如陣列或類別實例），XmlSerializer 會將它轉換成巢狀在主要 XML 檔中的元素。例如，下列程式代碼中的第一個類別會傳回第二個類別的實例。

Public Class MyClass
    Public MyObjectProperty As MyObject
End Class

Public Class MyObject
    Public ObjectName As String
End Class

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

序列化的 XML 輸出如下所示：

<MyClass>
  <MyObjectProperty>
  <ObjectName>My String</ObjectName>
  </MyObjectProperty>
</MyClass>

如果架構包含選擇性的專案（minOccurs = '0'），或者如果架構包含預設值，則您有兩個選項。其中一個選項是使用 System.ComponentModel.DefaultValueAttribute 來指定預設值，如下列程式代碼所示。

Public Class PurchaseOrder
    <System.ComponentModel.DefaultValueAttribute ("2002")> _
    Public Year As String
End Class

public class PurchaseOrder
{
    [System.ComponentModel.DefaultValueAttribute ("2002")]
    public string Year;
}

另一個選項是使用特殊模式來建立由 XmlSerializer 辨識的布爾值欄位，並將 XmlIgnoreAttribute 套用至該欄位。模式會以propertyNameSpecified的形式創建。例如，如果有名為「MyFirstName」的欄位，您也會建立名為「MyFirstNameSpecified」的字段，指示 XmlSerializer 是否要產生名為 “MyFirstName” 的 XML 元素。下列範例會顯示這一點。

Public Class OptionalOrder
    ' This field's value should not be serialized
    ' if it is uninitialized.
    Public FirstOrder As String

    ' Use the XmlIgnoreAttribute to ignore the
    ' special field named "FirstOrderSpecified".
    <System.Xml.Serialization.XmlIgnoreAttribute> _
    Public FirstOrderSpecified As Boolean
End Class

public class OptionalOrder
{
    // This field should not be serialized
    // if it is uninitialized.
    public string FirstOrder;

    // Use the XmlIgnoreAttribute to ignore the
    // special field named "FirstOrderSpecified".
    [System.Xml.Serialization.XmlIgnoreAttribute]
    public bool FirstOrderSpecified;
}

覆寫預設序列化

** 您也可以藉由建立適當的屬性，並將其添加到 XmlAttributes 類別的實例中，以覆寫任何一組物件及其欄位和屬性的序列化。以這種方式覆寫串行化有兩個用途：第一，即使您沒有來源的存取權，您也可以控制及增強 DLL 中找到的物件串行化;第二，您可以建立一組可串行化的類別，但以多種方式串行化物件。如需詳細資訊，請參閱 XmlAttributeOverrides 類別和如何：控制衍生類別的串行化。

若要串行化物件，請呼叫 Serialize 方法。若要還原串行化物件，請呼叫 Deserialize 方法。

若要將 XML 命名空間新增至 XML 檔，請參閱 XmlSerializerNamespaces。

備註

XmlSerializer 為實作 IEnumerable 或 ICollection 的類別提供特殊處理。實作的 IEnumerable 類別必須實作採用單一參數的公用 Add 方法。方法 Add 的參數類型必須與從 Current 所傳回的值上的GetEnumerator 屬性所傳回的類型相同，或者是該類型的其中一個基底類型。實作 ICollection（例如 CollectionBase）並且包括 IEnumerable 的類別必須具有一個接受整數的公用Item索引屬性（在 C# 中稱為 indexer），而且還必須具有一個整數類型的公用Count屬性。方法的參數 Add 必須與從 Item 屬性傳回的型別相同，或是該型別的其中一個基底。要串行化的值是從實作 ICollection 的類別中的索引 Item 屬性中取得，而不是透過呼叫 GetEnumerator。

您必須具有寫入暫存目錄的許可權（如 TEMP 環境變數所定義），才能還原串行化物件。

動態生成的組件

為了提升效能，XML 序列化架構會動態生成組件，以序列化和還原序列化指定的型別。基礎結構會尋找並重複使用這些元件。只有在使用下列建構函式時，才會發生此行為：

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

如果您使用任何其他建構函式，就會產生多個相同元件的版本，而且永遠不會卸除，這會導致記憶體流失和效能不佳。最簡單的解決方案是使用先前提及的兩個建構函式之一。否則，您必須在Hashtable中快取元件，如下列範例所示。

Hashtable serializers = new Hashtable();

// Use the constructor that takes a type and XmlRootAttribute.
XmlSerializer s = new XmlSerializer(typeof(MyClass), myRoot);

// Implement a method named GenerateKey that creates unique keys
// for each instance of the XmlSerializer. The code should take
// into account all parameters passed to the XmlSerializer
// constructor.
object key = GenerateKey(typeof(MyClass), myRoot);

// Check the local cache for a matching serializer.
XmlSerializer ser = (XmlSerializer)serializers[key];
if (ser == null)
{
    ser = new XmlSerializer(typeof(MyClass), myRoot);
    // Cache the serializer.
    serializers[key] = ser;
}

// Use the serializer to serialize or deserialize.

Dim serializers As New Hashtable()

' Use the constructor that takes a type and XmlRootAttribute.
Dim s As New XmlSerializer(GetType([MyClass]), myRoot)

' Implement a method named GenerateKey that creates unique keys
' for each instance of the XmlSerializer. The code should take
' into account all parameters passed to the XmlSerializer
' constructor.
Dim key As Object = GenerateKey(GetType([MyClass]), myRoot)

' Check the local cache for a matching serializer.
Dim ser As XmlSerializer = CType(serializers(key), XmlSerializer)

If ser Is Nothing Then
    ser = New XmlSerializer(GetType([MyClass]), myRoot)
    ' Cache the serializer.
    serializers(key) = ser
End If

' Use the serializer to serialize or deserialize.

ArrayList 和泛型清單的串行化

XmlSerializer無法序列化或反序列化下列項目：

的陣列 ArrayList
的陣列 List<T>

無符號 Long 列舉的序列化

XmlSerializer如果下列條件成立，則無法具現化來串行化列舉：列舉型別為未帶正負號的long （ulong在 C# 中為），而且列舉包含任何大於9,223,372,036,854,775,807 的成員。例如，下列內容無法被序列化。

public enum LargeNumbers: ulong
{
    a = 9223372036854775808
}
// At runtime, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));

過時的類型

類別 XmlSerializer 不會串行化標示為 [Obsolete]的物件。

意見反應

此頁面對您有幫助嗎？

Last updated on 2025-06-17