XmlSerializer 建構函式
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
初始化 XmlSerializer 類別的新執行個體。
多載
| 名稱 | Description |
|---|---|
| XmlSerializer() |
初始化 XmlSerializer 類別的新執行個體。 |
| XmlSerializer(Type) |
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 |
| XmlSerializer(XmlTypeMapping) |
使用一個將一個類型映射到另一個類型的物件來初始化該 XmlSerializer 類別的實例。 |
| XmlSerializer(Type, String) |
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 指定所有 XML 元素的預設命名空間。 |
| XmlSerializer(Type, Type[]) |
初始化一個新的類別實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 如果某個屬性或欄位回傳陣列,該 |
| XmlSerializer(Type, XmlAttributeOverrides) |
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載可以用其他類別覆蓋這些類別。 |
| XmlSerializer(Type, XmlRootAttribute) |
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 它也指定了作為 XML 根元素的類別。 |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String) |
初始化該類別的新實例,該實例 XmlSerializer 能將 類型的 Object 物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為型別 Object為 的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載會用其他類別覆蓋這些類別。 此過載同時指定所有 XML 元素的預設命名空間,以及作為 XML 根元素的類別。 |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String) |
初始化該類別的新實例,該實例 XmlSerializer 能將 類型的 Object 物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為型別 Object為 的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載會用其他類別覆蓋這些類別。 此過載同時指定所有 XML 元素的預設命名空間,以及作為 XML 根元素的類別。 |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence) |
已淘汰.
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為指定類型的物件。 這種過載讓你能提供序列化或反序列化操作中可能遇到的其他類型,以及所有 XML 元素的預設命名空間、用作 XML 根元素的類別、其位置,以及存取所需的憑證。 |
XmlSerializer()
初始化 XmlSerializer 類別的新執行個體。
protected:
XmlSerializer();
protected XmlSerializer();
Protected Sub New ()
適用於
XmlSerializer(Type)
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。
public:
XmlSerializer(Type ^ type);
public XmlSerializer(Type type);
new System.Xml.Serialization.XmlSerializer : Type -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
範例
以下範例構造 , XmlSerializer 序列化一個名為 Widget的物件。 範例在呼叫 Serialize 方法前先設定物件的各種屬性。
private void SerializeObject(string filename)
{
XmlSerializer serializer =
new XmlSerializer(typeof(OrderedItem));
// Create an instance of the class to be serialized.
OrderedItem i = new OrderedItem();
// Set the public property values.
i.ItemName = "Widget";
i.Description = "Regular Widget";
i.Quantity = 10;
i.UnitPrice = (decimal) 2.30;
// Writing the document requires a TextWriter.
TextWriter writer = new StreamWriter(filename);
// Serialize the object, and close the TextWriter.
serializer.Serialize(writer, i);
writer.Close();
}
// This is the class that will be serialized.
public class OrderedItem
{
public string ItemName;
public string Description;
public decimal UnitPrice;
public int Quantity;
}
Private Sub SerializeObject(ByVal filename As String)
Dim serializer As New XmlSerializer(GetType(OrderedItem))
' Create an instance of the class to be serialized.
Dim i As New OrderedItem()
' Set the public property values.
With i
.ItemName = "Widget"
.Description = "Regular Widget"
.Quantity = 10
.UnitPrice = CDec(2.3)
End With
' Writing the document requires a TextWriter.
Dim writer As New StreamWriter(filename)
' Serialize the object, and close the TextWriter.
serializer.Serialize(writer, i)
writer.Close()
End Sub
' This is the class that will be serialized.
Public Class OrderedItem
Public ItemName As String
Public Description As String
Public UnitPrice As Decimal
Public Quantity As Integer
End Class
備註
通常,應用程式會定義多個類別,並將其 XmlSerializer 轉換成單一的 XML 實例文件。 然而,必須 XmlSerializer 只知道一種型別——代表 XML 根元素的類別型別。 它 XmlSerializer 會自動序列化所有從屬類別實例。 同樣地,反序列化只需 XML 根元素的型別。
另請參閱
- Serialize(TextWriter, Object)
- Deserialize(Stream)
- XmlAttributes
- XML 序列化簡介
- 如何:為 XML 串流指定替代元素名稱
- 使用屬性控制 XML 串行化
- XML 序列化範例
- XML 架構定義工具 (Xsd.exe)
適用於
XmlSerializer(XmlTypeMapping)
使用一個將一個類型映射到另一個類型的物件來初始化該 XmlSerializer 類別的實例。
public:
XmlSerializer(System::Xml::Serialization::XmlTypeMapping ^ xmlTypeMapping);
public XmlSerializer(System.Xml.Serialization.XmlTypeMapping xmlTypeMapping);
new System.Xml.Serialization.XmlSerializer : System.Xml.Serialization.XmlTypeMapping -> System.Xml.Serialization.XmlSerializer
Public Sub New (xmlTypeMapping As XmlTypeMapping)
參數
- xmlTypeMapping
- XmlTypeMapping
一個 XmlTypeMapping 將一種類型映射到另一種的類型。
範例
以下範例序列化一個名為 Group的類別。 、欄位IgnoreThis及枚舉成員GroupType的序列化GroupName會被覆寫。 在此CreateOverrideSerializer方法中,建立一個SoapAttributeOverrides物件,對於每個覆寫的成員或枚舉SoapAttributes,建立一個帶有適當屬性的物件,並加入物件。SoapAttributeOverrides
XmlMapping物件是用該SoapAttributeOverrides物件建立的,而該物件則用來XmlMapping建立覆蓋預設序列化的 。XmlSerializer
using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;
public class Group
{
[SoapAttribute (Namespace = "http://www.cpandl.com")]
public string GroupName;
[SoapAttribute(DataType = "base64Binary")]
public Byte [] GroupNumber;
[SoapAttribute(DataType = "date", AttributeName = "CreationDate")]
public DateTime Today;
[SoapElement(DataType = "nonNegativeInteger", ElementName = "PosInt")]
public string PostitiveInt;
// This is ignored when serialized unless it's overridden.
[SoapIgnore]
public bool IgnoreThis;
public GroupType Grouptype;
public Vehicle MyVehicle;
// The SoapInclude allows the method to return a Car.
[SoapInclude(typeof(Car))]
public Vehicle myCar(string licNumber)
{
Vehicle v;
if(licNumber == "")
{
v = new Car();
v.licenseNumber = "!!!!!!";
}
else
{
v = new Car();
v.licenseNumber = licNumber;
}
return v;
}
}
// SoapInclude allows Vehicle to accept Car type.
[SoapInclude(typeof(Car))]
public abstract class Vehicle
{
public string licenseNumber;
public DateTime makeDate;
}
public class Car: Vehicle
{
}
public enum GroupType
{
// These enums can be overridden.
[SoapEnum("Small")]
A,
[SoapEnum("Large")]
B
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.SerializeOriginal("SoapOriginal.xml");
test.SerializeOverride("SoapOverrides.xml");
test.DeserializeOriginal("SoapOriginal.xml");
test.DeserializeOverride("SoapOverrides.xml");
}
public void SerializeOriginal(string filename)
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping myMapping =
(new SoapReflectionImporter().ImportTypeMapping(
typeof(Group)));
XmlSerializer mySerializer =
new XmlSerializer(myMapping);
Group myGroup=MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter writer =
new XmlTextWriter(filename, Encoding.UTF8);
writer.Formatting = Formatting.Indented;
writer.WriteStartElement("wrapper");
// Serialize the class, and close the TextWriter.
mySerializer.Serialize(writer, myGroup);
writer.WriteEndElement();
writer.Close();
}
public void SerializeOverride(string filename)
{
// Create an instance of the XmlSerializer class
// that overrides the serialization.
XmlSerializer overRideSerializer = CreateOverrideSerializer();
Group myGroup=MakeGroup();
// Writing the file requires a TextWriter.
XmlTextWriter writer =
new XmlTextWriter(filename, Encoding.UTF8);
writer.Formatting = Formatting.Indented;
writer.WriteStartElement("wrapper");
// Serialize the class, and close the TextWriter.
overRideSerializer.Serialize(writer, myGroup);
writer.WriteEndElement();
writer.Close();
}
private Group MakeGroup(){
// Create an instance of the class that will be serialized.
Group myGroup = new Group();
// Set the object properties.
myGroup.GroupName = ".NET";
Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
Convert.ToByte(50)};
myGroup.GroupNumber = hexByte;
DateTime myDate = new DateTime(2002,5,2);
myGroup.Today = myDate;
myGroup.PostitiveInt= "10000";
myGroup.IgnoreThis=true;
myGroup.Grouptype= GroupType.B;
Car thisCar =(Car) myGroup.myCar("1234566");
myGroup.MyVehicle=thisCar;
return myGroup;
}
public void DeserializeOriginal(string filename)
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping myMapping =
(new SoapReflectionImporter().ImportTypeMapping(
typeof(Group)));
XmlSerializer mySerializer =
new XmlSerializer(myMapping);
// Reading the file requires an XmlTextReader.
XmlTextReader reader=
new XmlTextReader(filename);
reader.ReadStartElement("wrapper");
// Deserialize and cast the object.
Group myGroup;
myGroup = (Group) mySerializer.Deserialize(reader);
reader.ReadEndElement();
reader.Close();
}
public void DeserializeOverride(string filename)
{
// Create an instance of the XmlSerializer class.
XmlSerializer overRideSerializer = CreateOverrideSerializer();
// Reading the file requires an XmlTextReader.
XmlTextReader reader=
new XmlTextReader(filename);
reader.ReadStartElement("wrapper");
// Deserialize and cast the object.
Group myGroup;
myGroup = (Group) overRideSerializer.Deserialize(reader);
reader.ReadEndElement();
reader.Close();
ReadGroup(myGroup);
}
private void ReadGroup(Group myGroup){
Console.WriteLine(myGroup.GroupName);
Console.WriteLine(myGroup.GroupNumber[0]);
Console.WriteLine(myGroup.GroupNumber[1]);
Console.WriteLine(myGroup.Today);
Console.WriteLine(myGroup.PostitiveInt);
Console.WriteLine(myGroup.IgnoreThis);
Console.WriteLine();
}
private XmlSerializer CreateOverrideSerializer()
{
SoapAttributeOverrides mySoapAttributeOverrides =
new SoapAttributeOverrides();
SoapAttributes soapAtts = new SoapAttributes();
SoapElementAttribute mySoapElement = new SoapElementAttribute();
mySoapElement.ElementName = "xxxx";
soapAtts.SoapElement = mySoapElement;
mySoapAttributeOverrides.Add(typeof(Group), "PostitiveInt",
soapAtts);
// Override the IgnoreThis property.
SoapIgnoreAttribute myIgnore = new SoapIgnoreAttribute();
soapAtts = new SoapAttributes();
soapAtts.SoapIgnore = false;
mySoapAttributeOverrides.Add(typeof(Group), "IgnoreThis",
soapAtts);
// Override the GroupType enumeration.
soapAtts = new SoapAttributes();
SoapEnumAttribute xSoapEnum = new SoapEnumAttribute();
xSoapEnum.Name = "Over1000";
soapAtts.SoapEnum = xSoapEnum;
// Add the SoapAttributes to the
// mySoapAttributeOverridesrides object.
mySoapAttributeOverrides.Add(typeof(GroupType), "A",
soapAtts);
// Create second enumeration and add it.
soapAtts = new SoapAttributes();
xSoapEnum = new SoapEnumAttribute();
xSoapEnum.Name = "ZeroTo1000";
soapAtts.SoapEnum = xSoapEnum;
mySoapAttributeOverrides.Add(typeof(GroupType), "B",
soapAtts);
// Override the Group type.
soapAtts = new SoapAttributes();
SoapTypeAttribute soapType = new SoapTypeAttribute();
soapType.TypeName = "Team";
soapAtts.SoapType = soapType;
mySoapAttributeOverrides.Add(typeof(Group),soapAtts);
// Create an XmlTypeMapping that is used to create an instance
// of the XmlSerializer. Then return the XmlSerializer object.
XmlTypeMapping myMapping = (new SoapReflectionImporter(
mySoapAttributeOverrides)).ImportTypeMapping(typeof(Group));
XmlSerializer ser = new XmlSerializer(myMapping);
return ser;
}
}
Imports System.IO
Imports System.Text
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema
Public Class Group
<SoapAttribute (Namespace:= "http:'www.cpandl.com")> _
Public GroupName As String
<SoapAttribute(DataType:= "base64Binary")> _
Public GroupNumber() As Byte
<SoapAttribute(DataType:= "date", _
AttributeName:= "CreationDate")> _
Public Today As DateTime
<SoapElement(DataType:= "nonNegativeInteger", _
ElementName:= "PosInt")> _
Public PostitiveInt As String
' This is ignored when serialized unless it's overridden.
<SoapIgnore> _
Public IgnoreThis As Boolean
Public Grouptype As GroupType
Public MyVehicle As Vehicle
' The SoapInclude allows the method to return a Car.
<SoapInclude(GetType(Car))> _
Public Function myCar(licNumber As String ) As Vehicle
Dim v As Vehicle
if licNumber = "" Then
v = New Car()
v.licenseNumber = "!!!!!!"
else
v = New Car()
v.licenseNumber = licNumber
End If
return v
End Function
End Class
' SoapInclude allows Vehicle to accept Car type.
<SoapInclude(GetType(Car))> _
Public MustInherit class Vehicle
Public licenseNumber As String
Public makeDate As DateTime
End Class
Public Class Car
Inherits Vehicle
End Class
Public enum GroupType
' These enums can be overridden.
<SoapEnum("Small")> _
A
<SoapEnum("Large")> _
B
End Enum
Public Class Run
Shared Sub Main()
Dim test As Run = New Run()
test.SerializeOriginal("SoapOriginal.xml")
test.SerializeOverride("SoapOverrides.xml")
test.DeserializeOriginal("SoapOriginal.xml")
test.DeserializeOverride("SoapOverrides.xml")
End SUb
Public Sub SerializeOriginal(filename As String)
' Create an instance of the XmlSerializer class.
Dim myMapping As XmlTypeMapping = _
(New SoapReflectionImporter().ImportTypeMapping _
(GetType(Group)))
Dim mySerializer As XmlSerializer = _
New XmlSerializer(myMapping)
Dim myGroup As Group =MakeGroup()
' Writing the file requires a TextWriter.
Dim writer As XmlTextWriter = _
New XmlTextWriter(filename, Encoding.UTF8)
writer.Formatting = Formatting.Indented
writer.WriteStartElement("wrapper")
' Serialize the class, and close the TextWriter.
mySerializer.Serialize(writer, myGroup)
writer.WriteEndElement()
writer.Close()
End Sub
Public Sub SerializeOverride(filename As String)
' Create an instance of the XmlSerializer class
' that overrides the serialization.
Dim overRideSerializer As XmlSerializer = _
CreateOverrideSerializer()
Dim myGroup As Group =MakeGroup()
' Writing the file requires a TextWriter.
Dim writer As XmlTextWriter = _
New XmlTextWriter(filename, Encoding.UTF8)
writer.Formatting = Formatting.Indented
writer.WriteStartElement("wrapper")
' Serialize the class, and close the TextWriter.
overRideSerializer.Serialize(writer, myGroup)
writer.WriteEndElement()
writer.Close()
End Sub
private Function MakeGroup() As Group
' Create an instance of the class that will be serialized.
Dim myGroup As Group = New Group()
' Set the object properties.
myGroup.GroupName = ".NET"
Dim hexByte()As Byte = new Byte(1){Convert.ToByte(100), _
Convert.ToByte(50)}
myGroup.GroupNumber = hexByte
Dim myDate As DateTime = new DateTime(2002,5,2)
myGroup.Today = myDate
myGroup.PostitiveInt = "10000"
myGroup.IgnoreThis = true
myGroup.Grouptype = GroupType.B
Dim thisCar As Car
thisCar =CType(myGroup.myCar("1234566"), Car)
myGroup.myVehicle=thisCar
return myGroup
End Function
Public Sub DeserializeOriginal(filename As String)
' Create an instance of the XmlSerializer class.
Dim myMapping As XmlTypeMapping = _
(New SoapReflectionImporter().ImportTypeMapping _
(GetType(Group)))
Dim mySerializer As XmlSerializer = _
New XmlSerializer(myMapping)
' Reading the file requires an XmlTextReader.
Dim reader As XmlTextReader = _
New XmlTextReader(filename)
reader.ReadStartElement("wrapper")
' Deserialize and cast the object.
Dim myGroup As Group = _
CType(mySerializer.Deserialize(reader), Group)
reader.ReadEndElement()
reader.Close()
End Sub
Public Sub DeserializeOverride(filename As String)
' Create an instance of the XmlSerializer class.
Dim overRideSerializer As XmlSerializer = _
CreateOverrideSerializer()
' Reading the file requires an XmlTextReader.
Dim reader As XmlTextReader = _
New XmlTextReader(filename)
reader.ReadStartElement("wrapper")
' Deserialize and cast the object.
Dim myGroup As Group = _
CType(overRideSerializer.Deserialize(reader), Group)
reader.ReadEndElement()
reader.Close()
ReadGroup(myGroup)
End Sub
private Sub ReadGroup(myGroup As Group)
Console.WriteLine(myGroup.GroupName)
Console.WriteLine(myGroup.GroupNumber(0))
Console.WriteLine(myGroup.GroupNumber(1))
Console.WriteLine(myGroup.Today)
Console.WriteLine(myGroup.PostitiveInt)
Console.WriteLine(myGroup.IgnoreThis)
Console.WriteLine()
End Sub
Private Function CreateOverrideSerializer() As XmlSerializer
Dim soapOver As SoapAttributeOverrides = New SoapAttributeOverrides()
Dim soapAtts As SoapAttributes = New SoapAttributes()
Dim mySoapElement As SoapElementAttribute = New SoapElementAttribute()
mySoapElement.ElementName = "xxxx"
soapAtts.SoapElement = mySoapElement
soapOver.Add(GetType(Group), "PostitiveInt", soapAtts)
' Override the IgnoreThis property.
Dim myIgnore As SoapIgnoreAttribute = new SoapIgnoreAttribute()
soapAtts = New SoapAttributes()
soapAtts.SoapIgnore = false
soapOver.Add(GetType(Group), "IgnoreThis", soapAtts)
' Override the GroupType enumeration.
soapAtts = New SoapAttributes()
Dim xSoapEnum As SoapEnumAttribute = new SoapEnumAttribute()
xSoapEnum.Name = "Over1000"
soapAtts.SoapEnum = xSoapEnum
' Add the SoapAttributes to the SoapOverrides object.
soapOver.Add(GetType(GroupType), "A", soapAtts)
' Create second enumeration and add it.
soapAtts = New SoapAttributes()
xSoapEnum = New SoapEnumAttribute()
xSoapEnum.Name = "ZeroTo1000"
soapAtts.SoapEnum = xSoapEnum
soapOver.Add(GetType(GroupType), "B", soapAtts)
' Override the Group type.
soapAtts = New SoapAttributes()
Dim soapType As SoapTypeAttribute = New SoapTypeAttribute()
soapType.TypeName = "Team"
soapAtts.SoapType = soapType
soapOver.Add(GetType(Group),soapAtts)
Dim myMapping As XmlTypeMapping = (New SoapReflectionImporter( _
soapOver)).ImportTypeMapping(GetType(Group))
Dim ser As XmlSerializer = new XmlSerializer(myMapping)
return ser
End Function
End Class
備註
這個建構子用來建立 XmlSerializer 一個,當你將物件序列化成 SOAP 訊息時。 要控制產生的 SOAP 訊息,請使用命名空間中 System.Xml.Serialization 以「Soap」開頭的特殊屬性。
另請參閱
適用於
XmlSerializer(Type, String)
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 指定所有 XML 元素的預設命名空間。
public:
XmlSerializer(Type ^ type, System::String ^ defaultNamespace);
public XmlSerializer(Type type, string defaultNamespace);
new System.Xml.Serialization.XmlSerializer : Type * string -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, defaultNamespace As String)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
- defaultNamespace
- String
所有 XML 元素的預設命名空間。
範例
以下範例構造 , XmlSerializer 序列化一個名為 Widget的物件。 範例在呼叫 Serialize 方法前先設定物件的各種屬性。
private void SerializeObject(string filename) {
XmlSerializer serializer = new XmlSerializer
(typeof(OrderedItem), "http://www.cpandl.com");
// Create an instance of the class to be serialized.
OrderedItem i = new OrderedItem();
// Insert code to set property values.
// Writing the document requires a TextWriter.
TextWriter writer = new StreamWriter(filename);
// Serialize the object, and close the TextWriter
serializer.Serialize(writer, i);
writer.Close();
}
private void DeserializeObject(string filename) {
XmlSerializer serializer = new XmlSerializer
(typeof(OrderedItem), "http://www.cpandl.com");
// A FileStream is needed to read the XML document.
FileStream fs = new FileStream(filename, FileMode.Open);
// Declare an object variable of the type to be deserialized.
OrderedItem i;
// Deserialize the object.
i = (OrderedItem) serializer.Deserialize(fs);
// Insert code to use the properties and methods of the object.
}
Private Sub SerializeObject(ByVal filename As String)
Dim serializer As New XmlSerializer(GetType(OrderedItem), _
"http://www.cpandl.com")
' Create an instance of the class to be serialized.
Dim i As New OrderedItem()
' Insert code to set property values.
' Writing the document requires a TextWriter.
Dim writer As New StreamWriter(filename)
' Serialize the object, and close the TextWriter.
serializer.Serialize(writer, i)
writer.Close()
End Sub
Private Sub DeserializeObject(ByVal filename As String)
Dim serializer As New XmlSerializer(GetType(OrderedItem), _
"http://www.cpandl.com")
' A FileStream is needed to read the XML document.
Dim fs As New FileStream(filename, FileMode.Open)
' Declare an object variable of the type to be deserialized.
Dim i As OrderedItem
' Deserialize the object.
i = CType(serializer.Deserialize(fs), OrderedItem)
' Insert code to use the properties and methods of the object.
End Sub
另請參閱
適用於
XmlSerializer(Type, Type[])
初始化一個新的類別實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 如果某個屬性或欄位回傳陣列,該 extraTypes 參數會指定可以插入到陣列中的物件。
public:
XmlSerializer(Type ^ type, cli::array <Type ^> ^ extraTypes);
public XmlSerializer(Type type, Type[] extraTypes);
new System.Xml.Serialization.XmlSerializer : Type * Type[] -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, extraTypes As Type())
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
範例
以下範例序列化一個包含公用欄位的類別實例,該欄位會回傳一組物件。
extraTypes建構子的XmlSerializer參數指定了可在陣列中序列化的物件類型。
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
// This defines the object that will be serialized.
public class Teacher
{
public string Name;
public Teacher(){}
/* Note that the Info field returns an array of objects.
Any object can be added to the array by adding the
object type to the array passed to the extraTypes argument. */
[XmlArray (ElementName = "ExtraInfo", IsNullable = true)]
public object[] Info;
public Phone PhoneInfo;
}
// This defines one of the extra types to be included.
public class Address
{
public string City;
public Address(){}
public Address(string city)
{
City = city;
}
}
// Another extra type to include.
public class Phone
{
public string PhoneNumber;
public Phone(){}
public Phone(string phoneNumber)
{
PhoneNumber = phoneNumber;
}
}
// Another type, derived from Phone
public class InternationalPhone:Phone
{
public string CountryCode;
public InternationalPhone(){}
public InternationalPhone(string countryCode)
{
CountryCode = countryCode;
}
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.SerializeObject("Teacher.xml");
test.DeserializeObject("Teacher.xml");
}
private void SerializeObject(string filename)
{
// Writing the file requires a TextWriter.
TextWriter myStreamWriter = new StreamWriter(filename);
// Create a Type array.
Type [] extraTypes= new Type[3];
extraTypes[0] = typeof(Address);
extraTypes[1] = typeof(Phone);
extraTypes[2] = typeof(InternationalPhone);
// Create the XmlSerializer instance.
XmlSerializer mySerializer = new XmlSerializer
(typeof(Teacher),extraTypes);
Teacher teacher = new Teacher();
teacher.Name = "Mike";
// Add extra types to the Teacher object
object [] info = new object[2];
info[0] = new Address("Springville");
info[1] = new Phone("555-0100");
teacher.Info = info;
teacher.PhoneInfo = new InternationalPhone("000");
mySerializer.Serialize(myStreamWriter,teacher);
myStreamWriter.Close();
}
private void DeserializeObject(string filename)
{
// Create a Type array.
Type [] extraTypes= new Type[3];
extraTypes[0] = typeof(Address);
extraTypes[1] = typeof(Phone);
extraTypes[2] = typeof(InternationalPhone);
// Create the XmlSerializer instance.
XmlSerializer mySerializer = new XmlSerializer
(typeof(Teacher),extraTypes);
// Reading a file requires a FileStream.
FileStream fs = new FileStream(filename, FileMode.Open);
Teacher teacher = (Teacher) mySerializer.Deserialize(fs);
// Read the extra information.
Address a = (Address)teacher.Info[0];
Phone p = (Phone) teacher.Info[1];
InternationalPhone Ip =
(InternationalPhone) teacher.PhoneInfo;
Console.WriteLine(teacher.Name);
Console.WriteLine(a.City);
Console.WriteLine(p.PhoneNumber);
Console.WriteLine(Ip.CountryCode);
}
}
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
' This defines the object that will be serialized.
Public Class Teacher
Public Name As String
Public Sub New()
End Sub
' Note that the Info field returns an array of objects.
' Any object can be added to the array by adding the
' object type to the array passed to the extraTypes argument.
<XmlArray(ElementName := "ExtraInfo", IsNullable := True)> _
Public Info() As Object
Public PhoneInfo As Phone
End Class
' This defines one of the extra types to be included.
Public Class Address
Public City As String
Public Sub New()
End Sub
Public Sub New(city As String)
me.City = city
End Sub
End Class
' Another extra type to include.
Public Class Phone
Public PhoneNumber As String
Public Sub New()
End Sub
Public Sub New(phoneNumber As String)
me.PhoneNumber = phoneNumber
End Sub
End Class
' Another type, derived from Phone.
Public Class InternationalPhone
Inherits Phone
Public CountryCode As String
Public Sub New()
End Sub
Public Sub New(countryCode As String)
me.CountryCode = countryCode
End Sub
End Class
Public Class Run
Public Shared Sub Main()
Dim test As New Run()
test.SerializeObject("Teacher.xml")
test.DeserializeObject("Teacher.xml")
End Sub
Private Sub SerializeObject(filename As String)
' Writing the file requires a TextWriter.
Dim myStreamWriter As New StreamWriter(filename)
' Create a Type array.
Dim extraTypes(2) As Type
extraTypes(0) = GetType(Address)
extraTypes(1) = GetType(Phone)
extraTypes(2) = GetType(InternationalPhone)
' Create the XmlSerializer instance.
Dim mySerializer As New XmlSerializer(GetType(Teacher), extraTypes)
Dim teacher As New Teacher()
teacher.Name = "Mike"
' Add extra types to the Teacher object.
Dim info(1) As Object
info(0) = New Address("Springville")
info(1) = New Phone("555-0100")
teacher.Info = info
teacher.PhoneInfo = New InternationalPhone("000")
mySerializer.Serialize(myStreamWriter, teacher)
myStreamWriter.Close()
End Sub
Private Sub DeserializeObject(filename As String)
' Create a Type array.
Dim extraTypes(2) As Type
extraTypes(0) = GetType(Address)
extraTypes(1) = GetType(Phone)
extraTypes(2) = GetType(InternationalPhone)
' Create the XmlSerializer instance.
Dim mySerializer As New XmlSerializer(GetType(Teacher), extraTypes)
' Reading a file requires a FileStream.
Dim fs As New FileStream(filename, FileMode.Open)
Dim teacher As Teacher = CType(mySerializer.Deserialize(fs), Teacher)
' Read the extra information.
Dim a As Address = CType(teacher.Info(0), Address)
Dim p As Phone = CType(teacher.Info(1), Phone)
Dim Ip As InternationalPhone = CType(teacher.PhoneInfo, InternationalPhone)
Console.WriteLine(teacher.Name)
Console.WriteLine(a.City)
Console.WriteLine(p.PhoneNumber)
Console.WriteLine(Ip.CountryCode)
End Sub
End Class
備註
預設情況下,如果公開屬性或欄位回傳物件或物件陣列,物件類型會自動序列化。 然而,如果一個類別包含一個欄位或屬性,回傳一個型別 Object為 的陣列,任何物件都可以插入該陣列。 在這種情況下,必須指示 預期 XmlSerializer 插入陣列中的所有可能物件類型 Object 。 為此,請使用 extraTypes 參數指定要序列化或反序列化的額外物件類型。
你也可以用這個 extraTypes 參數來指定從基底類別衍生出的型別。 例如,假設存在一個名為 Phone 的基底類別,且有一個名為 InternationalPhone 的類別由它衍生出來。 也可以用參數 extraTypes 來指定導出型別。
另請參閱
適用於
XmlSerializer(Type, XmlAttributeOverrides)
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載可以用其他類別覆蓋這些類別。
public:
XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides);
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides overrides);
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, overrides As XmlAttributeOverrides)
參數
- type
- Type
要序列化的物件類型。
- overrides
- XmlAttributeOverrides
範例
以下範例序列化一個在 DLL 中定義的類別實例,為此會覆寫 DLL 中公開成員。
// Beginning of HighSchool.dll
namespace HighSchool
{
public class Student
{
public string Name;
public int ID;
}
public class MyClass
{
public Student[] Students;
}
}
namespace College
{
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using HighSchool;
public class Graduate:HighSchool.Student
{
public Graduate(){}
// Add a new field named University.
public string University;
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.WriteOverriddenAttributes("College.xml");
test.ReadOverriddenAttributes("College.xml");
}
private void WriteOverriddenAttributes(string filename)
{
// Writing the file requires a TextWriter.
TextWriter myStreamWriter = new StreamWriter(filename);
// Create an XMLAttributeOverrides class.
XmlAttributeOverrides attrOverrides =
new XmlAttributeOverrides();
// Create the XmlAttributes class.
XmlAttributes attrs = new XmlAttributes();
/* Override the Student class. "Alumni" is the name
of the overriding element in the XML output. */
XmlElementAttribute attr =
new XmlElementAttribute("Alumni", typeof(Graduate));
/* Add the XmlElementAttribute to the collection of
elements in the XmlAttributes object. */
attrs.XmlElements.Add(attr);
/* Add the XmlAttributes to the XmlAttributeOverrides.
"Students" is the name being overridden. */
attrOverrides.Add(typeof(HighSchool.MyClass),
"Students", attrs);
// Create the XmlSerializer.
XmlSerializer mySerializer = new XmlSerializer
(typeof(HighSchool.MyClass), attrOverrides);
MyClass myClass = new MyClass();
Graduate g1 = new Graduate();
g1.Name = "Jackie";
g1.ID = 1;
g1.University = "Alma Mater";
Graduate g2 = new Graduate();
g2.Name = "Megan";
g2.ID = 2;
g2.University = "CM";
Student[] myArray = {g1,g2};
myClass.Students = myArray;
mySerializer.Serialize(myStreamWriter, myClass);
myStreamWriter.Close();
}
private void ReadOverriddenAttributes(string filename)
{
/* The majority of the code here is the same as that in the
WriteOverriddenAttributes method. Because the XML being read
doesn't conform to the schema defined by the DLL, the
XMLAttributesOverrides must be used to create an
XmlSerializer instance to read the XML document.*/
XmlAttributeOverrides attrOverrides = new
XmlAttributeOverrides();
XmlAttributes attrs = new XmlAttributes();
XmlElementAttribute attr =
new XmlElementAttribute("Alumni", typeof(Graduate));
attrs.XmlElements.Add(attr);
attrOverrides.Add(typeof(HighSchool.MyClass),
"Students", attrs);
XmlSerializer readSerializer = new XmlSerializer
(typeof(HighSchool.MyClass), attrOverrides);
// To read the file, a FileStream object is required.
FileStream fs = new FileStream(filename, FileMode.Open);
MyClass myClass;
myClass = (MyClass) readSerializer.Deserialize(fs);
/* Here is the difference between reading and writing an
XML document: You must declare an object of the derived
type (Graduate) and cast the Student instance to it.*/
Graduate g;
foreach(Graduate grad in myClass.Students)
{
g = (Graduate) grad;
Console.Write(g.Name + "\t");
Console.Write(g.ID + "\t");
Console.Write(g.University + "\n");
}
}
}
}
' Beginning of HighSchool.dll
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
Imports HighSchool
Namespace HighSchool
Public Class Student
Public Name As String
Public ID As Integer
End Class
Public Class MyClass1
Public Students() As Student
End Class
End Namespace 'HighSchool
Namespace College
Public Class Graduate
Inherits HighSchool.Student
Public Sub New()
End Sub
Public University As String
End Class
Public Class Run
Public Shared Sub Main()
Dim test As New Run()
test.WriteOverriddenAttributes("College.xml")
test.ReadOverriddenAttributes("College.xml")
End Sub
Private Sub WriteOverriddenAttributes(filename As String)
' Writing the file requires a TextWriter.
Dim myStreamWriter As New StreamWriter(filename)
' Create an XMLAttributeOverrides class.
Dim attrOverrides As New XmlAttributeOverrides()
' Create the XmlAttributes class.
Dim attrs As New XmlAttributes()
' Override the Student class. "Alumni" is the name
' of the overriding element in the XML output.
Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
' Add the XmlElementAttribute to the collection of
' elements in the XmlAttributes object.
attrs.XmlElements.Add(attr)
' Add the XmlAttributes to the XmlAttributeOverrides.
' "Students" is the name being overridden.
attrOverrides.Add(GetType(HighSchool.MyClass1), "Students", attrs)
' Create the XmlSerializer.
Dim mySerializer As New XmlSerializer(GetType(HighSchool.MyClass1), attrOverrides)
Dim oMyClass As New MyClass1()
Dim g1 As New Graduate()
g1.Name = "Jackie"
g1.ID = 1
g1.University = "Alma Mater"
Dim g2 As New Graduate()
g2.Name = "Megan"
g2.ID = 2
g2.University = "CM"
Dim myArray As Student() = {g1, g2}
oMyClass.Students = myArray
mySerializer.Serialize(myStreamWriter, oMyClass)
myStreamWriter.Close()
End Sub
Private Sub ReadOverriddenAttributes(filename As String)
' The majority of the code here is the same as that in the
' WriteOverriddenAttributes method. Because the XML being read
' doesn't conform to the schema defined by the DLL, the
' XMLAttributesOverrides must be used to create an
' XmlSerializer instance to read the XML document.
Dim attrOverrides As New XmlAttributeOverrides()
Dim attrs As New XmlAttributes()
Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
attrs.XmlElements.Add(attr)
attrOverrides.Add(GetType(HighSchool.MyClass1), "Students", attrs)
Dim readSerializer As New XmlSerializer(GetType(HighSchool.MyClass1), attrOverrides)
' To read the file, a FileStream object is required.
Dim fs As New FileStream(filename, FileMode.Open)
Dim oMyClass As MyClass1
oMyClass = CType(readSerializer.Deserialize(fs), MyClass1)
' Here is the difference between reading and writing an
' XML document: You must declare an object of the derived
' type (Graduate) and cast the Student instance to it.
Dim g As Graduate
Dim grad As Graduate
For Each grad In oMyClass.Students
g = CType(grad, Graduate)
Console.Write((g.Name & ControlChars.Tab))
Console.Write((g.ID.ToString & ControlChars.Tab))
Console.Write((g.University & ControlChars.Cr))
Next grad
End Sub
End Class
End Namespace 'College
備註
此 overrides 參數可用來控制欄位與屬性如何以 XML 編碼。 這些設定會覆蓋物件上已存在的任何屬性。 當原始碼無法修改或同一類別需要多個編碼時,這非常有用。
另請參閱
- XmlAttributeOverrides
- XmlAttributes
- XML 序列化簡介
- 如何:為 XML 串流指定替代元素名稱
- 使用屬性控制 XML 串行化
- XML 序列化範例
- XML 架構定義工具 (Xsd.exe)
適用於
XmlSerializer(Type, XmlRootAttribute)
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件,並將 XML 文件反序列化為指定類型的物件。 它也指定了作為 XML 根元素的類別。
public:
XmlSerializer(Type ^ type, System::Xml::Serialization::XmlRootAttribute ^ root);
public XmlSerializer(Type type, System.Xml.Serialization.XmlRootAttribute root);
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlRootAttribute -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, root As XmlRootAttribute)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
- root
- XmlRootAttribute
一個 XmlRootAttribute 代表 XML 根元素的 。
範例
以下範例構建了 XmlSerializer 使用 的 XmlRootAttribute ,該 包含 XML 根元素的各種屬性,例如其命名空間與元素名稱。
private void SerializeObject(string filename) {
// Create an XmlRootAttribute, and set its properties.
XmlRootAttribute xRoot = new XmlRootAttribute();
xRoot.ElementName = "CustomRoot";
xRoot.Namespace = "http://www.cpandl.com";
xRoot.IsNullable = true;
// Construct the XmlSerializer with the XmlRootAttribute.
XmlSerializer serializer = new XmlSerializer
(typeof(OrderedItem),xRoot);
// Create an instance of the object to serialize.
OrderedItem i = new OrderedItem();
// Insert code to set properties of the ordered item.
// Writing the document requires a TextWriter.
TextWriter writer = new StreamWriter(filename);
serializer.Serialize(writer, i);
writer.Close();
}
private void DeserializeObject(string filename) {
// Create an XmlRootAttribute, and set its properties.
XmlRootAttribute xRoot = new XmlRootAttribute();
xRoot.ElementName = "CustomRoot";
xRoot.Namespace = "http://www.cpandl.com";
xRoot.IsNullable = true;
XmlSerializer serializer = new XmlSerializer
(typeof(OrderedItem),xRoot);
// A FileStream is needed to read the XML document.
FileStream fs = new FileStream(filename, FileMode.Open);
// Deserialize the object.
OrderedItem i = (OrderedItem) serializer.Deserialize(fs);
// Insert code to use the object's properties and methods.
}
Private Sub SerializeObject(ByVal filename As String)
' Create an XmlRootAttribute, and set its properties.
Dim xRoot As New XmlRootAttribute()
xRoot.ElementName = "CustomRoot"
xRoot.Namespace = "http://www.cpandl.com"
xRoot.IsNullable = True
' Construct the XmlSerializer with the XmlRootAttribute.
Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
' Create an instance of the object to serialize.
Dim i As New OrderedItem()
' Insert code to set properties of the ordered item.
' Writing the document requires a TextWriter.
Dim writer As New StreamWriter(filename)
serializer.Serialize(writer, i)
writer.Close()
End Sub
Private Sub DeserializeObject(ByVal filename As String)
' Create an XmlRootAttribute, and set its properties.
Dim xRoot As New XmlRootAttribute()
xRoot.ElementName = "CustomRoot"
xRoot.Namespace = "http://www.cpandl.com"
xRoot.IsNullable = True
Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
' A FileStream is needed to read the XML document.
Dim fs As New FileStream(filename, FileMode.Open)
' Deserialize the object.
Dim i As OrderedItem = CType(serializer.Deserialize(fs), OrderedItem)
' Insert code to use the object's properties and methods.
End Sub
備註
XML 文件的根元素包含所有其他元素。 預設情況下,參數 type 指定的物件會序列化為根元素。 屬性,例如根元素的 XML 元素名稱,則取自物件。type 不過,這個 root 參數允許你透過指定 XmlRootAttribute一個來替換預設物件的資訊;物件允許你設定不同的命名空間、元素名稱等等。
另請參閱
適用於
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)
初始化該類別的新實例,該實例 XmlSerializer 能將 類型的 Object 物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為型別 Object為 的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載會用其他類別覆蓋這些類別。 此過載同時指定所有 XML 元素的預設命名空間,以及作為 XML 根元素的類別。
public:
XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides, cli::array <Type ^> ^ extraTypes, System::Xml::Serialization::XmlRootAttribute ^ root, System::String ^ defaultNamespace);
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace);
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, overrides As XmlAttributeOverrides, extraTypes As Type(), root As XmlRootAttribute, defaultNamespace As String)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
- overrides
- XmlAttributeOverrides
一個 XmlAttributeOverrides 擴展或覆蓋參數中類別行為 type 的
- root
- XmlRootAttribute
一個 XmlRootAttribute 定義 XML 根元素屬性的
- defaultNamespace
- String
XML 文件中所有 XML 元素的預設命名空間。
範例
以下範例序列化一個在 DLL 中定義的類別實例,為此會覆蓋該類別中的公開成員。 範例中也指定了額外型別陣列、所有 XML 元素的預設命名空間,以及提供 XML 根元素資訊的類別。 範例假設開頭的程式碼已被編譯成名為 HighSchool的 DLL。
// Beginning of the HighSchool.dll
namespace HighSchool
{
public class Student
{
public string Name;
public int ID;
}
public class MyClass
{
public Student[] Students;
}
}
namespace College
{
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using HighSchool;
public class Graduate:HighSchool.Student
{
public Graduate(){}
// Add a new field named University.
public string University;
// Use extra types to use this field.
public object[]Info;
}
public class Address
{
public string City;
}
public class Phone
{
public string Number;
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.WriteOverriddenAttributes("College.xml");
test.ReadOverriddenAttributes("College.xml");
}
private void WriteOverriddenAttributes(string filename)
{
// Writing the file requires a TextWriter.
TextWriter myStreamWriter = new StreamWriter(filename);
// Create an XMLAttributeOverrides class.
XmlAttributeOverrides attrOverrides =
new XmlAttributeOverrides();
// Create the XmlAttributes class.
XmlAttributes attrs = new XmlAttributes();
/* Override the Student class. "Alumni" is the name
of the overriding element in the XML output. */
XmlElementAttribute attr =
new XmlElementAttribute("Alumni", typeof(Graduate));
/* Add the XmlElementAttribute to the collection of
elements in the XmlAttributes object. */
attrs.XmlElements.Add(attr);
/* Add the XmlAttributes to the XmlAttributeOverrides.
"Students" is the name being overridden. */
attrOverrides.Add(typeof(HighSchool.MyClass),
"Students", attrs);
// Create array of extra types.
Type [] extraTypes = new Type[2];
extraTypes[0]=typeof(Address);
extraTypes[1]=typeof(Phone);
// Create an XmlRootAttribute.
XmlRootAttribute root = new XmlRootAttribute("Graduates");
/* Create the XmlSerializer with the
XmlAttributeOverrides object. */
XmlSerializer mySerializer = new XmlSerializer
(typeof(HighSchool.MyClass), attrOverrides, extraTypes,
root, "http://www.microsoft.com");
MyClass myClass= new MyClass();
Graduate g1 = new Graduate();
g1.Name = "Jacki";
g1.ID = 1;
g1.University = "Alma";
Graduate g2 = new Graduate();
g2.Name = "Megan";
g2.ID = 2;
g2.University = "CM";
Student[] myArray = {g1,g2};
myClass.Students = myArray;
// Create extra information.
Address a1 = new Address();
a1.City = "Ionia";
Address a2 = new Address();
a2.City = "Stamford";
Phone p1 = new Phone();
p1.Number = "555-0101";
Phone p2 = new Phone();
p2.Number = "555-0100";
Object[]o1 = new Object[2]{a1, p1};
Object[]o2 = new Object[2]{a2,p2};
g1.Info = o1;
g2.Info = o2;
mySerializer.Serialize(myStreamWriter,myClass);
myStreamWriter.Close();
}
private void ReadOverriddenAttributes(string filename)
{
/* The majority of the code here is the same as that in the
WriteOverriddenAttributes method. Because the XML being read
doesn't conform to the schema defined by the DLL, the
XMLAttributesOverrides must be used to create an
XmlSerializer instance to read the XML document.*/
XmlAttributeOverrides attrOverrides = new
XmlAttributeOverrides();
XmlAttributes attrs = new XmlAttributes();
XmlElementAttribute attr =
new XmlElementAttribute("Alumni", typeof(Graduate));
attrs.XmlElements.Add(attr);
attrOverrides.Add(typeof(HighSchool.MyClass),
"Students", attrs);
Type [] extraTypes = new Type[2];
extraTypes[0] = typeof(Address);
extraTypes[1] = typeof(Phone);
XmlRootAttribute root = new XmlRootAttribute("Graduates");
XmlSerializer readSerializer = new XmlSerializer
(typeof(HighSchool.MyClass), attrOverrides, extraTypes,
root, "http://www.microsoft.com");
// A FileStream object is required to read the file.
FileStream fs = new FileStream(filename, FileMode.Open);
MyClass myClass;
myClass = (MyClass) readSerializer.Deserialize(fs);
/* Here is the difference between reading and writing an
XML document: You must declare an object of the derived
type (Graduate) and cast the Student instance to it.*/
Graduate g;
Address a;
Phone p;
foreach(Graduate grad in myClass.Students)
{
g = (Graduate) grad;
Console.Write(g.Name + "\t");
Console.Write(g.ID + "\t");
Console.Write(g.University + "\n");
a = (Address) g.Info[0];
Console.WriteLine(a.City);
p = (Phone) g.Info[1];
Console.WriteLine(p.Number);
}
}
}
}
'Beginning of the HighSchool.dll
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
' Imports HighSchool
Namespace HighSchool
Public Class Student
Public Name As String
Public ID As Integer
End Class
Public Class ClassRoom
Public Students() As Student
End Class
End Namespace 'HighSchool
Namespace College
Public Class Graduate
Inherits HighSchool.Student
Public Sub New()
End Sub
' Add a new field named University.
Public University As String
' Use extra types to use this field.
Public Info() As Object
End Class
Public Class Address
Public City As String
End Class
Public Class Phone
Public Number As String
End Class
Public Class Run
Public Shared Sub Main()
Dim test As New Run()
test.WriteOverriddenAttributes("College.xml")
test.ReadOverriddenAttributes("College.xml")
End Sub
Private Sub WriteOverriddenAttributes(ByVal filename As String)
' Writing the file requires a TextWriter.
Dim myStreamWriter As New StreamWriter(filename)
' Create an XMLAttributeOverrides class.
Dim attrOverrides As New XmlAttributeOverrides()
' Create the XmlAttributes class.
Dim attrs As New XmlAttributes()
' Override the Student class. "Alumni" is the name
' of the overriding element in the XML output.
Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
' Add the XmlElementAttribute to the collection of
' elements in the XmlAttributes object.
attrs.XmlElements.Add(attr)
' Add the XmlAttributes to the XmlAttributeOverrides.
' "Students" is the name being overridden.
attrOverrides.Add(GetType(HighSchool.ClassRoom), "Students", attrs)
' Create array of extra types.
Dim extraTypes(1) As Type
extraTypes(0) = GetType(Address)
extraTypes(1) = GetType(Phone)
' Create an XmlRootAttribute.
Dim root As New XmlRootAttribute("Graduates")
' Create the XmlSerializer with the
' XmlAttributeOverrides object.
Dim mySerializer As New XmlSerializer(GetType(HighSchool.ClassRoom), _
attrOverrides, extraTypes, root, "http://www.microsoft.com")
Dim oMyClass As New HighSchool.ClassRoom()
Dim g1 As New Graduate()
g1.Name = "Jacki"
g1.ID = 1
g1.University = "Alma"
Dim g2 As New Graduate()
g2.Name = "Megan"
g2.ID = 2
g2.University = "CM"
Dim myArray As HighSchool.Student() = {g1, g2}
oMyClass.Students = myArray
' Create extra information.
Dim a1 As New Address()
a1.City = "Ionia"
Dim a2 As New Address()
a2.City = "Stamford"
Dim p1 As New Phone()
p1.Number = "555-0101"
Dim p2 As New Phone()
p2.Number = "555-0100"
Dim o1() As Object = {a1, p1}
Dim o2() As Object = {a2, p2}
g1.Info = o1
g2.Info = o2
mySerializer.Serialize(myStreamWriter, oMyClass)
myStreamWriter.Close()
End Sub
Private Sub ReadOverriddenAttributes(ByVal filename As String)
' The majority of the code here is the same as that in the
' WriteOverriddenAttributes method. Because the XML being read
' doesn't conform to the schema defined by the DLL, the
' XMLAttributesOverrides must be used to create an
' XmlSerializer instance to read the XML document.
Dim attrOverrides As New XmlAttributeOverrides()
Dim attrs As New XmlAttributes()
Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
attrs.XmlElements.Add(attr)
attrOverrides.Add(GetType(HighSchool.ClassRoom), "Students", attrs)
Dim extraTypes(1) As Type
extraTypes(0) = GetType(Address)
extraTypes(1) = GetType(Phone)
Dim root As New XmlRootAttribute("Graduates")
Dim readSerializer As New XmlSerializer(GetType(HighSchool.ClassRoom), _
attrOverrides, extraTypes, root, "http://www.microsoft.com")
' A FileStream object is required to read the file.
Dim fs As New FileStream(filename, FileMode.Open)
Dim oMyClass As HighSchool.ClassRoom
oMyClass = CType(readSerializer.Deserialize(fs), HighSchool.ClassRoom)
' Here is the difference between reading and writing an
' XML document: You must declare an object of the derived
' type (Graduate) and cast the Student instance to it.
Dim g As Graduate
Dim a As Address
Dim p As Phone
Dim grad As Graduate
For Each grad In oMyClass.Students
g = CType(grad, Graduate)
Console.Write((g.Name & ControlChars.Tab))
Console.Write((g.ID & ControlChars.Tab))
Console.Write((g.University & ControlChars.Cr))
a = CType(g.Info(0), Address)
Console.WriteLine(a.City)
p = CType(g.Info(1), Phone)
Console.WriteLine(p.Number)
Next grad
End Sub
End Class
End Namespace 'College
備註
該 overrides 參數允許建立 XmlSerializer 一個序列化類別,以擴展或覆蓋基底類別的行為。 例如,給定一個 DLL,可以建立一個繼承或擴展該 DLL 中類別的類別。 要序列化此類類別,你必須在 XmlAttributeOverrides 構造 XmlSerializer. 如需詳細資訊,請參閱 XmlAttributeOverrides。
預設情況下,如果公開屬性或欄位回傳物件或物件陣列,物件類型會自動序列化。 然而,如果一個類別包含一個欄位或屬性,回傳一個型別 Object為 的陣列,任何物件都可以插入該陣列。 在這種情況下,必須指示 預期 XmlSerializer 插入陣列中的所有可能物件類型 Object 。 為此,請使用 extraTypes 參數指定要序列化或反序列化的額外物件類型。
XML 文件的根元素包含所有其他元素。 預設情況下,參數 type 指定的物件會序列化為根元素。 屬性,例如根元素的 XML 元素名稱,都是取自物件。type 不過,這個 root 參數允許你透過指定 XmlRootAttribute一個來替換預設物件的資訊;物件允許你設定不同的命名空間、元素名稱等等。
使用參數 defaultName 指定所有由 XmlSerializerS 產生的 XML 元素的預設命名空間。
另請參閱
- XmlAttributeOverrides
- XmlRootAttribute
- XmlAttributes
- XML 序列化簡介
- 如何:為 XML 串流指定替代元素名稱
- 使用屬性控制 XML 串行化
- XML 序列化範例
- XML 架構定義工具 (Xsd.exe)
適用於
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)
初始化該類別的新實例,該實例 XmlSerializer 能將 類型的 Object 物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為型別 Object為 的物件。 每個待序列化的物件本身可以包含類別的實例,這種過載會用其他類別覆蓋這些類別。 此過載同時指定所有 XML 元素的預設命名空間,以及作為 XML 根元素的類別。
public:
XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides, cli::array <Type ^> ^ extraTypes, System::Xml::Serialization::XmlRootAttribute ^ root, System::String ^ defaultNamespace, System::String ^ location);
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location);
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string * string -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, overrides As XmlAttributeOverrides, extraTypes As Type(), root As XmlRootAttribute, defaultNamespace As String, location As String)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
- overrides
- XmlAttributeOverrides
一個 XmlAttributeOverrides 擴展或覆蓋參數中類別行為 type 的
- root
- XmlRootAttribute
一個 XmlRootAttribute 定義 XML 根元素屬性的
- defaultNamespace
- String
XML 文件中所有 XML 元素的預設命名空間。
- location
- String
類型的位置。
適用於
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)
警告
This method is obsolete and will be removed in a future release of the .NET Framework. Please use a XmlSerializer constructor overload which does not take an Evidence parameter. See http://go2.microsoft.com/fwlink/?LinkId=131738 for more information.
初始化該類別的新實例,該實例 XmlSerializer 能將指定類型的物件序列化為 XML 文件實例,並將 XML 文件實例反序列化為指定類型的物件。 這種過載讓你能提供序列化或反序列化操作中可能遇到的其他類型,以及所有 XML 元素的預設命名空間、用作 XML 根元素的類別、其位置,以及存取所需的憑證。
public:
XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides, cli::array <Type ^> ^ extraTypes, System::Xml::Serialization::XmlRootAttribute ^ root, System::String ^ defaultNamespace, System::String ^ location, System::Security::Policy::Evidence ^ evidence);
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location, System.Security.Policy.Evidence evidence);
[System.Obsolete("This method is obsolete and will be removed in a future release of the .NET Framework. Please use a XmlSerializer constructor overload which does not take an Evidence parameter. See http://go2.microsoft.com/fwlink/?LinkId=131738 for more information.")]
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location, System.Security.Policy.Evidence evidence);
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string * string * System.Security.Policy.Evidence -> System.Xml.Serialization.XmlSerializer
[<System.Obsolete("This method is obsolete and will be removed in a future release of the .NET Framework. Please use a XmlSerializer constructor overload which does not take an Evidence parameter. See http://go2.microsoft.com/fwlink/?LinkId=131738 for more information.")>]
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string * string * System.Security.Policy.Evidence -> System.Xml.Serialization.XmlSerializer
Public Sub New (type As Type, overrides As XmlAttributeOverrides, extraTypes As Type(), root As XmlRootAttribute, defaultNamespace As String, location As String, evidence As Evidence)
參數
- type
- Type
這個物件可以序列化的類型 XmlSerializer 。
- overrides
- XmlAttributeOverrides
一個 XmlAttributeOverrides 擴展或覆蓋參數中類別行為 type 的
- root
- XmlRootAttribute
一個 XmlRootAttribute 定義 XML 根元素屬性的
- defaultNamespace
- String
XML 文件中所有 XML 元素的預設命名空間。
- location
- String
類型的位置。
- 屬性
備註
允許更精確地控制暫存目錄的存取,並防止程式碼注入與利用。 使用此方法時,指定位置並只授權特定使用者存取。 管理員可以建立帶有證據清單的政策,將證據與權限匹配。