NonSerializedAttribute Osztály

Definíció

Névtér:

System

Szerelvények:

netstandard.dll, System.Runtime.dll

Forrás:

NonSerializedAttribute.cs

Azt jelzi, hogy egy szerializálható osztály mezője nem szerializálható. Ez az osztály nem örökölhető.

public ref class NonSerializedAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field, Inherited=false)]
public sealed class NonSerializedAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field, Inherited=false)>]
type NonSerializedAttribute = class
    inherit Attribute

Public NotInheritable Class NonSerializedAttribute
Inherits Attribute

Öröklődés

Object

Attribute

NonSerializedAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példa egy attribútummal SerializableAttribute megjelölt objektum SOAP szerializálását, valamint a szerializált objektummal NonSerializedAttribute megjelölt mezők viselkedését mutatja be.

Note

A kód az SoapFormatter osztály használatával szerializálja az objektumot. Az osztály a system.runtime.serialization.formatters.soap.dll fájlban található, amely alapértelmezés szerint nem töltődik be egy projektbe. A kód futtatásához hozzá kell adnia egy hivatkozást a DLL-hez a projekthez.

using System;
using System.IO;
using System.Runtime.Serialization.Formatters.Soap;

public class Test {
   public static void Main()  {

      // Creates a new TestSimpleObject object.
      TestSimpleObject obj = new TestSimpleObject();

      Console.WriteLine("Before serialization the object contains: ");
      obj.Print();

      // Opens a file and serializes the object into it in binary format.
      Stream stream = File.Open("data.xml", FileMode.Create);
      SoapFormatter formatter = new SoapFormatter();

      formatter.Serialize(stream, obj);
      stream.Close();

      // Empties obj.
      obj = null;

      // Opens file "data.xml" and deserializes the object from it.
      stream = File.Open("data.xml", FileMode.Open);
      formatter = new SoapFormatter();

      obj = (TestSimpleObject)formatter.Deserialize(stream);
      stream.Close();

      Console.WriteLine("");
      Console.WriteLine("After deserialization the object contains: ");
      obj.Print();
   }
}

// A test object that needs to be serialized.
[Serializable()]
public class TestSimpleObject  {

    public int member1;
    public string member2;
    public string member3;
    public double member4;

    // A field that is not serialized.
    [NonSerialized()] public string member5;

    public TestSimpleObject() {

        member1 = 11;
        member2 = "hello";
        member3 = "hello";
        member4 = 3.14159265;
        member5 = "hello world!";
    }

    public void Print() {

        Console.WriteLine("member1 = '{0}'", member1);
        Console.WriteLine("member2 = '{0}'", member2);
        Console.WriteLine("member3 = '{0}'", member3);
        Console.WriteLine("member4 = '{0}'", member4);
        Console.WriteLine("member5 = '{0}'", member5);
    }
}

open System
open System.IO
open System.Runtime.Serialization.Formatters.Soap

// A test object that needs to be serialized.
[<Serializable>]
type TestSimpleObject() =
    let member1 = 11
    let member2 = "hello"
    let member3 = "hello"
    let member4 = 3.14159265

    // A field that is not serialized.
    [<NonSerialized>]
    let member5 = "hello world!"

    member _.Print() =
        printfn $"member1 = '{member1}'"
        printfn $"member2 = '{member2}'"
        printfn $"member3 = '{member3}'"
        printfn $"member4 = '{member4}'"
        printfn $"member5 = '{member5}'"

[<EntryPoint>]
let main _ =
    // Creates a new TestSimpleObject object.
    let obj = TestSimpleObject()

    printfn "Before serialization the object contains: "
    obj.Print()

    // Opens a file and serializes the object into it in binary format.
    let stream = File.Open("data.xml", FileMode.Create)
    let formatter = SoapFormatter()

    formatter.Serialize(stream, obj)
    stream.Close()

    // Opens file "data.xml" and deserializes the object from it.
    let stream = File.Open("data.xml", FileMode.Open)
    let formatter = new SoapFormatter()

    let obj = formatter.Deserialize stream :?> TestSimpleObject
    stream.Close()

    printfn "\nAfter deserialization the object contains: "
    obj.Print()
    0

