NonSerializedAttribute Klass

Definition

Namnområde:

System

Sammansättning:

mscorlib.dll

Anger att ett fält i en serialiserbar klass inte ska serialiseras. Det går inte att ärva den här klassen.

public ref class NonSerializedAttribute sealed : Attribute

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

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

Public NotInheritable Class NonSerializedAttribute
Inherits Attribute

Arv

Object

Attribute

NonSerializedAttribute

Attribut

AttributeUsageAttribute ComVisibleAttribute

Exempel

I följande exempel visas SOAP-serialisering av ett objekt som markerats med SerializableAttribute attributet och beteendet för ett fält som markerats med NonSerializedAttribute i det serialiserade objektet.

Note

Koden använder SoapFormatter klassen för att serialisera objektet. Klassen finns i filen system.runtime.serialization.formatters.soap.dll, som inte läses in som standard i ett projekt. Om du vill köra koden måste du lägga till en referens till DLL:en i projektet.

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

Kommentarer

När du använder klasserna BinaryFormatter eller SoapFormatter för att serialisera ett objekt använder du NonSerializedAttribute attributet för att förhindra att ett fält serialiseras. Du kan till exempel använda det här attributet för att förhindra serialisering av känsliga data.

Målobjekten NonSerializedAttribute för attributet är offentliga och privata fält i en serialiserbar klass. Som standard är klasserna inte serialiserbara om de inte är markerade med SerializableAttribute. Under serialiseringsprocessen serialiseras alla offentliga och privata fält i en klass som standard. Fält som markerats med NonSerializedAttribute undantas under serialiseringen. Om du använder XmlSerializer klassen för att serialisera ett objekt använder du XmlIgnoreAttribute klassen för att få samma funktioner. Du kan också implementera ISerializable gränssnittet för att uttryckligen kontrollera serialiseringsprocessen. Observera att klasser som implementerar ISerializable fortfarande måste markeras med SerializableAttribute.

Om du vill tillämpa klassen på NonSerializedAttribute en händelse anger du attributplatsen till fält, enligt följande C#-kod.

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

Om ett fält inte serialiseras, men det fortfarande kräver ett standardvärde som måste anges efter deserialisering, kan du skapa en metod som förser fältet med ett värde och sedan tillämpa på OnDeserializedAttribute metoden.

Mer information om hur du använder attribut finns i Attribut.

Note

Det här attributet gäller inte för JSON-serialisering med hjälp av System.Text.Json.

Konstruktorer

Name	Description
NonSerializedAttribute()	Initierar en ny instans av NonSerializedAttribute klassen.

Egenskaper

Name	Description
TypeId	När den implementeras i en härledd klass hämtar du en unik identifierare för den här Attribute. (Ärvd från Attribute)

Metoder

Name	Description
Equals(Object)	Returnerar ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute)
GetHashCode()	Returnerar hash-koden för den här instansen. (Ärvd från Attribute)
GetType()	Hämtar den aktuella instansen Type . (Ärvd från Object)
IsDefaultAttribute()	När den åsidosättas i en härledd klass anger du om värdet för den här instansen är standardvärdet för den härledda klassen. (Ärvd från Attribute)
Match(Object)	När den åsidosätts i en härledd klass returneras ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute)
MemberwiseClone()	Skapar en ytlig kopia av den aktuella Object. (Ärvd från Object)
ToString()	Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Object)

Explicita gränssnittsimplementeringar

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappar en uppsättning namn till en motsvarande uppsättning av sändningsidentifierare. (Ärvd från Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Hämtar typinformationen för ett objekt, som kan användas för att hämta typinformationen för ett gränssnitt. (Ärvd från Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Hämtar antalet typinformationsgränssnitt som ett objekt tillhandahåller (antingen 0 eller 1). (Ärvd från Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Ger åtkomst till egenskaper och metoder som exponeras av ett objekt. (Ärvd från Attribute)

Se även

• SerializableAttribute
• Attribute
• ISerializable
• Utöka metadata med hjälp av attribut
• XML- och SOAP-serialisering