Partager via

Vue d'ensemble du modèle de programmation Web WCF

  • Article

Le modèle de programmation Web fournit les éléments d'infrastructure de base requis pour générer des services de style Web avec Windows Communication Foundation (WCF). Les services de style Web sont conçus pour être accessibles à l'éventail de clients le plus large possible (y compris les navigateurs Web sans infrastructure cliente supplémentaire) et ont les spécifications uniques suivantes :

  • URI et traitement des URI. Les URI jouent un rôle central dans la conception de services de style Web. Le modèle de programmation Web WCF utilise les classes UriTemplate et UriTemplateTable pour fournir des fonctions de traitement des URI.
  • Prise en charge des opérations GET et POST. Les services de style Web utilisent le verbe GET pour l'extraction des données, en plus de divers verbes de commande pour la modification de données et l'appel distant. Le modèle de programmation Web utilise WebGetAttribute et WebInvokeAttribute pour associer des opérations de service avec les verbes GET et POST.
  • Formats de données multiples. Les services de style Web traitent de nombreux types de données en plus des messages SOAP. Le modèle de programmation Web utilise WebHttpBinding et WebHttpBehavior pour prendre en charge de nombreux formats de données différents y compris des documents XML, l'objet de donnée JSON et les flux de données de contenu binaire tels que les images, les fichiers vidéo ou le texte brut.

Le modèle de programmation Web étend la portée de WCF pour prendre en charge des scénarios de style Web qui incluent des services REST, AJAX et JSON et les flux de syndication (ATOM/RSS). Pour plus d'informations sur les services AJAX et JSON, consultez Intégration d'AJAX et prise en charge de JSON. Pour plus d'informations sur la syndication, consultez Vue d'ensemble de la syndication WCF.

Traitement des URI avec UriTemplate et UriTemplateTable

Les modèles URI fournissent une syntaxe efficace pour exprimer des larges jeux d'URI dont la structure est semblable. Par exemple, le modèle suivant exprime le jeu de tous les URI à trois segments qui commencent par "a" et se terminent par "c" sans tenir compte de la valeur du segment intermédiaire : a/{segment}/c

Ce modèle décrit des URI comme suit :

  • a/x/c
  • a/y/c
  • a/z/c
  • et ainsi de suite.

Dans ce modèle, la notation avec accolade ("{segment}") indique un segment variable au lieu d'une valeur littérale.

.NET Framework 3.5 fournit une nouvelle API qui permet d'utiliser des modèles URI appelés UriTemplate. UriTemplates vous permet d'effectuer les tâches suivantes :

  • Vous pouvez appeler une des méthodes Bind avec un jeu de paramètres pour produire un URI complètement fermé qui correspond au modèle. Cela signifie que toutes les variables dans le modèle URI sont remplacées par des valeurs réelles.
  • Vous pouvez appeler Match() avec un URI candidat qui utilise un modèle pour décomposer les parties qui constituent un URI candidat et qui retourne un dictionnaire qui contient les différentes parties de l'URI libellé selon les variables du modèle.
  • Bind() et Match() sont des inverses qui vous permettent d'appeler Match( Bind(x)) et de revenir dans le même environnement de démarrage.

Il arrive souvent (surtout sur le serveur où la distribution d'une demande vers une opération de service basée sur l'URI est nécessaire) de vouloir effectuer le suivi d'un jeu d'objets UriTemplate dans une structure de données qui peut adresser indépendamment chacun des modèles contenus. UriTemplateTable représente un jeu de modèles URI et sélectionne la meilleure correspondance en fonction d'un jeu de modèles et d'un URI candidat. Cela n'est pas lié à une pile de réseau particulière (WCF inclus) vous pouvez donc l'utiliser partout quand cela est nécessaire.

Le modèle de service WCF utilise UriTemplate et UriTemplateTable pour associer des opérations de service à un jeu d'URI décrit par un UriTemplate. Une opération de service est associée à un UriTemplate à l'aide de WebGetAttribute ou de WebInvokeAttribute.

Paramètres d'opération de service et URL

Les services de style Web peuvent être appelés depuis un navigateur Web en tapant une URL associée à une opération de service. Ces opérations de service peuvent accepter des paramètres qui doivent être spécifiés sous forme de chaîne dans l'URL. Le tableau suivant affiche les types qui peuvent être passés dans une URL et le format utilisé.

