İngilizce dilinde oku

Aracılığıyla paylaş


XmlSerializer Sınıf

Tanım

XML belgelerinin içine ve xml belgelerinden nesneleri serileştirir ve seri durumdan kaldırır. , XmlSerializer nesnelerin XML'de nasıl kodlanacaklarını denetlemenizi sağlar.

C#
public class XmlSerializer
Devralma
XmlSerializer

Örnekler

Aşağıdaki örnek iki ana sınıf içerir: PurchaseOrder ve Test. sınıfı, PurchaseOrder tek bir satın alma hakkında bilgi içerir. Test sınıfı, satınalma siparişini oluşturan ve oluşturulan satınalma siparişini okuyan yöntemleri içerir.

C#
using System;
using System.Xml;
using System.Xml.Serialization;
using System.IO;

/* The XmlRootAttribute allows you to set an alternate name
   (PurchaseOrder) of the XML element, the element namespace; by
   default, the XmlSerializer uses the class name. The attribute
   also allows you to set the XML namespace for the element.  Lastly,
   the attribute sets the IsNullable property, which specifies whether
   the xsi:null attribute appears if the class instance is set to
   a null reference. */
[XmlRootAttribute("PurchaseOrder", Namespace="http://www.cpandl.com",
IsNullable = false)]
public class PurchaseOrder
{
   public Address ShipTo;
   public string OrderDate;
   /* The XmlArrayAttribute changes the XML element name
    from the default of "OrderedItems" to "Items". */
   [XmlArrayAttribute("Items")]
   public OrderedItem[] OrderedItems;
   public decimal SubTotal;
   public decimal ShipCost;
   public decimal TotalCost;
}

public class Address
{
   /* The XmlAttribute instructs the XmlSerializer to serialize the Name
      field as an XML attribute instead of an XML element (the default
      behavior). */
   [XmlAttribute]
   public string Name;
   public string Line1;

   /* Setting the IsNullable property to false instructs the
      XmlSerializer that the XML attribute will not appear if
      the City field is set to a null reference. */
   [XmlElementAttribute(IsNullable = false)]
   public string City;
   public string State;
   public string Zip;
}

public class OrderedItem
{
   public string ItemName;
   public string Description;
   public decimal UnitPrice;
   public int Quantity;
   public decimal LineTotal;

   /* Calculate is a custom method that calculates the price per item,
      and stores the value in a field. */
   public void Calculate()
   {
      LineTotal = UnitPrice * Quantity;
   }
}

public class Test
{
   public static void Main()
   {
      // Read and write purchase orders.
      Test t = new Test();
      t.CreatePO("po.xml");
      t.ReadPO("po.xml");
   }

   private void CreatePO(string filename)
   {
      // Create an instance of the XmlSerializer class;
      // specify the type of object to serialize.
      XmlSerializer serializer =
      new XmlSerializer(typeof(PurchaseOrder));
      TextWriter writer = new StreamWriter(filename);
      PurchaseOrder po=new PurchaseOrder();

      // Create an address to ship and bill to.
      Address billAddress = new Address();
      billAddress.Name = "Teresa Atkinson";
      billAddress.Line1 = "1 Main St.";
      billAddress.City = "AnyTown";
      billAddress.State = "WA";
      billAddress.Zip = "00000";
      // Set ShipTo and BillTo to the same addressee.
      po.ShipTo = billAddress;
      po.OrderDate = System.DateTime.Now.ToLongDateString();

      // Create an OrderedItem object.
      OrderedItem i1 = new OrderedItem();
      i1.ItemName = "Widget S";
      i1.Description = "Small widget";
      i1.UnitPrice = (decimal) 5.23;
      i1.Quantity = 3;
      i1.Calculate();

      // Insert the item into the array.
      OrderedItem [] items = {i1};
      po.OrderedItems = items;
      // Calculate the total cost.
      decimal subTotal = new decimal();
      foreach(OrderedItem oi in items)
      {
         subTotal += oi.LineTotal;
      }
      po.SubTotal = subTotal;
      po.ShipCost = (decimal) 12.51;
      po.TotalCost = po.SubTotal + po.ShipCost;
      // Serialize the purchase order, and close the TextWriter.
      serializer.Serialize(writer, po);
      writer.Close();
   }

