SerializableAttribute Classe

Définition

Espace de noms:

System

Assemblys:

netstandard.dll, System.Runtime.dll

Source:

SerializableAttribute.cs

Indique qu’une classe peut être sérialisée à l’aide de la sérialisation binaire ou XML. Cette classe ne peut pas être héritée.

C#

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Struct, Inherited=false)]
public sealed class SerializableAttribute : Attribute

Héritage

Object

Attribute

SerializableAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant illustre la sérialisation SOAP d’un objet marqué avec l’attribut SerializableAttribute .

C#

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);
    }
}

Remarques

Appliquez l’attribut SerializableAttribute à un type pour indiquer que les instances de ce type peuvent être sérialisées à l’aide de la sérialisation binaire ou XML. Le Common Language Runtime lève SerializationException si l’attribut n’est SerializableAttribute pas appliqué à un type dans le graphique d’objets sérialisés.

Appliquez l’attribut SerializableAttribute même si la classe implémente également l’interface ISerializable pour contrôler le processus de sérialisation binaire.

Lorsque vous appliquez l’attribut SerializableAttribute à un type, tous les champs privés et publics sont sérialisés par défaut. Vous pouvez contrôler la sérialisation binaire de manière plus granulaire en implémentant l’interface ISerializable pour remplacer le processus de sérialisation.

Vous pouvez également exclure des champs de la sérialisation en appliquant l’attribut NonSerializedAttribute au champ. Si un champ d’un type sérialisable binaire contient un pointeur, un handle ou une autre structure de données spécifique à un environnement particulier et ne peut pas être reconstitué de manière significative dans un autre environnement, vous pouvez appliquer l’attribut NonSerializedAttribute à ce champ.

Pour plus d’informations sur l’utilisation des attributs, consultez Attributs. Pour plus d’informations sur la sérialisation binaire, consultez System.Runtime.Serialization.

Note

Cet attribut ne s’applique pas à la sérialisation JSON à l’aide de System.Text.Json.

Constructeurs

SerializableAttribute()

Initialise une nouvelle instance de la classe SerializableAttribute.

Propriétés

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à

Voir aussi

• Attribute
• ISerializable
• NonSerializedAttribute
• Extension des métadonnées à l'aide des attributs
• Sérialisation XML et SOAP