Pierwsze kroki z biblioteką klienta .NET

Jeff Fisher, zespół Google Data API
sierpień 2007 r.

Wprowadzenie

Rozwiązanie Google Data API
Ilustracja 1. Rozwiązanie Google Data API

Dla wielu deweloperów najtrudniejszym elementem nowego projektu jest instalowanie nowych pakietów oprogramowania, konfigurowanie środowiska programistycznego i zdobywanie nowych bibliotek. W tym artykule znajdziesz szczegółowe instrukcje, jak zacząć korzystać z biblioteki klienta .NET przy użyciu Visual Studio 2005 na Windowsa, Mono na Linuksa oraz innych systemów operacyjnych Unix. Mam nadzieję, że w ten sposób zaoszczędzisz czas i ułatwisz sobie pracę z kodem.

Visual Studio 2008

Jeśli nie masz jeszcze zainstalowanej aplikacji Visual Studio 2008, możesz rozważyć korzystanie z bezpłatnej wersji Visual C# 2008 Express Edition, która pozwoli Ci pracować z biblioteką klienta .NET.

Konfigurowanie środowiska

  1. Pobierz najnowszą wersję MSI biblioteki klienta z http://code.google.com/p/google-gdata/downloads/list.
  2. Uruchom pobrany plik MSI, by zainstalować pakiet. Domyślnie zostanie ono zainstalowane na „C:\Program Files\Google\Google Data API SDK”. W kolejnych przykładach tego artykułu założono, że zainstalowano bibliotekę klienta w wybranej lokalizacji.
  3. Otwórz plik rozwiązania o nazwie „Google Data API SDK” w folderze „Google Data API SDK” w menu Start.

Kompilowanie i uruchamianie próbek

  1. Sprawdź, czy uruchomienie „Build > Build Solution” kończy się bez błędów.
  2. Aby utworzyć kompilację na potrzeby debugowania, kliknij „Kompilacja > Menedżer konfiguracji” i wybierz „Debuguj” jako aktywną konfigurację rozwiązania. Następnie wybierz „Utwórz > Utwórz rozwiązanie”.
  3. Skompilowane pliki binarne i DLL znajdziesz w folderze „C:\Program Files\Google\Google Data API SDK\Sources\Samples\". Możesz na przykład uruchomić aplikację Kalendarz, wykonując „C:\Program Files\Google\Google Data API SDK\Sources\Calendar\bin\Debug\Calendar.exe”. Do tych przykładów dostępne są też skróty do menu Start.

Tworzenie własnej aplikacji

Jeśli chcesz programować w projekcie spoza pliku rozwiązania dostarczonego w pliku MSI, musisz dodać pliki DLL biblioteki klienta jako ścieżkę referencyjną.

  1. utworzyć lub otworzyć projekt poza rozwiązaniem pakietu SDK Google API.
  2. Wybierz „Dodaj odwołanie” z menu Projekt.
  3. Kliknij kartę Przeglądaj.
  4. Przejdź do katalogu Redist w pakiecie SDK: „C:\Program Files\Google\Google Data API SDK\Redist”.
  5. Wybierz pliki DLL, które będą używane przez Twój kod. Pliki Google.GData.Extensions.dll i Google.GData.Client.dll będą potrzebne w większości projektów, a także w pliku DLL właściwych dla usług Google, których używasz w swojej aplikacji.

Uwaga: na urządzeniach mobilnych dostępny jest też plik rozwiązania dla bibliotek klienta. Znajduje się on domyślnie w folderze „C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile”. To rozwiązanie skompiluje tylko pliki DLL bibliotek klienta.

Przeprowadzanie testów NUnit

Jeśli wprowadzisz odpowiednie zmiany w bibliotekach klienta lub planujesz w nich uczestniczyć, musisz sprawdzić, czy odpowiednie testy NUnit są testowane prawidłowo. Jeśli planujesz korzystać z bibliotek klienta bez modyfikacji, zwykle nie trzeba ich uruchamiać.

  1. Pobierz plik MSI .NET 2.0 ze strony http://www.nunit.org/index.php?p=download.
  2. Zainstaluj NUnit, uruchamiając plik MSI. Domyślna lokalizacja instalacji jest podobna do lokalizacji „C:\Program Files\NUnit 2.4.8”. Możesz to zmienić na przykład na „C:\Program Files\NUnit”, by w przyszłości przejść na wyższą wersję bez potrzeby zmiany ścieżki w projekcie Visual Studio.
  3. Przejdź do katalogu „C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005” i otwórz plik rozwiązania „Google Data API”. Wyświetli się Kreator konwersji, ponieważ jest to plik projektu Visual Studio 2005. Postępuj zgodnie z instrukcjami lub kliknij przycisk „Zakończ”. Powinien wyświetlić się dziennik konwersji, który możesz zignorować.
  4. Teraz jako jednostkę referencyjną należy dodać jednostkę NUnit. Kliknij prawym przyciskiem myszy projekt „unittests” w Eksploratorze rozwiązań po prawej stronie i wybierz „Właściwości”. W wyświetlonym oknie kliknij kartę „Ścieżki referencyjne”. Jako lokalizację referencyjną wpisz lokalizację podfolderu „bin” instalacji NUnit i kliknij „Dodaj folder”. Jeśli na przykład zainstalowano jednostkę NUnit do „C:\Program Files\NUnit\”, trzeba wpisać „C:\Program Files\NUnit\bin”. Zanim przejdziesz dalej, zapisz tę zmianę.
  5. Aby ponownie utworzyć bibliotekę klienta i testy jednostkowe, wykonaj czynności opisane w artykule Przygotowywanie i uruchamianie przykładów.
  6. Skopiuj plik „unittests.dll.config” z katalogu „C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests” do katalogu kompilacji debugowania „C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\". Pamiętaj o edytowaniu pliku, aby zawierał odpowiednie informacje na temat przeprowadzanych testów. Na przykład Base wymaga klucza interfejsu API, a Kalendarz wymaga nazwy użytkownika i hasła. Zalecamy użycie konta testowego bez żadnych danych, aby uniknąć usunięcia informacji podczas testów jednostkowych.
  7. Otwórz NUnit z menu Start.
  8. Przejdź do menu „Plik > Otwórz projekt” i wybierz plik „unittests.dll” z katalogu „C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\".
  9. Uruchom interesujące Cię testy jednostek. Pamiętaj, że niektóre testy wymagają ustawienia parametrów w pliku unittests.dll.config. Jeśli przeprowadzisz testy stresujące dla określonych usług, Twoje konto testowe może zostać oznaczone jako zawierające spam i nie będziesz mieć możliwości automatycznego przesyłania treści na serwery Google bez napotykania testów CAPTCHA.

