Types connus de contrats de données

  • Article

La classe KnownTypeAttribute vous permet de spécifier, en avance, les types qui doivent être inclus pour être pris en compte pendant la désérialisation. Pour obtenir un exemple fonctionnel, consultez l’exemple Known Types .

Normalement, lors du passage des paramètres et des valeurs de retour entre un client et un service, les deux points de terminaison partagent tous les contrats de données des données à transmettre. Toutefois, ce n'est pas le cas dans les circonstances suivantes :

  • Le contrat de données envoyé est dérivé du contrat de données attendu. Pour plus d’informations, consultez la section relative à l’héritage dans Équivalence de contrats de données. Dans ce cas, les données transmises n'ont pas le même contrat de données que celui attendu par le point de terminaison de réception.

  • Le type déclaré pour les informations à transmettre est une interface, par opposition à une classe, une structure ou une énumération. Par conséquent, il n'est pas possible de connaître à l'avance quel type implémentant l'interface est envoyé réellement et, par conséquent, le point de terminaison de réception ne peut pas déterminer, à l'avance, le contrat de données pour les données transmises.

  • Le type déclaré pour les informations à transmettre est Object. Comme chaque type hérite de Object, et il n'est pas possible de connaître à l'avance quel type est envoyé réellement, le point de terminaison de réception ne peut pas déterminer à l'avance le contrat de données pour les données transmises. Il s'agit d'un cas spécial du premier élément : chaque contrat de données dérive de la valeur par défaut, un contrat de données vierge généré pour Object.

  • Certains types, dont les types .NET Framework, ont des membres qui appartiennent à l’une des trois catégories précédentes. Par exemple, Hashtable utilise Object pour stocker les objets réels dans la table de hachage. Lors de la sérialisation de ces types, le côté réception ne peut pas déterminer à l'avance le contrat de données pour ces membres.

Classe KnownTypeAttribute

Lorsque les données arrivent à un point de terminaison de réception, le runtime WCF essaie de désérialiser les données dans une instance d’un type CLR (Common Language Runtime). Le type instancié pour la désérialisation est choisi en inspectant d'abord le message entrant pour déterminer le contrat de données auquel le contenu du message se conforme. Le moteur de désérialisation essaie ensuite de rechercher un type CLR qui implémente un contrat de données compatible avec le contenu de message. Le jeu des types de candidat que le moteur de désérialisation autorise pendant ce processus porte le nom du jeu du désérialiseur des « types connus ».

Une façon d'informer le moteur de désérialisation d'un type est d'utiliser KnownTypeAttribute. L'attribut ne peut pas être appliqué aux membres de données individuels, uniquement aux types de contrat de données entiers. L'attribut est appliqué à un type externe qui peut être une classe ou une structure. Dans son utilisation la plus élémentaire, l’application de l’attribut spécifie un type comme « type connu ». Cela entraîne l’intégration du type connu dans un jeu de types connus chaque fois qu’un objet du type externe ou tout objet référencé via ses membres est désérialisé. Plusieurs attributs KnownTypeAttribute peuvent être appliqués au même type.

Types et primitives connus

Les types primitifs, ainsi que certains types traités comme des primitives (par exemple, DateTime et XmlElement) sont toujours « connus » et il n'est jamais nécessaire de les ajouter par le biais de ce mécanisme. Cependant, les tableaux de types primitifs doivent être ajouté explicitement. La plupart des collections sont considérées comme équivalentes aux tableaux. (Les collections non génériques sont considérées comme équivalentes aux tableaux de Object). Pour un exemple de l'utilisation des primitives, des tableaux de primitives et des collections de primitives, consultez l'exemple 4.

Notes

Contrairement à d'autres types de primitive, la structure DateTimeOffset n'est pas un type connu par défaut, donc elle doit être ajoutée manuellement à la liste de types connus.

Exemples

Voici quelques exemples de la classe KnownTypeAttribute employée.

Exemple 1

Il existe trois classes avec une relation d'héritage.

[DataContract]
public class Shape { }

[DataContract(Name = "Circle")]
public class CircleType : Shape { }

[DataContract(Name = "Triangle")]
public class TriangleType : Shape { }

<DataContract()> _
Public Class Shape
End Class

<DataContract(Name:="Circle")> _
Public Class CircleType
    Inherits Shape
