DataMemberAttribute Osztály

Definíció

Névtér:

System.Runtime.Serialization

Szerelvények:

netstandard.dll, System.Runtime.Serialization.Primitives.dll

Forrás:

DataMemberAttribute.cs

Egy típus tagjára alkalmazva azt adja meg, hogy a tag egy adatszerződés része, és szerializálható a DataContractSerializer.

public ref class DataMemberAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public sealed class DataMemberAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type DataMemberAttribute = class
    inherit Attribute

Public NotInheritable Class DataMemberAttribute
Inherits Attribute

Öröklődés

Object

Attribute

DataMemberAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példa egy olyan típust mutat be, amelyre az és DataContractAttribute az DataMemberAttribute attribútumokat alkalmazták. A Name tulajdonság értéke DataMemberAttribute "ID".

using System;
using System.Collections;
using System.IO;
using System.Runtime.Serialization;
using System.Xml;

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the DataContractSerializer.
[DataContract()]
class Person : IExtensibleDataObject
{
    private string LastNameValue;
    // Apply the DataMemberAttribute to fields (or properties)
    // that must be serialized.
    [DataMember()]
    public string FirstName;

    [DataMember]
    public string LastName
    {
        get { return LastNameValue; }
        set { LastNameValue = value; }
    }

    [DataMember(Name = "ID")]
    public int IdNumber;

    // Note that you can apply the DataMemberAttribute to
    // a private field as well.
    [DataMember]
    private string Secret;

    public Person(string newfName, string newLName, int newIdNumber)
    {
        FirstName = newfName;
        LastName = newLName;
        IdNumber = newIdNumber;
        Secret = newfName + newLName + newIdNumber;
    }

    // The extensionDataValue field holds data from future versions
    // of the type.  This enables this type to be compatible with
    // future versions. The field is required to implement the
    // IExtensibleDataObject interface.

    private ExtensionDataObject extensionDatavalue;

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

public class Test
{
    public static void Main(string[] args)
    {
        try
        {
            WriteObject(@"DataMemberAttributeExample.xml");
            ReadObject(@"DataMemberAttributeExample.xml");
        }
        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)
    {
        // Create a new instance of the Person class.
        Person p1 = new Person("Zighetti", "Barbara", 101);
        FileStream writer = new FileStream(filename,
        FileMode.OpenOrCreate);
        DataContractSerializer ser =
            new DataContractSerializer(typeof(Person));
        ser.WriteObject(writer, p1);
        writer.Close();
    }

    public static void ReadObject(string filename)
    {
        // Deserialize an instance of the Person class
        // from an XML file.
        FileStream fs = new FileStream(filename,
        FileMode.OpenOrCreate);
        DataContractSerializer ser =
            new DataContractSerializer(typeof(Person));
        // Deserialize the data and read it from the instance.
        Person deserializedPerson = (Person)ser.ReadObject(fs);
        fs.Close();
        Console.WriteLine(String.Format("{0} {1}, ID: {2}",
        deserializedPerson.FirstName, deserializedPerson.LastName,
        deserializedPerson.IdNumber));
    }
}

Imports System.Collections
Imports System.IO
Imports System.Runtime.Serialization
Imports System.Xml

' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the DataContractSerializer.
<DataContract()>  _
Class Person
    Implements IExtensibleDataObject

    Private LastNameValue As String
     
    ' Apply the DataMemberAttribute to fields (or properties) 
    ' that must be serialized.
    
    <DataMember()>  _
    Public FirstName As String
    
    <DataMember()>  _
    Public Property LastName() As String
        Get
            Return LastNameValue 
        End Get

        Set(ByVal Value As String)
           LastNameValue = Value
        End Set
    End Property

    
    <DataMember(Name:="ID")>  _
    Public IdNumber As Integer
    
    ' Note that you can apply the DataMemberAttribute to 
    ' a private field as well.
    <DataMember()>  _
    Private Secret As String
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, ByVal newIdNumber As Integer) 
        FirstName = newfName
        LastName = newLName
        IdNumber = newIdNumber
        Secret = newfName + newLName + newIdNumber.ToString()
    
    End Sub 
    
    ' The ExtensionData field holds data from future versions 
    ' of the type.  This enables this type to be compatible with 
    ' future versions. The field is required to implement the 
    ' IExtensibleObjectData interface.
    Private extensionDataValue As ExtensionDataObject
    
    Public Property ExtensionData() As ExtensionDataObject _
       Implements IExtensibleDataObject.ExtensionData
        Get
            Return extensionDataValue
        End Get
        Set
            extensionDataValue = value
        End Set
    End Property