Mono

Mono to projekt typu open source, który umożliwia uruchamianie aplikacji klienckich i serwerów .NET w systemach Linux, Solaris, Mac OS X, Windows i Unix. Deweloperom, którzy chcą pracować na jednej z tych platform, udostępniamy osobny plik ZIP z biblioteki klienta.

Konfigurowanie środowiska

  1. Pobierz najnowszą wersję pliku ZIP z biblioteki klienta z http://code.google.com/p/google-gdata/downloads/list.
  2. Rozpakuj do katalogu lokalnego (np. „/scratch/gdata.NET”)
  3. Użyj pakietu zarządzania dystrybucją do zainstalowania Mono. Możesz też pobrać program ze strony http://www.mono-project.com.
  4. W niektórych dystrybucjach musisz upewnić się, że plik nunit.framework.dll jest prawidłowo połączony z biblioteką mono. Jeżeli mono jest zainstalowane w folderze „/usr/lib/mono”, sprawdź, czy w folderze „/usr/lib/mono/1.0” znajdują się symbole symboliczne i „/usr/lib/mono/2.0” dla pliku nunit.framework.dll (który należy zainstalować w „/usr/lib/mono/gac/nunit.framework/<someversionstring>.nunit”).

Kompilowanie i uruchamianie próbek

  1. Zakładając, że biblioteka klienta jest zainstalowana w katalogu „/scratch/gdata.NET”, zmień katalog na „/scratch/gdata.NET/clients/cs”.
  2. Edytuj plik Makefile w zależności od wersji .NET, której chcesz użyć. W przypadku .NET 1.x użyj CSC=mcs, a .NET 2.x – CSC=gmcs.
  3. Uruchom make, aby skompilować biblioteki i przykładowe aplikacje.
  4. Wykonaj make install, jeśli chcesz zainstalować biblioteki bibliotek klienckich do biblioteki Mono.

Tworzenie własnej aplikacji

Jeśli wykonanie polecenia make install zostało wykonane po skompilowaniu biblioteki klienta, powinno być możliwe dodanie bibliotek do własnego kodu przez przesłanie -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll do kompilatora Mono C# wraz z odwołaniami do plików DLL konkretnych rozszerzeń usług, których chcesz użyć.

Przeprowadzanie testów NUnit

  1. Skopiuj plik unittests.dll.config z „/scratch/gdata.NET/clients/cs/src/unittests” do „/scratch/gdata.NET/clients/cs/”.
  2. Edytuj plik „/scratch/gdata.NET/clients/cs/unittests.dll.config”, aby podać odpowiednie informacje dla przeprowadzonych testów. Na przykład Base wymaga klucza interfejsu API, a Kalendarz wymaga nazwy użytkownika i hasła. Zalecamy użycie konta testowego bez żadnych danych, aby uniknąć usunięcia informacji podczas testów jednostkowych.
  3. Po skompilowaniu biblioteki w pliku „/scratch/gdata.NET/clients/cs” zostanie umieszczony plik unittests.dll. Użyj tej biblioteki DLL z wybranym menedżerem testów NUnit (np. konsola jednostkowa, gnunit).

Podsumowanie

Teraz możesz skompilować biblioteki i uruchomić przykładowy kod. To jednak dopiero początek. Zachęcamy do zapoznania się z dokumentacją znajdującą się w katalogu „.../clients/cs/docs” w bibliotece klienta. Możesz też zapoznać się z przewodnikiem dla programistów korzystających z biblioteki klienta.NET, ze stroną projektu i przewodnikiem oraz z forum bibliotek .NET Google Data Library.

Narzędzia wymienione w tym artykule:

Powodzenia w kolejnej aplikacji .NET!