   protected void ReadPO(string filename)
   {
      // Create an instance of the XmlSerializer class;
      // specify the type of object to be deserialized.
      XmlSerializer serializer = new XmlSerializer(typeof(PurchaseOrder));
      /* If the XML document has been altered with unknown
      nodes or attributes, handle them with the
      UnknownNode and UnknownAttribute events.*/
      serializer.UnknownNode+= new
      XmlNodeEventHandler(serializer_UnknownNode);
      serializer.UnknownAttribute+= new
      XmlAttributeEventHandler(serializer_UnknownAttribute);

      // 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.
      PurchaseOrder po;
      /* Use the Deserialize method to restore the object's state with
      data from the XML document. */
      po = (PurchaseOrder) serializer.Deserialize(fs);
      // Read the order date.
      Console.WriteLine ("OrderDate: " + po.OrderDate);

      // Read the shipping address.
      Address shipTo = po.ShipTo;
      ReadAddress(shipTo, "Ship To:");
      // Read the list of ordered items.
      OrderedItem [] items = po.OrderedItems;
      Console.WriteLine("Items to be shipped:");
      foreach(OrderedItem oi in items)
      {
         Console.WriteLine("\t"+
         oi.ItemName + "\t" +
         oi.Description + "\t" +
         oi.UnitPrice + "\t" +
         oi.Quantity + "\t" +
         oi.LineTotal);
      }
      // Read the subtotal, shipping cost, and total cost.
      Console.WriteLine("\t\t\t\t\t Subtotal\t" + po.SubTotal);
      Console.WriteLine("\t\t\t\t\t Shipping\t" + po.ShipCost);
      Console.WriteLine("\t\t\t\t\t Total\t\t" + po.TotalCost);
   }

   protected void ReadAddress(Address a, string label)
   {
      // Read the fields of the Address object.
      Console.WriteLine(label);
      Console.WriteLine("\t"+ a.Name );
      Console.WriteLine("\t" + a.Line1);
      Console.WriteLine("\t" + a.City);
      Console.WriteLine("\t" + a.State);
      Console.WriteLine("\t" + a.Zip );
      Console.WriteLine();
   }

   private void serializer_UnknownNode
   (object sender, XmlNodeEventArgs e)
   {
      Console.WriteLine("Unknown Node:" +   e.Name + "\t" + e.Text);
   }

   private void serializer_UnknownAttribute
   (object sender, XmlAttributeEventArgs e)
   {
      System.Xml.XmlAttribute attr = e.Attr;
      Console.WriteLine("Unknown attribute " +
      attr.Name + "='" + attr.Value + "'");
   }
}

Açıklamalar

Bu API hakkında daha fazla bilgi için bkz . XmlSerializer için ek API açıklamaları.

Oluşturucular

XmlSerializer()

XmlSerializer sınıfının yeni bir örneğini başlatır.

XmlSerializer(Type)

Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türdeki nesnelere seri durumdan çıkarabilen yeni bir sınıf örneği başlatır.

XmlSerializer(Type, String)

Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türdeki nesnelere seri durumdan çıkarabilen yeni bir sınıf örneği başlatır. Tüm XML öğeleri için varsayılan ad alanını belirtir.

XmlSerializer(Type, Type[])

Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türde bir nesnede seri durumdan çıkarabilen sınıfının yeni bir örneğini başlatır. Bir özellik veya alan bir dizi döndürürse, extraTypes parametresi diziye eklenebilen nesneleri belirtir.

XmlSerializer(Type, XmlAttributeOverrides)

Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türdeki nesnelere seri durumdan çıkarabilen yeni bir sınıf örneği başlatır. Seri hale getirilecek her nesnenin kendisi sınıfların örneklerini içerebilir ve bu aşırı yükleme diğer sınıflarla geçersiz kılabilir.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)

