Premiers pas avec la bibliothèque cliente .NET

Jeff Fisher, équipe des API de données Google
août 2007

Introduction

Solution Google Data API
Figure 1 : Solution Google Data API

Pour de nombreux développeurs, la partie la plus difficile d'un nouveau projet consiste à se lancer : installer de nouveaux packages logiciels, configurer un environnement de développement et apprendre à utiliser de nouvelles bibliothèques. Dans cet article, j'ai rassemblé des instructions détaillées pour vous aider à commencer à utiliser la bibliothèque cliente .NET avec Visual Studio 2005 pour Windows ou Mono pour Linux et d'autres systèmes d'exploitation Unix. J'espère que cela vous fera gagner du temps pour vous lancer et vous permettra de commencer rapidement à travailler avec du code.

Visual Studio 2008

Si vous n'avez pas encore installé Visual Studio 2008, vous pouvez envisager d'utiliser Visual C# 2008 Express Edition, une version sans frais de Visual Studio qui vous permettra de travailler avec la bibliothèque cliente .NET.

Configurer votre environnement

  1. Téléchargez la dernière version MSI de la bibliothèque cliente depuis http://code.google.com/p/google-gdata/downloads/list.
  2. Exécutez le fichier MSI téléchargé pour installer le package. Par défaut, il sera installé dans "C:\Program Files\Google\Google Data API SDK\". Les autres exemples de cet article supposent que vous avez installé la bibliothèque cliente à cet emplacement.
  3. Ouvrez le fichier de solution "Google Data API SDK" dans le dossier "Google Data API SDK" du menu Démarrer.

Compiler et exécuter des exemples

  1. Vérifiez que l'exécution de "Build > Build Solution" (Compiler > Compiler la solution) se termine sans erreur.
  2. Pour créer une version Debug, accédez à "Build > Configuration Manager" (Compilation > Gestionnaire de configuration), puis sélectionnez "Debug" (Débogage) comme configuration de solution active. Sélectionnez ensuite "Build > Build Solution" (Compiler > Compiler la solution).
  3. Les fichiers binaires et DLL que vous venez de compiler se trouvent dans "C:\Program Files\Google\Google Data API SDK\Sources\Samples\". Par exemple, vous pouvez exécuter l'application exemple pour Agenda en exécutant "C:\Program Files\Google\Google Data API SDK\Sources\Samples\calendar\bin\Debug\Calendar.exe". Il existe également des raccourcis vers ces exemples dans le menu Démarrer.

Développer votre propre application

Si vous souhaitez développer dans un projet en dehors du fichier de solution fourni par le fichier MSI, vous devez ajouter les fichiers DLL de la bibliothèque cliente en tant que chemin de référence.

  1. Créez ou ouvrez un projet en dehors de la solution Google API SDK.
  2. Sélectionnez "Add Reference" (Ajouter une référence) dans le menu "Project" (Projet).
  3. Cliquez sur l'onglet "Parcourir".
  4. Accédez au répertoire Redist du SDK : "C:\Program Files\Google\Google Data API SDK\Redist".
  5. Sélectionnez les fichiers DLL qui seront utilisés par votre code. Google.GData.Extensions.dll et Google.GData.Client.dll seront nécessaires pour la plupart des projets, ainsi que le fichier DLL spécifique aux services Google que vous utilisez dans votre application.

Remarque : Il existe également un fichier de solution pour les bibliothèques clientes sur les appareils mobiles. Par défaut, il se trouve dans "C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile". Cette solution ne compilera que les fichiers DLL pour les bibliothèques clientes.

Exécuter les tests NUnit