Imports System.IO
Imports System.Runtime.Serialization
Imports System.Runtime.Serialization.Formatters.Soap




Public Class Test
   
   Public Shared Sub Main()
      
      ' Creates a new TestSimpleObject object.
      Dim obj As New TestSimpleObject()
      
      Console.WriteLine("Before serialization the object contains: ")
      obj.Print()
      
      ' Opens a file and serializes the object into it in binary format.
      Dim stream As Stream = File.Open("data.xml", FileMode.Create)
      Dim formatter As New SoapFormatter()
      


      formatter.Serialize(stream, obj)
      stream.Close()
      
      ' Empties obj.
      obj = Nothing
      
      ' Opens file "data.xml" and deserializes the object from it.
      stream = File.Open("data.xml", FileMode.Open)
      formatter = New SoapFormatter()



      obj = CType(formatter.Deserialize(stream), TestSimpleObject)
      stream.Close()
      
      Console.WriteLine("")
      Console.WriteLine("After deserialization the object contains: ")
      obj.Print()

   End Sub

End Class


' A test object that needs to be serialized.
<Serializable()> Public Class TestSimpleObject
   
   Public member1 As Integer
   Public member2 As String
   Public member3 As String
   Public member4 As Double
   
   ' A member that is not serialized.
   <NonSerialized()> Public member5 As String  
  
   
   Public Sub New()     
      member1 = 11
      member2 = "hello"
      member3 = "hello"
      member4 = 3.14159265
      member5 = "hello world!"
   End Sub
      
   
   Public Sub Print()      
      Console.WriteLine("member1 = '{0}'", member1)
      Console.WriteLine("member2 = '{0}'", member2)
      Console.WriteLine("member3 = '{0}'", member3)
      Console.WriteLine("member4 = '{0}'", member4)
      Console.WriteLine("member5 = '{0}'", member5)
   End Sub

End Class

Megjegyzések

Amikor az BinaryFormatterSoapFormatter osztályokkal szerializál egy objektumot, az NonSerializedAttribute attribútummal megakadályozhatja, hogy egy mező szerializálva legyen. Ezzel az attribútummal például megakadályozhatja a bizalmas adatok szerializálását.

Az attribútum célobjektumai NonSerializedAttribute egy szerializálható osztály nyilvános és privát mezői. Alapértelmezés szerint az osztályok csak akkor szerializálhatók, ha a jelölésük .SerializableAttribute A szerializálási folyamat során az osztály összes nyilvános és privát mezője alapértelmezés szerint szerializálva lesz. A szerializálás során a megjelölt NonSerializedAttribute mezők ki vannak zárva. Ha az XmlSerializer osztályt egy objektum szerializálására használja, az XmlIgnoreAttribute osztály használatával ugyanazt a funkciót kapja. Másik lehetőségként implementálhatja az interfészt a ISerializable szerializálási folyamat explicit szabályozásához. Vegye figyelembe, hogy a megvalósító ISerializable osztályokat továbbra is meg kell jelölni a következővel SerializableAttribute: .

Ha az NonSerializedAttribute osztályt egy eseményre szeretné alkalmazni, állítsa az attribútum helyét mezőre az alábbi C#-kódban látható módon.

[field:NonSerializedAttribute()]
public event ChangedEventHandler Changed;

Ha egy mező nincs szerializálva, de továbbra is szükség van egy alapértelmezett értékre, amelyet a deszerializálás után kell megadni, létrehozhat egy metódust, amely egy értékkel látja el a mezőt, majd alkalmazza a OnDeserializedAttribute metódusra.

Az attribútumok használatáról további információt az Attribútumok című témakörben talál.

Note

Ez az attribútum nem vonatkozik a JSON-szerializálásra a következő használatával System.Text.Json: .

Konstruktorok

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

Tulajdonságok

Name	Description
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

• SerializableAttribute
• Attribute
• ISerializable
• Metaadatok kiterjesztése attribútumokkal
• XML- és SOAP-szerializálás