Basic AJAX Service

L’échantillon SimpleAjaxService montre comment utiliser Windows Communication Foundation (WCF) pour créer un service de base ASP.NET AJAX (Asynchronous JavaScript and XML), c’est-à-dire un service accessible à l’aide de code Javascript par un client de navigateur web. L'attribut WebGetAttribute est utilisé afin de garantir que le service répond aux requêtes HTTP GET et que ce service utilise le format de données JSON (JavaScript Object Notation) pour les réponses.

La prise en charge d’AJAX dans WCF est optimisée pour permettre son utilisation avec ASP.NET AJAX via le contrôle ScriptManager. Pour obtenir un exemple d’utilisation de WCF avec ASP.NET AJAX, consultez Exemples AJAX.

Notes

La procédure d'installation ainsi que les instructions de génération correspondant à cet exemple figurent en fin de rubrique.

Dans le code suivant, l'attribut WebGetAttribute est appliqué à l'opération Add afin de garantir que le service répond aux requêtes HTTP GET. Le code utilise la méthode GET pour des raisons pratiques (vous pouvez construire une requête HTTP GET à partir de tout navigateur Web). Vous pouvez également utiliser la méthode GET pour activer la mise en cache. HTTP POST est la valeur par défaut en l'absence d'attribut WebGetAttribute.

[ServiceContract(Namespace = "SimpleAjaxService")]
public interface ICalculator
{
    [WebGet]
    double Add(double n1, double n2);
    //Other operations omitted…
}

Le fichier d'exemple .svc utilise WebScriptServiceHostFactory, qui ajoute un point de terminaison standard WebScriptEndpoint au service. Ce point de terminaison est configuré à une adresse vide relative au fichier .svc. Cela signifie que l’adresse du service est http://localhost/ServiceModelSamples/service.svc, sans autre suffixe que celui correspondant au nom de l’opération.

<%@ServiceHost language="C#" Debug="true" Service="Microsoft.Samples.SimpleAjaxService.CalculatorService" Factory="System.ServiceModel.Activation.WebScriptServiceHostFactory" %>

Le WebScriptEndpoint est préconfiguré pour rendre le service accessible à partir d'une page cliente ASP.NET AJAX. La section suivante dans Web.config peut être utilisée pour apporter des modifications de configuration supplémentaires au point de terminaison. Elle peut être supprimée si aucune modification supplémentaire n'est requise.

<system.serviceModel>
  <standardEndpoints>
    <webScriptEndpoint>
      <!-- Use this element to configure the endpoint -->
      <standardEndpoint name=""  />
    </webScriptEndpoint>
  </standardEndpoints>
</system.serviceModel>

Le WebScriptEndpoint affecte au format de données par défaut du service la valeur JSON au lieu de XML. Pour appeler le service, accédez à http://localhost/ServiceModelSamples/service.svc/Add?n1=100&n2=200 après avoir effectué les étapes d’installation et de génération présentées plus loin dans cette rubrique. L'utilisation d'une requête HTTP GET active cette fonctionnalité de test.

La page web PostAjaxClientPage.aspx du client contient le code ASP.NET permettant d’appeler le service à chaque fois que l’utilisateur clique sur l’un des boutons d’opération de cette page. Le contrôle ScriptManager est utilisé pour permettre l'accès à un proxy du service via JavaScript.

<asp:ScriptManager ID="ScriptManager" runat="server">
    <Services>
        <asp:ServiceReference Path="service.svc" />
    </Services>
</asp:ScriptManager>

Le proxy local est instancié et les opérations sont appelées à l'aide du code Javascript suivant.

// Code for extracting arguments n1 and n2 omitted…
// Instantiate a service proxy
var proxy = new SimpleAjaxService.ICalculator();
// Code for selecting operation omitted…
proxy.Add(parseFloat(n1), parseFloat(n2), onSuccess, onFail, null);

Si l'appel du service réussit, le code appelle le gestionnaire onSuccess et le résultat de l'opération s'affiche dans une zone de texte.

function onSuccess(mathResult){
     document.getElementById("result").value = mathResult;
}