Type Format

Byte

0 - 255

SByte

-128 - 127

Int16

-32768 - 32767

Int32

-2,147,483,648 - 2,147,483,647

Int64

-9,223,372,036,854,775,808 - 9,223,372,036,854,775,807

UInt16

0 - 65535

UInt32

0 - 4,294,967,295

UInt64

0 - 18,446,744,073,709,551,615

Single

-3.402823e38 - 3.402823e38 (la notation d'exposant n'est pas requise)

Double

-1.79769313486232e308 - 1.79769313486232e308 (la notation d'exposant n'est pas requise)

Char

Tout caractère unique

Decimal

Tout décimal en notation standard (aucun exposant)

Boolean

True ou False (ne respecte pas la casse)

String

Toute chaîne (la chaîne Null n'est pas prise en charge et aucun échappement n'est fait)

DateTime

MM/DD/YYYY

MM/DD/YYYY HH:MM:SS [AM|PM]

Mois Jour Année

Mois Jour Année HH:MM:SS [AM|PM]

TimeSpan

DD.HH:MM:SS

Où DD = jours, HH = heures, MM = minutes, SS = secondes

Guid

Un GUID, par exemple :

936DA01F-9ABD-4d9d-80C7-02AF85C822A8

DateTimeOffset

MM/DD/YYYY HH:MM:SS MM:SS

Où DD = jours, HH = heures, MM = minutes, SS = secondes

Enums

La valeur d'énumération par exemple qui définit l'énumération comme indiqué dans le code suivant.

public enum Days{ Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday };

Chacune des valeurs d'énumération individuelles (ou leurs valeurs entières correspondantes) peut être spécifiée dans la chaîne de requête.

Types qui ont un TypeConverterAttribute pouvant convertir le type vers et depuis une représentation sous forme de chaîne.

Dépend du convertisseur de type.

WebGet et WebInvoke

Les services de style Web utilisent des verbes de récupération (par exemple HTTP GET) en plus de différents verbes de commande (par exemple HTTP POST, le verbe utilisé par les services SOAP). Le modèle de programmation Web autorise les développeurs de service à contrôler le modèle URI et le verbe associé à leurs opérations de service avec le WebGetAttribute et WebInvokeAttribute. WebGetAttribute et WebInvokeAttribute vous permettent de contrôler comment les opérations individuelles sont attachées aux URI et les méthodes HTTP associées à ces URI. Par exemple, ajouter WebGetAttribute et WebInvokeAttribute dans le code suivant.

[ServiceContract]
interface ICustomer
{
  //"View It"
  [OperationContract]
  [WebGet]
  Customer GetCustomer():
  
  //"Do It"
  [OperationContract]
  [WebInvoke]
  Customer UpdateCustomerName( string id, 
                               string newName );
}

Le code précédent vous permet d'effectuer les demandes HTTP suivantes.

GET /GetCustomer

POST /UpdateCustomerName

WebInvokeAttribute prend la valeur POST par défaut mais vous pouvez l'utiliser aussi pour d'autres verbes.

[ServiceContract]
interface ICustomer
{
  //"View It“ -> HTTP GET
  [OperationContract]
  [WebGet( UriTemplate=“customers/{id}” )]
  Customer GetCustomer( string id ):
  
  //"Do It“ -> HTTP PUT
  [OperationContract]
  [WebInvoke( UriTemplate=“customers/{id}”, Method=“PUT” )]
  Customer UpdateCustomer( string id, Customer newCustomer );
}

Formats et le modèle de programmation Web

Le modèle de programmation Web a de nouvelles fonctionnalités pour utiliser un grand nombre de formats de données différents. Au niveau de la couche de liaison, WebHttpBinding peut lire et écrire les différents types suivants de données :

  • XML
  • JSON
  • Flux binaires opaques

Cela signifie que le modèle de programmation Web peut gérer tout type de données, mais vous risquez de programmer à l'encontre de Stream.

Le .NET Framework 3.5 assure la prise en charge des données JSON (AJAX) ainsi que des flux de syndication (notamment ATOM et RSS). Pour plus d'informations sur ces fonctionnalités, consultez Vue d'ensemble de la syndication WCF et Intégration d'AJAX et prise en charge de JSON.

Voir aussi

Concepts

Modèle objet de programmation Web WCF

Autres ressources

Syndication WCF
Modèle de programmation Web