Erste Schritte mit der .NET-Clientbibliothek

Jeff Fisher, Google Data APIs-Team
August 2007

Einführung

Die Google Data API-Lösung
Abbildung 1: Die Google Data API-Lösung

Für viele Entwickler ist das Schwierigste daran, neue Softwarepakete zu installieren, eine Entwicklungsumgebung zu konfigurieren und neue Bibliotheken zu erlernen. In diesem Artikel habe ich Schritt-für-Schritt-Anleitungen zum Einstieg in die .NET-Clientbibliothek mit Visual Studio 2005 für Windows oder Mono für Linux und andere Unix-Betriebssysteme zusammengestellt. Ich hoffe, dass Sie damit einige Zeit sparen und schnell mit Code arbeiten können.

Visual Studio 2008

Falls Sie Visual Studio 2008 noch nicht installiert haben, können Sie Visual C# 2008 Express Edition verwenden, eine kostenlose Version von Visual Studio, mit der Sie die .NET-Clientbibliothek verwenden können.

Umgebung einrichten

  1. Laden Sie unter http://code.google.com/p/google-gdata/downloads/list den neuesten MSI-Release der Clientbibliothek herunter.
  2. Führen Sie die heruntergeladene MSI-Datei aus, um das Paket zu installieren. Es wird standardmäßig unter „C:\Program Files\Google\Google Data API SDK“ installiert. In weiteren Beispielen in diesem Artikel wird davon ausgegangen, dass Sie die Clientbibliothek an diesem Speicherort installiert haben.
  3. Öffnen Sie im Startmenü die Datei „Google Data API SDK“ im Ordner „Google Data API SDK“.

Beispiele kompilieren und ausführen

  1. Prüfen Sie, ob die Ausführung von „Build > Build Solution“ fehlerfrei ausgeführt wird.
  2. Gehen Sie zu „Build > Configuration Manager“ und wählen Sie „Debug“ als aktive Lösungskonfiguration aus. Wählen Sie dann „Build > Build Solution“ aus.
  3. Sie finden die Binärdateien und DLL-Dateien, die Sie gerade kompiliert haben, unter „C:\Program Files\Google\Google Data API SDK\Sources\Samples\“. Sie können beispielsweise die Beispielanwendung für Google Kalender ausführen, indem Sie „C:\Program Files\Google\Google Data API\Sources\Samples\calendar\bin\Debug\Calendar.exe“ ausführen. Für diese Beispiele gibt es auch einige Tastenkürzel für das Startmenü.

Eigene Anwendungen entwickeln

Wenn Sie in einem Projekt außerhalb der von der MSI-Datei bereitgestellten Lösungsdatei entwickeln möchten, müssen Sie die DLL-Dateien der Clientbibliothek als Referenzpfad hinzufügen.

  1. Erstellen oder öffnen Sie ein Projekt außerhalb der Google API SDK-Lösung.
  2. Wählen Sie im Menü „Projekt“ die Option „Referenz hinzufügen“ aus.
  3. Klicken Sie auf den Tab „Durchsuchen“.
  4. Gehen Sie im SDK zum Verzeichnis „Reds“: „C:\Programme Google\Google Data API \Redist“.
  5. Wählen Sie die DLL-Dateien aus, die von Ihrem Code verwendet werden sollen. Für die meisten Projekte werden Google.GData.Extensions.dll und Google.GData.Client.dll benötigt, zusammen mit der DLL-Datei für die Google-Dienste, die Sie in Ihrer Anwendung verwenden.

Hinweis:Es gibt auch eine Lösungsdatei für Clientbibliotheken auf Mobilgeräten. Sie finden sie standardmäßig unter „C:\Programme \Google\Google Data API \Sources\Library\VS2005.mobile“. Bei dieser Lösung werden nur die DLL-Dateien für die Clientbibliotheken kompiliert.

NUnit-Tests ausführen

Achten Sie darauf, dass die entsprechenden NUnit-Tests erfolgreich sind, wenn Sie Änderungen an den Clientbibliotheken vornehmen oder einen Beitrag dazu leisten möchten. Wenn Sie die Clientbibliotheken ohne Änderungen verwenden möchten, müssen Sie sie normalerweise nicht ausführen.

  1. Laden Sie die MSI-Datei für .NET 2.0-Dateien von NUnit unter http://www.nunit.org/index.php?p=download herunter.
  2. Installieren Sie NUnit, indem Sie die MSI-Datei ausführen. Der Standardinstallationspfad sieht in etwa so aus: "C:\Programme\NUnit 2.4.8". Möglicherweise möchten Sie die Datei in „C:\Programme\NUnit“ ändern, damit Sie ein Upgrade für NUnit ausführen können, ohne den Pfad in Ihrem Visual Studio-Projekt ändern zu müssen.
  3. Gehen Sie zum Verzeichnis „C:\Programme\Google\Google Data API\Sources\Library\VS2005“ und öffnen Sie die Lösungsdatei „Google Data APIs“. Sie sehen den Conversion-Assistenten, da es sich um eine Projektdatei von Visual Studio 2005 handelt. Klicken Sie entweder auf die Eingabeaufforderungen oder klicken Sie einfach auf die Schaltfläche „Fertigstellen“. Es sollte das Conversion-Protokoll enthalten, das ignoriert werden kann.
  4. Jetzt muss NUnit als Referenzpfad hinzugefügt werden. Klicken Sie rechts im Projektmappen-Explorer auf das Projekt „unittests“ und wählen Sie „Properties“ (Eigenschaften) aus. Klicken Sie im angezeigten Fenster auf den Tab „Referenzpfade“. Geben Sie den Speicherort des Unterverzeichnisses „bin“ der NUnit-Installation als Referenzpfad an und klicken Sie auf „Add Folder“ (Ordner hinzufügen). Wenn NUnit beispielsweise unter „C:\Programme\NUnit\“ installiert ist, würden Sie „C:\Programme\NUnit\bin“ eingeben. Speichern Sie diese Änderung, bevor Sie fortfahren.
  5. Führen Sie die Schritte unter Beispiele kompilieren und ausführen aus, um die Clientbibliothek und die Einheitentests neu zu erstellen.
  6. Kopieren Sie die Datei „unittests.dll.config“ in „C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\“ in das Debug-Build-Verzeichnis „C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\“. Bearbeiten Sie die Datei so, dass sie die entsprechenden Informationen für die Tests enthält, die Sie ausführen. Für Google Base sind beispielsweise ein API-Schlüssel und für Google Kalender ein Nutzername und ein Passwort erforderlich. Es wird empfohlen, ein Testkonto ohne Live-Daten zu verwenden, um zu verhindern, dass Informationen durch die Einheitentests gelöscht werden.
  7. Öffnen Sie NUnit im Startmenü.
  8. Gehen Sie zu „File > Open Project“ (Datei > Projekt öffnen) und wählen Sie die Datei „unittests.dll“ unter „C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\“ aus.
  9. Führen Sie die gewünschten Einheitentests aus. Für bestimmte Tests müssen Parameter in „unittests.dll.config“ festgelegt sein. Wenn du die Stresstests für bestimmte Dienste ausführst, kann es sein, dass dein Testkonto Spam generiert und Inhalte nicht programmatisch an Google-Server senden können, ohne dass CAPTCHA-Eingaben gestellt werden.

