Création du proxy de service Web

  • Article

Un client et un service Web peuvent communiquer à l'aide de messages SOAP qui encapsulent les paramètres d'entrée et de sortie au format XML. Une classe proxy mappe des paramètres aux éléments XML puis envoie les messages SOAP sur un réseau. De cette manière, la classe proxy vous évite de devoir communiquer avec le service Web au niveau SOAP et vous permet d'appeler des méthodes de service Web dans tout environnement de développement qui prend en charge les proxies de service Web et SOAP.

Il y a deux manières d’ajouter une classe proxy à votre projet de développement à l’aide du Microsoft .NET Framework : avec l’outil WSDL dans le .NET Framework, et en ajoutant une référence web dans Microsoft Visual Studio. Les sections suivantes approfondissent ce sujet.

Ajout du proxy à l'aide de l'outil WSDL

Le Kit de développement logiciel (SDK) .NET Framework inclut l'outil Web Services Description Language (Wsdl.exe) qui vous permet de générer un proxy de service Web pour une utilisation dans l'environnement de développement .NET Framework. La méthode la plus courante pour créer un proxy client dans les langages qui prennent en charge des services web (actuellement C# et Microsoft Visual Basic) est d’utiliser l’outil WSDL.

Pour ajouter une classe proxy à votre projet à l’aide de Wsdl.exe

  1. À partir d'une invite de commandes, utilisez Wsdl.exe pour créer une classe proxy en spécifiant (au minimum) l'URL du service Web Report Server.

    Par exemple, l'instruction d'invite de commandes suivante spécifie une URL pour le point de terminaison de gestion du service Web Report Server :

    wsdl /language:CS /n:"Microsoft.SqlServer.ReportingServices2010" https://<Server Name>/reportserver/reportservice2010.asmx?wsdl

    L'outil WSDL accepte plusieurs arguments d'invite de commandes pour générer un proxy. L'exemple précédent spécifie le langage C#, un espace de noms suggéré à utiliser dans le proxy (évite la collision de nom en présence de plusieurs points de terminaison de service Web), et génère un fichier C# appelé ReportingService2010.cs. Si l'exemple avait spécifié Visual Basic, l'exemple aurait généré un fichier proxy avec le nom ReportingService2010.vb. Ce fichier est créé dans le répertoire à partir duquel vous exécutez la commande.

  2. Compilez la classe proxy dans un fichier d'assembly (avec l'extension .dll) et référencez-la dans votre projet ou ajoutez la classe comme un élément de projet.

    Notes

    Lorsque vous ajoutez manuellement une classe proxy à votre projet, vous devez ajouter une référence à System.Web.Services.dll. Si vous ajoutez le proxy à l'aide d'une référence Web dans Visual Studio .NET, la référence est créée automatiquement. Pour plus d'informations, consultez « Ajout du proxy à l'aide d'une référence Web dans Visual Studio » plus loin dans cette rubrique.

    Après avoir ajouté la classe proxy comme un élément à votre projet, le fichier associé s'affiche dans l'Explorateur de solutions.

  3. Pour appeler le service par programme, créez une instance de la classe proxy.

    L'exemple de code suivant affiche la syntaxe permettant de créer une instance de la classe proxy ReportingService2010 dans un projet :

Dim service As New ReportingService2010()  

ReportingService2010 service = new ReportingService2010();

Pour plus d'informations sur l'outil Wsdl.exe, y compris sa syntaxe complète, consultez la rubrique « Web Services Description Language Tool » dans la documentation du Kit de développement logiciel (SDK) .NET Framework. Pour une explication complète des proxies de service Web, consultez « Création d'un proxy de service Web XML » dans la documentation du Kit de développement logiciel (SDK) .NET Framework.

Ajout du proxy à l'aide d'une référence Web dans Visual Studio

Une référence Web permet à un projet de faire appel à un ou plusieurs services Web Visual Studio permet aux utilisateurs d'ajouter des références de service Web aux projets en suivant quelques étapes simples.

Pour ajouter une référence web à un projet

  1. Dans l’Explorateur de solutions, sélectionnez le projet qui fera appel au service web.

  2. Dans le menu Projet, cliquez sur Ajouter une référence web.

    La boîte de dialogue Ajouter une référence web s’ouvre.

  3. Dans le champ URL, entrez le chemin complet du service web Report Server.

    Voici une URL simplifiée pour le point de terminaison d'exécution du rapport du service Web Report Server :

    https://<Server Name>/reportserver/reportexecution2005.asmx

    L'URL contient le domaine de déploiement du service Web Report Server, le nom du dossier qui contient le service, et le nom du fichier de découverte pour le service. Pour obtenir une description complète des différents éléments de l’URL, consultez Accès à l’API SOAP.

    Une description des méthodes et propriétés fournies par le service Web apparaît dans le volet Navigateur sur la gauche.

    Notes

    Pour plus d’informations sur les éléments associés au service web Report Server, consultez Méthodes du service web Report Server.

  4. Vérifiez que votre projet peut utiliser le service Web Report Server, et que vous avez l'autorisation appropriée d'accéder au serveur de rapports.

  5. Dans le champ Nom de la référence web, entrez un nom que vous utiliserez dans votre code pour accéder par programmation au service web Report Server sélectionné.

  6. Sélectionnez le bouton Ajouter une référence pour créer une référence dans votre application destinée au service web.

    La nouvelle référence est affichée dans l’Explorateur de solutions sous le nœud Références web du projet actif ; elle est nommée en fonction des informations spécifiées dans le champ Nom de la référence web.

  7. Dans l’Explorateur de solutions, développez le dossier Références web pour noter l’espace de noms des classes de la référence web qui sont disponibles pour les éléments de votre projet.

    Après avoir ajouté une référence web à votre projet, les fichiers associés sont affichés dans un dossier au sein du dossier Références web de l’Explorateur de solutions.

Après avoir ajouté la référence Web, utilisez la syntaxe suivante pour créer une instance de la classe proxy :

Dim rs As New myNamespace.myReferenceName.ReportExecutionService()  
rs.Url = "https://<Server Name>/reportserver/reportexecution2005.asmx?wsdl"  
rs.Credentials = System.Net.CredentialCache.DefaultCredentials  

myNamespace.myReferenceName.ReportExecutionService rs = new myNamespace.myReferenceName.ReportExecutionService();  
rs.Url = "https://<Server Name>/reportserver/reportexecution2005.asmx?wsdl";  
rs.Credentials = System.Net.CredentialCache.DefaultCredentials;

Vous pouvez également ajouter une directive using (Import en Visual Basic) à la référence de service web Report Server. Si vous utilisez cette directive, il n'est pas nécessaire de qualifier complètement les types dans l'espace de noms. Pour cela, ajoutez le code suivant à votre fichier :

Import myNamespace.myReferenceName  

using myNamespace.myReferenceName;

Contenu connexe