Classe System.Runtime.Serialization.DataContractAttribute

Cet article fournit des remarques supplémentaires à la documentation de référence de cette API.

Appliquez l’attribut DataContractAttribute aux types (classes, structures ou énumérations) 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 le DataContractAttribute aux classes qui contiennent et manipulent les données dans les messages envoyés. Pour plus d’informations sur les contrats de données, consultez Utilisation de contrats de données.

Vous devez également appliquer le DataMemberAttribute à tout champ, propriété ou événement qui contient des valeurs que vous souhaitez sérialiser. En appliquant le DataContractAttribute, vous activez explicitement la DataContractSerializer sérialisation et la désérialisation des données.

Avertissement

Vous pouvez appliquer DataMemberAttribute au champ privé. N’oubliez pas 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 peuvent ainsi être consulté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 plateformes d’interagir. Tant que les données transmises entre les services sont conformes 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 similaire à une interface dans laquelle le contrat spécifie la façon dont les données doivent être remises afin qu’elles puissent être traitées par une application. Par exemple, le contrat de données peut appeler un type de données nommé « Person » qui a deux champs de texte, nommés « FirstName » et « LastName ». Pour créer un contrat de données, appliquez le DataContractAttribute à la classe et appliquez le DataMemberAttribute à tous les champs ou propriétés qui doivent être sérialisés. En cas de sérialisation, les données sont conformes 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 tous 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é a un contrat de données, les membres de données de la classe de base sont sérialisés. Toutefois, vous devez appliquer DataMemberAttribute aux nouveaux membres dans une classe dérivée pour qu'ils deviennent sérialisables.

Documents de schéma XML et outil SvcUtil

Si vous échangez des données avec d’autres 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, par défaut, l’outil génère un ensemble de schémas XML qui définissent tous les types de contrat 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 classes Visual Basic ou C# conformes aux exigences des schémas XML qui utilisent des constructions qui peuvent être exprimées par des contrats de données. 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, par défaut, l’outil crée un ensemble de classes. Si vous examinez ces classes, vous remarquez que le DataContractAttribute a été appliqué. Vous pouvez utiliser ces classes pour créer une application pour traiter les 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 marqués avec le DataContractAttribute.

Réutiliser les types existants

Un contrat de données a deux exigences de base : un nom stable et une liste de membres. Le nom stable se compose 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 remplacer 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 à celui-ci. Utilisez cette fonctionnalité lorsque vous disposez d’un type existant qui traite les données exactement comme vous le souhaitez, mais possède un autre espace de noms et un nom de classe à partir du contrat de données. En remplaçant les valeurs par défaut, vous pouvez réutiliser votre type existant et avoir les données sérialisées conformes au contrat de données.

Remarque

Dans n’importe quel code, vous pouvez utiliser le mot DataContract au lieu du plus long DataContractAttribute.

Gestion des versions

Un contrat de données peut également prendre en charge les versions ultérieures de lui-même. Autrement dit, lorsqu’une version ultérieure du contrat inclut des données supplémentaires, ces données sont stockées et retournées à un expéditeur non touché. Pour ce faire, implémentez l’interface IExtensibleDataObject .

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