End Class
<DataContract(Name:="Triangle")> _
Public Class TriangleType
    Inherits Shape
End Class

La classe CompanyLogo suivante peut être sérialisée, mais ne peut pas être désérialisée si le membre ShapeOfLogo a pour valeur un CircleType ou un objet TriangleType , étant donné que le moteur de désérialisation ne reconnaît pas de types avec les noms de contrat de données « Cercle » ou « Triangle ».

[DataContract]
public class CompanyLogo
{
    [DataMember]
    private Shape ShapeOfLogo;
    [DataMember]
    private int ColorOfLogo;
}

<DataContract()> _
Public Class CompanyLogo
    <DataMember()> _
    Private ShapeOfLogo As Shape
    <DataMember()> _
    Private ColorOfLogo As Integer
End Class

La méthode correcte pour écrire le type CompanyLogo est indiquée dans le code suivant.

[DataContract]
[KnownType(typeof(CircleType))]
[KnownType(typeof(TriangleType))]
public class CompanyLogo2
{
    [DataMember]
    private Shape ShapeOfLogo;
    [DataMember]
    private int ColorOfLogo;
}

<DataContract(), KnownType(GetType(CircleType)), KnownType(GetType(TriangleType))> _
Public Class CompanyLogo2
    <DataMember()> _
    Private ShapeOfLogo As Shape
    <DataMember()> _
    Private ColorOfLogo As Integer
End Class

Toutes les fois que le type CompanyLogo2 externe est désérialisé, le moteur de désérialisation connaît CircleType et TriangleType et, par conséquent, est en mesure de rechercher des types correspondants pour les contrats de données « Cercle » ou « Triangle ».

Exemple 2

Dans l'exemple suivant, même si CustomerTypeA et CustomerTypeB ont le contrat de données Customer , une instance de CustomerTypeB est créée à chaque fois qu'un PurchaseOrder est désérialisé, car seul CustomerTypeB est connu du moteur de désérialisation.

public interface ICustomerInfo
{
    string ReturnCustomerName();
}

[DataContract(Name = "Customer")]
public class CustomerTypeA : ICustomerInfo
{
    public string ReturnCustomerName()
    {
        return "no name";
    }
}

[DataContract(Name = "Customer")]
public class CustomerTypeB : ICustomerInfo
{
    public string ReturnCustomerName()
    {
        return "no name";
    }
}

[DataContract]
[KnownType(typeof(CustomerTypeB))]
public class PurchaseOrder
{
    [DataMember]
    ICustomerInfo buyer;

    [DataMember]
    int amount;
}

Public Interface ICustomerInfo
    Function ReturnCustomerName() As String
End Interface

<DataContract(Name:="Customer")> _
Public Class CustomerTypeA
    Implements ICustomerInfo
    Public Function ReturnCustomerName() _
    As String Implements ICustomerInfo.ReturnCustomerName
        Return "no name"
    End Function
End Class

<DataContract(Name:="Customer")> _
Public Class CustomerTypeB
    Implements ICustomerInfo
    Public Function ReturnCustomerName() _
    As String Implements ICustomerInfo.ReturnCustomerName
        Return "no name"
    End Function
End Class

<DataContract(), KnownType(GetType(CustomerTypeB))> _
Public Class PurchaseOrder
    <DataMember()> _
    Private buyer As ICustomerInfo

    <DataMember()> _
    Private amount As Integer
End Class

Exemple 3

Dans l'exemple suivant, un Hashtable stocke en interne son contenu sous la forme d'un Object. Pour désérialiser une table de hachage correctement, le moteur de désérialisation doit connaître le jeu de types possibles qui peuvent se produire à cet endroit. Dans ce cas, nous savons à l'avance que seuls les objets Book et Magazine sont stockés dans le Catalog, par conséquent ils sont ajoutés à l'aide de l'attribut KnownTypeAttribute .

[DataContract]
public class Book { }

[DataContract]
public class Magazine { }

[DataContract]
[KnownType(typeof(Book))]
[KnownType(typeof(Magazine))]
public class LibraryCatalog
{
    [DataMember]
    System.Collections.Hashtable theCatalog;
}

<DataContract()> _
Public Class Book
End Class

<DataContract()> _
Public Class Magazine
End Class