Mono

Mono ist ein Open-Source-Projekt, mit dem Sie .NET-Client- und -Serveranwendungen unter Linux, Solaris, Mac OS X, Windows und Unix ausführen können. Für Entwickler, die auf einer dieser Plattformen arbeiten möchten, stellen wir eine separate ZIP-Datei unserer Clientbibliothek zur Verfügung.

Umgebung einrichten

  1. Laden Sie unter http://code.google.com/p/google-gdata/downloads/list den neuesten ZIP-Datei-Release der Clientbibliothek herunter.
  2. In ein lokales Verzeichnis extrahieren (z.B. „/scratch/gdata.NET“)
  3. Verwenden Sie die Paketverwaltung Ihrer Distribution, um Mono zu installieren. Sie können es auch von http://www.mono-project.com herunterladen.
  4. Bei einigen Distributionen müssen Sie sicherstellen, dass die Datei Nunit.framework.dll ordnungsgemäß mit der Mono-Bibliothek verknüpft ist. Wenn mono in "/usr/lib/mono" installiert wurde, prüfen Sie, ob symbolische Links in "/usr/lib/mono/1.0" und "/usr/lib/mono/2.0" für nunit.framework.dll vorhanden sind (die in "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework.dll" installiert sein sollten).

Beispiele kompilieren und ausführen

  1. Wenn Sie die Clientbibliothek unter „/scratch/gdata.NET“ installiert haben, wechseln Sie in das Verzeichnis „/scratch/gdata.NET/clients/cs“.
  2. Bearbeiten Sie das Makefile je nach der gewünschten .NET-Version. Verwenden Sie für .NET 1.x CSC=mcs und für .NET 2.x CSC=gmcs.
  3. Führen Sie make aus, um die Bibliotheken und Beispielanwendungen zu kompilieren.
  4. Führen Sie make install aus, wenn Sie die DLLs der Clientbibliothek in der Mono-Bibliothek installieren möchten.

Eigene Anwendungen entwickeln

Wenn Sie make install ausgeführt haben, nachdem Sie die Clientbibliothek kompiliert haben, sollten Sie die Bibliotheken in Ihren eigenen Code aufnehmen können. Dazu übergeben Sie -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll an den Mono-C#-Compiler sowie Verweise auf die DLL-Dateien der gewünschten Diensterweiterungen.

NUnit-Tests ausführen

  1. Kopieren Sie die Datei unitunits.dll.config von „/scratch/gdata.NET/clients/cs/src/unittests“ nach „/scratch/gdata.NET/clients/cs/“.
  2. Bearbeiten Sie „/scratch/gdata.NET/clients/cs/unittests.dll.config“, um die entsprechenden Informationen für die ausgeführten Tests hinzuzufügen. Für Google Base sind beispielsweise ein API-Schlüssel und für Google Kalender ein Nutzername und ein Passwort erforderlich. Ich empfehle, ein Testkonto ohne Livedaten zu verwenden, um zu verhindern, dass Informationen durch die Einheitentests gelöscht werden.
  3. Nach dem Kompilieren der Bibliothek befindet sich die Datei unittests.dll in „/scratch/gdata.NET/clients/cs“. Verwenden Sie diese DLL mit Ihrem NUnit-Testmanager Ihrer Wahl (nunit-console, gnunit usw.).

Fazit

Jetzt sollten Sie die Bibliotheken kompilieren und den Beispielcode ausführen können. Dies ist jedoch erst der Anfang. Wir empfehlen Ihnen, die Dokumentation im Verzeichnis „.../clients/cs/docs“ der Clientbibliothek zu lesen. Sie können sich auch den Entwicklerleitfaden für die.NET-Clientbibliothek, die Projektseite und das Referenzhandbuch sowie das Forum für die Google Data .NET-Clientbibliothek ansehen.

In diesem Artikel behandelte Tools:

Viel Erfolg bei Ihrer nächsten .NET-Anwendung!