türündeki XmlSerializer nesneleri Object XML belge örneklerine seri hale getirebilen ve XML belge örneklerini türünde Objectnesneler halinde seri durumdan çıkarabilen yeni bir sınıfı örneği başlatır. Seri hale getirilecek her nesne, bu aşırı yüklemenin diğer sınıflarla geçersiz kıldığı sınıf örneklerini içerebilir. Bu aşırı yükleme ayrıca tüm XML öğeleri ve XML kök öğesi olarak kullanılacak sınıf için varsayılan ad alanını belirtir.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)

türündeki XmlSerializer nesneleri Object XML belge örneklerine seri hale getirebilen ve XML belge örneklerini türünde Objectnesneler halinde seri durumdan çıkarabilen yeni bir sınıfı örneği başlatır. Seri hale getirilecek her nesne, bu aşırı yüklemenin diğer sınıflarla geçersiz kıldığı sınıf örneklerini içerebilir. Bu aşırı yükleme ayrıca tüm XML öğeleri ve XML kök öğesi olarak kullanılacak sınıf için varsayılan ad alanını belirtir.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)
Geçersiz.

Belirtilen türdeki XmlSerializer nesneleri XML belge örneklerine seri hale getirebilen ve XML belge örneklerini belirtilen türde nesneler halinde seri durumdan çıkarabilen yeni bir sınıf örneği başlatır. Bu aşırı yükleme, seri hale getirme veya seri durumdan çıkarma işlemi sırasında karşılaşılabilecek diğer türleri ve tüm XML öğeleri için varsayılan ad alanını, XML kök öğesi olarak kullanılacak sınıfı, erişim için gereken konumu ve kimlik bilgilerini sağlamanıza olanak tanır.

XmlSerializer(Type, XmlRootAttribute)

Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve xml belgesini belirtilen türde bir nesneye seri durumdan çıkarabilen yeni bir sınıf örneği başlatır. Ayrıca XML kök öğesi olarak kullanılacak sınıfı belirtir.

XmlSerializer(XmlTypeMapping)

Bir türü başka bir türle XmlSerializer eşleyen bir nesne kullanarak sınıfın bir örneğini başlatır.

Yöntemler

CanDeserialize(XmlReader)

Bunun XmlSerializer belirtilen xml belgesini seri durumdan çıkarıp çıkaramayacağını belirten bir değer alır.

CreateReader()

Seri hale getirilecek XML belgesini okumak için kullanılan bir nesne döndürür.

CreateWriter()

Türetilmiş bir sınıfta geçersiz kılındığında, nesneyi seri hale getirmek için kullanılan bir yazıcı döndürür.

Deserialize(Stream)

Belirtilen Streamtarafından bulunan XML belgesinin seri durumdan çıkarılır.

Deserialize(TextReader)

Belirtilen TextReadertarafından bulunan XML belgesinin seri durumdan çıkarılır.

Deserialize(XmlReader)

Belirtilen XmlReadertarafından bulunan XML belgesinin seri durumdan çıkarılır.

Deserialize(XmlReader, String)

Belirtilen XmlReader ve kodlama stilinin içerdiği XML belgesini seri durumdan çıkartır.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Belirtilen XmlReadertarafından kapsanan verileri kullanarak nesnenin seri durumdan çıkarılır.

Deserialize(XmlReader, XmlDeserializationEvents)

Belirtilen XmlReader tarafından bulunan bir XML belgesini seri durumdan çıkararak seri durumdan çıkarma sırasında gerçekleşen olayların geçersiz kılınmasına izin verir.

Deserialize(XmlSerializationReader)

Belirtilen XmlSerializationReadertarafından bulunan XML belgesinin seri durumdan çıkarılır.

Equals(Object)

Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler.

(Devralındığı yer: Object)
FromMappings(XmlMapping[])

Bir nesne dizisinden XmlSerializer oluşturulan bir nesne dizisi XmlTypeMapping döndürür.

FromMappings(XmlMapping[], Evidence)
Geçersiz.

Bir XML türünün eşlemelerinden başka bir XML türüne oluşturulan sınıfın bir örneğini XmlSerializer döndürür.

FromMappings(XmlMapping[], Type)