<DataContract(), KnownType(GetType(Book)), KnownType(GetType(Magazine))> _
Public Class LibraryCatalog
    <DataMember()> _
    Private theCatalog As System.Collections.Hashtable
End Class

Exemple 4

Dans l'exemple suivant, un contrat de données stocke un nombre et une opération à effectuer sur le nombre. Le membre de données Numbers peut être un entier, un tableau d'entiers ou un objet List<T> qui contient des entiers.

Attention

Cela ne fonctionnera que du côté client si SVCUTIL.EXE est utilisé pour générer un proxy WCF. SVCUTIL.EXE récupère des métadonnées du service, notamment tous les types connus. Sans ces informations, un client ne sera pas en mesure de désérialiser les types.

[DataContract]
[KnownType(typeof(int[]))]
public class MathOperationData
{
    private object numberValue;
    [DataMember]
    public object Numbers
    {
        get { return numberValue; }
        set { numberValue = value; }
    }
    //[DataMember]
    //public Operation Operation;
}

<DataContract(), KnownType(GetType(Integer()))> _
Public Class MathOperationData
    Private numberValue As Object

    <DataMember()> _
    Public Property Numbers() As Object
        Get
            Return numberValue
        End Get
        Set(ByVal value As Object)
            numberValue = value
        End Set
    End Property
End Class

Voici le code d'application.

// This is in the service application code:
static void Run()
{

    MathOperationData md = new MathOperationData();

    // This will serialize and deserialize successfully because primitive
    // types like int are always known.
    int a = 100;
    md.Numbers = a;

    // This will serialize and deserialize successfully because the array of
    // integers was added to known types.
    int[] b = new int[100];
    md.Numbers = b;

    // This will serialize and deserialize successfully because the generic
    // List<int> is equivalent to int[], which was added to known types.
    List<int> c = new List<int>();
    md.Numbers = c;
    // This will serialize but will not deserialize successfully because
    // ArrayList is a non-generic collection, which is equivalent to
    // an array of type object. To make it succeed, object[]
    // must be added to the known types.
    ArrayList d = new ArrayList();
    md.Numbers = d;
}

' This is in the service application code:
Shared Sub Run()
    Dim md As New MathOperationData()
    ' This will serialize and deserialize successfully because primitive 
    ' types like int are always known.
    Dim a As Integer = 100
    md.Numbers = a

    ' This will serialize and deserialize successfully because the array of 
    ' integers was added to known types.
    Dim b(99) As Integer
    md.Numbers = b

    ' This will serialize and deserialize successfully because the generic 
    ' List(Of Integer) is equivalent to Integer(), which was added to known types.
    Dim c As List(Of Integer) = New List(Of Integer)()
    md.Numbers = c
    ' This will serialize but will not deserialize successfully because 
    ' ArrayList is a non-generic collection, which is equivalent to 
    ' an array of type object. To make it succeed, object[]
    ' must be added to the known types.
    Dim d As New ArrayList()
    md.Numbers = d

End Sub

Types, héritage et interfaces connus

Lorsqu'un type connu est associé à un type particulier à l'aide de l'attribut KnownTypeAttribute , le type connu est également associé à tous les types dérivés de ce type. Par exemple, consultez le code suivant.

[DataContract]
[KnownType(typeof(Square))]
[KnownType(typeof(Circle))]
public class MyDrawing
{
    [DataMember]
    private object Shape;
    [DataMember]
    private int Color;
}

[DataContract]
public class DoubleDrawing : MyDrawing
{
    [DataMember]
    private object additionalShape;
}

<DataContract(), KnownType(GetType(Square)), KnownType(GetType(Circle))> _
Public Class MyDrawing
    <DataMember()> _
    Private Shape As Object
    <DataMember()> _
    Private Color As Integer
End Class

<DataContract()> _
Public Class DoubleDrawing
    Inherits MyDrawing
    <DataMember()> _
    Private additionalShape As Object
End Class

La classe DoubleDrawing ne requiert pas que l'attribut KnownTypeAttribute utilise Square et Circle dans le champ AdditionalShape , parce que la classe de base (Drawing) a déjà ces attributs appliqués.

Les types connus peuvent être associés uniquement à des classes et des structures, pas des interfaces.

Types connus qui utilisent des méthodes génériques ouvertes