Si vous apportez des modifications aux bibliothèques clientes ou prévoyez d'y contribuer, il est important de vous assurer que les tests NUnit appropriés sont concluants. Si vous prévoyez d'utiliser les bibliothèques clientes sans les modifier, il n'est normalement pas nécessaire de les exécuter.

  1. Téléchargez la version .NET 2.0 du fichier MSI de NUnit depuis http://www.nunit.org/index.php?p=download.
  2. Installez NUnit en exécutant le fichier MSI. L'emplacement d'installation par défaut est semblable à "C:\Program Files\NUnit 2.4.8". Vous pouvez remplacer ce chemin par un autre, par exemple "C:\Program Files\NUnit", afin de pouvoir mettre à niveau NUnit à l'avenir sans avoir à modifier le chemin dans votre projet Visual Studio.
  3. Accédez au répertoire "C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005" et ouvrez le fichier de solution nommé "Google Data APIs". L'assistant de conversion s'affiche, car il s'agit d'un fichier de projet Visual Studio 2005. Cliquez sur les invites ou simplement sur le bouton "Terminer". Le journal des conversions doit s'afficher. Vous pouvez l'ignorer.
  4. NUnit doit maintenant être ajouté en tant que chemin de référence. Effectuez un clic droit sur le projet "unittests" dans l'explorateur de solutions à droite, puis sélectionnez "Properties" (Propriétés). Cliquez ensuite sur l'onglet "Chemins de référence" dans la fenêtre qui s'ouvre. Saisissez l'emplacement du sous-répertoire "bin" de l'installation NUnit en tant que chemin d'accès de référence, puis cliquez sur "Add Folder" (Ajouter un dossier). Par exemple, si NUnit est installé dans "C:\Program Files\NUnit\", vous devez saisir "C:\Program Files\NUnit\bin". Veillez à enregistrer cette modification avant de continuer.
  5. Suivez les étapes décrites dans Compilation et exécution des exemples pour reconstruire la bibliothèque cliente et les tests unitaires.
  6. Copiez le fichier "unittests.dll.config" dans "C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\" vers le répertoire de compilation de débogage "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\". N'oubliez pas de modifier le fichier pour inclure les informations appropriées pour les tests que vous exécutez. Par exemple, Base nécessite une clé API, tandis qu'Agenda requiert un nom d'utilisateur et un mot de passe. Nous vous recommandons d'utiliser un compte de test sans données réelles pour éviter que des informations ne soient supprimées par les tests unitaires.
  7. Ouvrez NUnit depuis le menu Démarrer.
  8. Accédez à "File > Open Project" (Fichier > Ouvrir le projet), puis sélectionnez le fichier "unittests.dll" dans "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\".
  9. Exécutez les tests unitaires qui vous intéressent. N'oubliez pas que certains tests nécessitent la définition de paramètres dans unittests.dll.config pour fonctionner. Si vous exécutez des tests de charge pour certains services, il est possible que votre compte de test soit signalé comme générant du spam et que vous ne puissiez pas envoyer de contenu aux serveurs Google de manière programmatique sans rencontrer de problèmes liés à CAPTCHA.

Mono

Mono est un projet Open Source qui vous permet d'exécuter des applications client et serveur .NET sur Linux, Solaris, Mac OS X, Windows et Unix. Nous proposons un fichier ZIP distinct de notre bibliothèque cliente pour les développeurs qui souhaitent travailler sur l'une de ces plates-formes.

Configurer votre environnement

  1. Téléchargez la dernière version ZIP de la bibliothèque cliente depuis http://code.google.com/p/google-gdata/downloads/list.
  2. Extrayez-le dans un répertoire local (par exemple, "/scratch/gdata.NET").
  3. Utilisez la gestion des packages de votre distribution pour installer Mono. Vous pouvez également le télécharger sur http://www.mono-project.com.
  4. Dans certaines distributions, vous devez vous assurer que le fichier nunit.framework.dll est correctement associé à la bibliothèque mono. Si Mono a été installé dans "/usr/lib/mono", assurez-vous qu'il existe des liens symboliques dans "/usr/lib/mono/1.0" et "/usr/lib/mono/2.0" pour nunit.framework.dll (qui doit être installé dans "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework.dll").

Compiler et exécuter des exemples

  1. En supposant que vous avez installé la bibliothèque cliente dans "/scratch/gdata.NET", accédez au répertoire "/scratch/gdata.NET/clients/cs".
  2. Modifiez le fichier Makefile en fonction de la version de .NET que vous souhaitez utiliser. Pour .NET 1.x, utilisez CSC=mcs et pour .NET 2.x, utilisez CSC=gmcs.
  3. Exécutez make pour compiler les bibliothèques et les exemples d'applications.
  4. Exécutez make install si vous souhaitez installer les fichiers DLL de la bibliothèque cliente dans la bibliothèque Mono.

Développer votre propre application

Si vous avez exécuté un make install après avoir compilé la bibliothèque cliente, vous devriez pouvoir inclure les bibliothèques dans votre propre code en transmettant -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll au compilateur Mono C#, ainsi que des références aux fichiers DLL de toutes les extensions de service spécifiques que vous souhaitez utiliser.

Exécuter les tests NUnit

  1. Copiez le fichier unittests.dll.config de "/scratch/gdata.NET/clients/cs/src/unittests" vers "/scratch/gdata.NET/clients/cs/".
  2. Modifiez "/scratch/gdata.NET/clients/cs/unittests.dll.config" pour inclure les informations appropriées pour les tests que vous exécutez. Par exemple, Base nécessite une clé API, tandis qu'Agenda requiert un nom d'utilisateur et un mot de passe. Je vous recommande d'utiliser un compte de test sans données réelles pour éviter que des informations ne soient supprimées par les tests unitaires.
  3. Après avoir compilé la bibliothèque, un fichier unittests.dll se trouvera dans "/scratch/gdata.NET/clients/cs". Utilisez cette DLL avec le gestionnaire de tests NUnit de votre choix (nunit-console, gnunit, etc.).

Conclusion

Vous devriez maintenant pouvoir compiler les bibliothèques et exécuter l'exemple de code. Mais ce n'est qu'un début. Je vous encourage à lire la documentation disponible dans le répertoire ".../clients/cs/docs" de la bibliothèque cliente. Vous pouvez également consulter le guide du développeur de la bibliothèque cliente.NET, la page du projet et le guide de référence, ainsi que le forum de la bibliothèque cliente Google Data .NET.

Outils référencés dans cet article :

Bonne chance pour votre prochaine application .NET !