Classe System.Runtime.Serialization.DataContractAttribute

Cet article vous offre des remarques complémentaires à la documentation de référence pour cette API.

Appliquez l'attribut DataContractAttribute aux types (classes, structures ou énumérations) qui sont utilisés dans les opérations de sérialisation et de désérialisation par le DataContractSerializer. Si vous envoyez ou recevez des messages à l’aide de l’infrastructure WINDOWS Communication Foundation (WCF), vous devez également appliquer les DataContractAttribute classes qui contiennent et manipulent les données envoyées dans les messages. Pour plus d’informations sur les contrats de données, consultez Utilisation des contrats de données.

Vous devez également appliquer les DataMemberAttribute à tout champ, propriété ou événement qui contiennent des valeurs que vous voulez sérialiser. En appliquant le DataContractAttribute, vous permettez explicitement au DataContractSerializer de sérialiser et de désérialiser les données.

Attention

Vous pouvez appliquer le DataMemberAttribute aux champs privés. Soyez conscient que les données retournées par le champ (même s'il est privé) sont sérialisées et désérialisées, et que, par conséquent, elles peuvent être affichées ou interceptées par un utilisateur ou un processus malveillant.

Pour plus d’informations sur les contrats de données, consultez les rubriques répertoriées dans Utilisation des contrats de données.

Contrats de données

Un contrat de données est une description abstraite d’un ensemble de champs avec un nom et un type de données pour chaque champ. Le contrat de données existe en dehors de toute implémentation unique pour permettre aux services sur différentes plates-formes d'interopérer. Tant que les données passées entre les services se conforment au même contrat, tous les services peuvent traiter les données. Ce traitement est également appelé système faiblement couplé. Un contrat de données est également semblable à une interface dans le sens où le contrat spécifie comment les données doivent être fournies afin qu'elles puissent être traitées par une application. Par exemple, le contrat de données peut demander un type de données nommé "Person" qui comporte deux champs de texte nommés, "FirstName" et "LastName". Pour créer un contrat de données, appliquez simplement DataContractAttribute à la classe et DataMemberAttribute aux champs ou aux propriétés qui doivent être sérialisés. Lorsqu'elles sont sérialisées, les données se conforment au contrat de données qui est implicitement intégré au type.

Remarque

Un contrat de données diffère considérablement d'une interface réelle dans son comportement d'héritage. Les interfaces sont héritées par les types dérivés. Lorsque vous appliquez le DataContractAttribute à une classe de base, les types dérivés n'héritent pas de l'attribut ou du comportement. Toutefois, si un type dérivé comporte un contrat de données, les membres de données de la classe de base sont alors sérialisés. Toutefois, vous devez appliquer le DataMemberAttribute aux nouveaux membres dans une classe dérivée pour les rendre sérialisables.

Documents de schéma XML et outil SvcUtil

Si vous échangez des données avec des services, vous devez décrire le contrat de données. Pour la version actuelle du DataContractSerializer, un schéma XML peut être utilisé pour définir des contrats de données. (D’autres formes de métadonnées/description peuvent être utilisées à la même fin.) Pour créer un schéma XML à partir de votre application, utilisez l’outil Utilitaire de métadonnées ServiceModel (Svcutil.exe) avec l’option de ligne de commande /dconly . Lorsque l'entrée de l'outil est un assembly, l'outil génère par défaut un jeu de schémas XML qui définissent tous les types de contrats de données trouvés dans cet assembly. À l'inverse, vous pouvez également utiliser l'outil Svcutil.exe pour créer des définitions de classe Visual Basic ou C# qui se conforment aux spécifications des schémas XML utilisant des constructions que les contrats de données peuvent exprimer. Dans ce cas, l’option de ligne de commande /dconly n’est pas requise.

Si l'entrée de l'outil Svcutil.exe est un schéma XML, l'outil crée par défaut un ensemble de classes. Si vous examinez ces classes, vous pouvez constater que le DataContractAttribute a été appliqué. Vous pouvez utiliser ces classes afin de créer une application pour traiter des données qui doivent être échangées avec d'autres services.

Vous pouvez également exécuter l’outil sur un point de terminaison qui retourne un document WSDL (Web Services Description Language) pour générer automatiquement le code et la configuration pour créer un client Windows Communication Foundation (WCF). Le code généré inclut des types qui sont marqués avec le DataContractAttribute.

Réutiliser les types existants

Un contrat de données comporte deux spécifications de base : un nom stable et une liste de membres. Le nom stable est composé de l'URI (Uniform Resource Identifier) de l'espace de noms et du nom local du contrat. Par défaut, lorsque vous appliquez la DataContractAttribute classe à une classe, elle utilise le nom de la classe comme nom local et l’espace de noms de la classe (précédé de "http://schemas.datacontract.org/2004/07/") comme URI d’espace de noms. Vous pouvez substituer les valeurs par défaut en définissant les propriétés Name et Namespace. Vous pouvez également modifier l'espace de noms en appliquant le ContractNamespaceAttribute à l'espace de noms. Utilisez cette fonction lorsque vous avez un type existant qui traite les données exactement comme vous l'avez demandé mais qui contient un espace de noms et un nom de classe différents dans le contrat de données. En substituant les valeurs par défaut, vous pouvez réutiliser votre type existant et conformer les données sérialisées au contrat de données.

Remarque

Dans du code, vous pouvez utiliser le mot DataContract au lieu de DataContractAttribute qui est plus long.

Contrôle de version

Un contrat de données accepte également des versions ultérieures. Autrement dit, lorsqu'une version ultérieure du contrat inclut des données supplémentaires, ces données sont stockées et retournées intactes à un expéditeur. Pour cela, implémentez l'interface IExtensibleDataObject.

Pour plus d’informations sur le contrôle de version, consultez Gestion des versions de contrat de données.