NonSerializedAttribute Třída

Definice

Obor názvů:

System

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

NonSerializedAttribute.cs

Označuje, že pole serializovatelné třídy by nemělo být serializováno. Tato třída se nemůže dědit.

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

Dědičnost

Object

Attribute

NonSerializedAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje serializaci SOAP objektu označeného SerializableAttribute atributem a chování pole označeného NonSerializedAttribute serializovaným objektem.

Note

Kód používá SoapFormatter třídu k serializaci objektu. Třída se nachází v souboru system.runtime.serialization.formatters.soap.dll, který není ve výchozím nastavení načten do projektu. Chcete-li spustit kód, musíte přidat odkaz na knihovnu DLL do projektu.

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

Poznámky

Při použití BinaryFormatter nebo SoapFormatter třídy serializace objektu, pomocí NonSerializedAttribute atributu zabránit pole v serializaci. Tento atribut můžete například použít k zabránění serializace citlivých dat.

Cílové objekty pro NonSerializedAttribute atribut jsou veřejná a soukromá pole serializovatelné třídy. Ve výchozím nastavení třídy nejsou serializovatelné, pokud nejsou označeny SerializableAttribute. Během procesu serializace všechny veřejné a privátní pole třídy jsou serializovány ve výchozím nastavení. Pole označená NonSerializedAttribute pomocí jsou při serializaci vyloučena. Pokud k serializaci objektu XmlSerializer používáte třídu, použijte XmlIgnoreAttribute třídu k získání stejné funkce. Alternativně implementujte ISerializable rozhraní, které explicitně řídí proces serializace. Všimněte si, že třídy, které implementují ISerializable , musí být stále označeny SerializableAttribute.

Chcete-li použít NonSerializedAttribute třídu na událost, nastavte umístění atributu na pole, jak je znázorněno v následujícím kódu jazyka C#.

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

Pokud pole není serializováno, ale přesto vyžaduje výchozí hodnotu, která musí být zadána po deserializaci, můžete vytvořit metodu, která poskytuje pole s hodnotou, a pak použít na OnDeserializedAttribute metodu.

Další informace o používání atributů naleznete v tématu Atributy.

Note

Tento atribut se nevztahuje na serializaci JSON pomocí System.Text.Json.

Konstruktory

Name	Description
NonSerializedAttribute()	Inicializuje novou instanci NonSerializedAttribute třídy.

Vlastnosti

Name	Description
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• SerializableAttribute
• Attribute
• ISerializable
• rozšíření metadat pomocí atributů
• Serializace XML a SOAP