DataMemberAttribute Kelas

Definisi

Ruang nama:

System.Runtime.Serialization

Rakitan:

System.Runtime.Serialization.Primitives.dll

Sumber:

DataMemberAttribute.cs

Ketika diterapkan ke anggota jenis, menentukan bahwa anggota adalah bagian dari kontrak data dan dapat diserialisasikan oleh 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

Warisan

Object

Attribute

DataMemberAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut menunjukkan jenis di mana DataContractAttribute atribut dan DataMemberAttribute telah diterapkan. Properti Name pada DataMemberAttribute diatur ke "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

Keterangan

Terapkan DataMemberAttribute atribut bersama dengan DataContractAttribute untuk mengidentifikasi anggota jenis yang merupakan bagian dari kontrak data. Salah satu serializer yang dapat membuat serial kontrak data adalah DataContractSerializer.

Model kontrak data adalah model "keikutsertaan". Menerapkan ke DataMemberAttribute bidang atau properti secara eksplisit menentukan bahwa nilai anggota akan diserialisasikan. Sebaliknya, menserialisasikan XmlSerializer semua bidang publik dan properti jenis.

Perhatian

Anda dapat menerapkan ke DataMemberAttribute bidang atau properti privat. Ketahuilah bahwa data yang dikembalikan oleh anggota (bahkan jika bersifat privat) akan diserialisasikan dan dideserialisasi, dan dengan demikian dapat dilihat atau dicegat oleh pengguna atau proses berbahaya.

Secara default, nama anggota CLR digunakan sebagai nama anggota data. Dengan mengatur Name properti , Anda dapat menyesuaikan nama anggota data. Ini dapat digunakan untuk memberikan nama yang mungkin tidak diizinkan sebagai nama anggota CLR. Saat memetakan ke XML menggunakan DataContractSerializer, nama ini digunakan sebagai nama elemen skema dalam jenis.

Catatan

Properti yang atributnya DataMemberAttribute telah diterapkan harus memiliki get bidang dan set . Mereka tidak boleh get-hanya atau set-saja. Untuk membuat serialisasi properti yang harus tetap get-hanya berdasarkan desain (misalnya, properti yang mengembalikan koleksi), pertimbangkan untuk menerapkan DataMemberAttribute ke bidang dukungan sebagai gantinya.

Untuk informasi selengkapnya tentang kontrak data dan anggota data, lihat Menggunakan Kontrak Data. Untuk informasi selengkapnya tentang nama anggota, lihat Nilai Default Anggota Data.

Konstruktor

DataMemberAttribute()

Menginisialisasi instans baru kelas DataMemberAttribute.

Properti

EmitDefaultValue	Mendapatkan atau menetapkan nilai yang menentukan apakah akan membuat serialisasi nilai default untuk bidang atau properti yang sedang diserialisasikan.
IsNameSetExplicitly	Mendapatkan apakah Name telah diatur secara eksplisit.
IsRequired	Mendapatkan atau menetapkan nilai yang menginstruksikan mesin serialisasi yang harus ada anggota saat membaca atau mendeserialisasi.
Name	Mendapatkan atau mengatur nama anggota data.
Order	Mendapatkan atau mengatur urutan serialisasi dan deserialisasi anggota.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)

Metode

Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa di kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• DataContractAttribute
• DataContractSerializer
• IExtensibleDataObject
• Menggunakan Kontrak Data
• Praktik Terbaik: Penerapan Versi Kontrak Data
• Nilai Default Anggota Data
• Pesanan Anggota Data