Il peut être nécessaire d'ajouter un type générique en tant que type connu. Toutefois, un type générique ouvert ne peut pas être passé en tant que paramètre à l'attribut KnownTypeAttribute .

Ce problème peut être résolu en utilisant un autre mécanisme : écrire une méthode qui retourne une liste de types à ajouter à la collection de types connus. Le nom de la méthode est spécifié comme un argument de chaîne à l'attribut KnownTypeAttribute en raison de certaines restrictions.

La méthode doit exister sur le type auquel l'attribut KnownTypeAttribute est appliqué, il doit être statique, il ne doit pas accepter de paramètres et doit retourner un objet qui peut être assigné à IEnumerable de Type.

Vous ne pouvez pas associer l'attribut KnownTypeAttribute avec un nom de méthode et des attributs KnownTypeAttribute avec des types réels sur le même type. En outre, vous ne pouvez pas appliquer plusieurs KnownTypeAttribute avec un nom de méthode au même type.

Consultez la classe suivante.

[DataContract]
public class DrawingRecord<T>
{
    [DataMember]
    private T theData;
    [DataMember]
    private GenericDrawing<T> theDrawing;
}

<DataContract()> _
Public Class DrawingRecord(Of T)
    <DataMember()> _
    Private theData As T
    <DataMember()> _
    Private theDrawing As GenericDrawing(Of T)
End Class

Le champ theDrawing contient des instances d'une classe générique ColorDrawing et d'une classe générique BlackAndWhiteDrawingqui héritent toutes les deux d'une classe générique Drawing. Normalement, les deux doivent être ajoutées aux types connus, mais les éléments suivants ne sont pas une syntaxe valide pour des attributs.

// Invalid syntax for attributes:  
// [KnownType(typeof(ColorDrawing<T>))]  
// [KnownType(typeof(BlackAndWhiteDrawing<T>))]  

' Invalid syntax for attributes:  
' <KnownType(GetType(ColorDrawing(Of T))), _  
' KnownType(GetType(BlackAndWhiteDrawing(Of T)))>

Donc, une méthode doit être créée pour retourner ces types. La méthode correcte pour écrire ce type est indiquée dans le code suivant.

[DataContract]
[KnownType("GetKnownType")]
public class DrawingRecord2<T>
{
    [DataMember]
    private T TheData;
    [DataMember]
    private GenericDrawing<T> TheDrawing;

    private static Type[] GetKnownType()
    {
        Type[] t = new Type[2];
        t[0] = typeof(ColorDrawing<T>);
        t[1] = typeof(BlackAndWhiteDrawing<T>);
        return t;
    }
}

<DataContract(), KnownType("GetKnownType")> _
Public Class DrawingRecord2(Of T)
    Private TheData As T
    Private TheDrawing As GenericDrawing(Of T)

    Private Shared Function GetKnownType() As Type()
        Dim t(1) As Type
        t(0) = GetType(ColorDrawing(Of T))
        t(1) = GetType(BlackAndWhiteDrawing(Of T))
        Return t
    End Function
End Class

Méthodes supplémentaires pour ajouter des types connus

En outre, les types connus peuvent être ajoutés par le biais d'un fichier de configuration. Cette opération est utile lorsque vous ne contrôlez pas le type qui requiert des types connus pour une désérialisation correcte, comme lors de l’utilisation de bibliothèques de types tiers avec Windows Communication Foundation (WCF).

Le fichier de configuration suivant indique comment spécifier un type connu dans un fichier de configuration.

<configuration>

<system.runtime.serialization>

<dataContractSerializer>

<declaredTypes>

<add type="MyCompany.Library.Shape,

MyAssembly, Version=2.0.0.0, Culture=neutral,

PublicKeyToken=XXXXXX, processorArchitecture=MSIL">

<knownType type="MyCompany.Library.Circle,

MyAssembly, Version=2.0.0.0, Culture=neutral,

PublicKeyToken=XXXXXX, processorArchitecture=MSIL"/>

</add>

</declaredTypes>

</dataContractSerializer>

</system.runtime.serialization>

</configuration>

Un type de contrat de données dans le fichier de configuration précédent appelé MyCompany.Library.Shape est déclaré comme ayant MyCompany.Library.Circle comme type connu.

Voir aussi