Belirtilen eşlemelerden sınıfının bir örneğini XmlSerializer döndürür.

FromTypes(Type[])

Bir tür dizisinden XmlSerializer oluşturulan bir nesne dizisi döndürür.

GenerateSerializer(Type[], XmlMapping[])

Belirtilen eşlemeleri kullanarak belirtilen türü veya türleri seri hale getirmek veya seri durumdan çıkarabilmek için kullanılan özel hazırlanmış seri hale getiricileri içeren bir derleme döndürür.

GenerateSerializer(Type[], XmlMapping[], CompilerParameters)

Belirtilen eşlemeleri ve derleyici ayarlarını ve seçeneklerini kullanarak belirtilen tür veya türleri seri hale getirmek veya seri durumdan çıkarabilmek için kullanılan özel hazırlanmış seri hale getiriciler içeren bir derleme döndürür.

GetHashCode()

Varsayılan karma işlevi işlevi görür.

(Devralındığı yer: Object)
GetType()

Type Geçerli örneğini alır.

(Devralındığı yer: Object)
GetXmlSerializerAssemblyName(Type)

Belirtilen türü seri hale getirmek veya seri durumdan çıkarabilmek için özellikle oluşturulan bir veya daha fazla sürümünü XmlSerializer içeren derlemenin adını döndürür.

GetXmlSerializerAssemblyName(Type, String)

Belirtilen ad alanında belirtilen tür için seri hale getiriciyi içeren derlemenin adını döndürür.

MemberwiseClone()

Geçerli Objectöğesinin sığ bir kopyasını oluşturur.

(Devralındığı yer: Object)
Serialize(Object, XmlSerializationWriter)

Belirtilen öğesini serileştirir ve xml Object belgesini belirtilen XmlSerializationWriterkullanarak bir dosyaya yazar.

Serialize(Stream, Object)

Belirtilen öğesini serileştirir ve xml Object belgesini belirtilen Streamkullanarak bir dosyaya yazar.

Serialize(Stream, Object, XmlSerializerNamespaces)

Belirtilenleri serileştirir ve belirtilen Object ad alanlarına başvuran belirtilen Stream öğesini kullanarak XML belgesini bir dosyaya yazar.

Serialize(TextWriter, Object)

Belirtilen öğesini serileştirir ve xml Object belgesini belirtilen TextWriterkullanarak bir dosyaya yazar.

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Belirtileni serileştirir ve belirtilen ObjectTextWriter kullanarak XML belgesini bir dosyaya yazar ve belirtilen ad alanlarına başvurur.

Serialize(XmlWriter, Object)

Belirtilen öğesini serileştirir ve xml Object belgesini belirtilen XmlWriterkullanarak bir dosyaya yazar.

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Belirtileni serileştirir ve belirtilen ObjectXmlWriter kullanarak XML belgesini bir dosyaya yazar ve belirtilen ad alanlarına başvurur.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Belirtilen nesneyi serileştirir ve belirtilen kullanarak XML belgesini bir dosyaya yazar ve belirtilen XmlWriter ad alanlarına ve kodlama stiline başvurur.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String)

Belirtileni serileştirir ve belirtilen Object , XML ad alanlarını ve kodlamayı XmlWriterkullanarak XML belgesini bir dosyaya yazar.

ToString()

Geçerli nesneyi temsil eden dizeyi döndürür.

(Devralındığı yer: Object)

Ekinlikler

UnknownAttribute

seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML özniteliğiyle karşılaştığında oluşur.

UnknownElement

seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML öğesiyle karşılaştığında gerçekleşir.

UnknownNode

seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML düğümüyle karşılaştığında gerçekleşir.

UnreferencedObject

SOAP ile kodlanmış XML akışının seri durumdan çıkarılması sırasında, XmlSerializer kullanılmayan veya başvurulmayan tanınan bir türle karşılaştığında gerçekleşir.

Şunlara uygulanır

Ürün Sürümler
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

İş Parçacığı Güvenliği

Bu güvenli iş parçacığı türüdür.

Ayrıca bkz.