End Class 

Public Class Test
    Public Shared Sub Main(ByVal args() As String) 
        Try
            ReadObject("DataMemberAttributeExample.xml")
            WriteObject("DataMemberAttributeExample.xml")
        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 ReadObject(ByVal filename As String) 
        ' Create a new instance of the Person class.
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim writer As New FileStream(filename, FileMode.Create)
        Dim ser As New DataContractSerializer(GetType(Person))
        ser.WriteObject(writer, p1)
        writer.Close()
    End Sub 

    Public Shared Sub WriteObject(ByVal filename As String) 
        ' Deserialize an instance of the Person class 
        ' from an XML file.
        Dim fs As New FileStream(filename, FileMode.OpenOrCreate)
        Dim ser As New DataContractSerializer(getTYpe(Person))
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = ser.ReadObject(fs)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", _
        deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.IdNumber))
    End Sub 
End Class

Megjegyzések

Alkalmazza az DataMemberAttribute attribútumot az DataContractAttribute adatszerződés részét képező típus tagjainak azonosításához. Az adatszerződéseket szerializáló szerializálók egyike a DataContractSerializer.

Az adatszerződési modell egy "opt-in" modell. Ha a DataMemberAttribute mezőt egy mezőre vagy tulajdonságra alkalmazza, az kifejezetten azt határozza meg, hogy a tagérték szerializálva lesz. Ezzel szemben a szerializálja egy XmlSerializer típus összes nyilvános mezőjét és tulajdonságát.

Figyelmeztetés

Alkalmazhatja a DataMemberAttribute magánmezőkre vagy tulajdonságokra. Vegye figyelembe, hogy a tag által visszaadott adatok (még ha privátak is) szerializálva és deszerializálva lesznek, és így rosszindulatú felhasználó vagy folyamat tekintheti meg vagy elfoghatja őket.

Alapértelmezés szerint a CLR-tag neve lesz az adattag neve. A tulajdonság beállításával Name testre szabhatja az adattag nevét. Ez olyan név megadására használható, amely nem engedélyezett CLR-tagnévként. Az XML-hez való leképezéskor a DataContractSerializerrendszer ezt a nevet használja egy típus sémaelemének neveként.

Note

Azok a tulajdonságok, amelyekre az DataMemberAttribute attribútumot alkalmazták, mind getset a mezőkkel kell rendelkezniük. Nem lehetnek get-only vagy set-only. Ha olyan tulajdonságot szeretne szerializálni, amely csak terv szerint marad get(például egy gyűjteményt visszaadó tulajdonság), érdemes inkább a DataMemberAttribute háttérmezőre alkalmazni.

További információ az adatszerződésekről és az adattagokról: Adatszerződések használata. A tagnevekről további információt az Adattag alapértelmezett értékei című témakörben talál.

Konstruktorok

Name	Description
DataMemberAttribute()	Inicializálja a DataMemberAttribute osztály új példányát.

Tulajdonságok

Name	Description
EmitDefaultValue	Lekéri vagy beállít egy értéket, amely meghatározza, hogy szerializálja-e a szerializált mező vagy tulajdonság alapértelmezett értékét.
IsNameSetExplicitly	Lekérdezi, hogy explicit módon lett-e Name beállítva.
IsRequired	Lekéri vagy beállít egy értéket, amely arra utasítja a szerializálási motort, hogy a tagnak jelen kell lennie olvasáskor vagy deszerializáláskor.
Name	Lekéri vagy beállítja az adattag nevét.
Order	Lekéri vagy beállítja a tag szerializálásának és deszerializálásának sorrendjét.
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Olyan értéket ad vissza, amely jelzi, hogy ez a példány egyenlő-e egy adott objektummal. (Öröklődés forrása Attribute)
GetHashCode()	A példány kivonatkódját adja vissza. (Öröklődés forrása Attribute)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• DataContractAttribute
• DataContractSerializer
• IExtensibleDataObject
• Adatszerződések használata
• Ajánlott eljárások: Adatszerződés verziószámozása
• Az adattag alapértelmezett értékei
• Adattagsorrend