Pierwsze kroki z biblioteką klienta Java Google Data

Stephanie Liu, Zespół Google Data API
Wrzesień 2007 r.
  1. Wprowadzenie
  2. Instalowanie zależności
    1. W systemie Windows:
    2. W systemie Mac OS X
    3. W systemie Linux:
  3. Instalowanie biblioteki danych Google
  4. Uruchomione próbki
  5. Tworzenie własnych aplikacji
  6. Podsumowanie
  7. Dodatek: ustawianie zmiennych środowiskowych

Wprowadzenie

Rozpoczęcie programowania przy użyciu nieznanego interfejsu API nigdy nie jest łatwe, dlatego w tym artykule znajdziesz szczegółowe instrukcje pobierania oraz instalowania biblioteki klienta interfejsu Google Data API („GData”). Przeprowadzę wszystkie zależności i skonfiguruję potrzebne zmienne środowiskowe. Błyskawicznie nauczysz się łączyć różne usługi GData!

Korzystasz z Eclipse?

Przeczytaj artykuł Kodowanie w cieniu: korzystanie z Eclipse z interfejsami Google Data API.

Instalowanie zależności

Biblioteka klienta Java w GData ma następujące zależności zewnętrzne. Z sekcji poniżej dowiesz się, jak zainstalować te zależności w swoim ulubionym systemie operacyjnym (lub OS, z którym utkniesz w pracy).

  • JDK (Java Development Kit) w wersji 1.5 lub nowszej
  • Apache Ant w wersji 1.7 lub nowszej
  • mail.jar w interfejsie Sun API w języku JavaMail API 1.4 lub nowszym,
  • parametr aktywacji.jar w środowisku Java Java BeansActivateFramework. Jest to wymagane tylko w przypadku interfejsów API związanych z multimediami, w tym API Document List Data API, Picasa Web Albums API i YouTube Data API.
  • serwlet.jar w interfejsie API Servlet w wersji 2.3 lub nowszej. Jest to wymagane tylko w przypadku wykonywania przykładowych kodów w pakietach „sample.authsub” lub „sample.gbase.Recipe”.

Niektóre zależności .jar wymagają tylko konkretnych próbek, ale aby uniknąć błędów kompilacji, najlepiej po prostu pobrać wszystko. Aby przejść dalej, wybierz system operacyjny: Windows, macOS X lub Linux.

Instalowanie Biblioteki klienta danych Google

  1. Wejdź na http://code.google.com/p/gdata-java-client/downloads/list.
  2. Pobierz najnowszą wersję biblioteki klienta (gdata-src.java-1.x.x.java.zip) i przykłady (gdata-samples.java-1.x.x.java.zip).
  3. Rozpakuj źródło biblioteki klienta na komputerze.
  4. Przejdź do pliku gdata/java/build-src/build.properties i otwórz plik.
  5. Edytuj zależności zewnętrzne, aby wskazać lokalizacje plików .jar na komputerze lokalnym.

    6. Uwaga: w systemie Windows musisz stosować ukośnik lewy. Na przykład

    servlet.jar=C:\\Program Files\\Apache Software Foundation\\Tomcat 6.0\\lib\\servlet-api.jar

Uruchomione próbki

Wszystkie dostępne próbki znajdują się w folderze gdata/java/sample z archiwum gdata-samples.java-1.x.x.java.zip. Plik gdata/java/build-samples/build.properties zawiera wszystkie wartości wejściowe dla próbek znajdujących się w bibliotece. Ustaw sample.credentials.username i sample.credentials.password jako prawidłową nazwę użytkownika i hasło. Do tworzenia i wykonywania przykładów można używać Ant.

Sprawdź, czy wszystko zostało zainstalowane – otwórz wiersz poleceń, przejdź do katalogu gdata/java i wpisz:

ant -f build-samples.xml sample.calendar.run

Możesz otrzymać komunikaty lub ostrzeżenia, ale na końcu poszukaj wiadomości BUILD SUCCESSFUL. Jeśli nie pojawi się komunikat o powodzeniu, przejdź do sekcji rozwiązywania problemów.

Wypróbuj bardziej interaktywną próbkę, wpisując:

ant -f build-samples.xml sample.spreadsheet.guidemo.run

Aby dowiedzieć się, jak uruchomić konkretną próbkę, otwórz gdata/java/build-samples i sprawdź plik kompilacji dla tej próbki. Znajdź sekcję samples run.

Rozwiązywanie problemów

Jeśli kompilacja się nie powiedzie, zobaczysz komunikat o błędzie:

BUILD FAILED
Target 'core.sample.core.util.build' does not exist in this project. It is used from target 'sample.calendar.build'.

Total time: 0 seconds

lub wyświetlić podobny komunikat o błędzie dotyczący nieistotnego pliku w projekcie, możesz korzystać ze starszej wersji Ant. Wpisz ant -version, aby mieć pewność, że korzystasz z wersji 1.7 lub nowszej. Aby pobrać najnowszą wersję Ant, postępuj zgodnie z instrukcjami dotyczącymi zależności powyżej.

Tworzenie własnych aplikacji

Kolejne pytanie to tworzenie własnej aplikacji. Przejrzę Twój odpowiednik w programie „Hello, world!” w usłudze Kalendarz, aby pokazać podstawowe funkcje. Więcej szczegółowych informacji znajdziesz w podręczniku programisty Javy oraz w przewodnikach dla programistów dotyczących poszczególnych usług.

Utwórz plik o nazwie CalendarTest.java. Zacznij od tych instrukcji importu.

import com.google.gdata.client.*;
import com.google.gdata.client.calendar.*;
import com.google.gdata.data.*;
import com.google.gdata.data.acl.*;
import com.google.gdata.data.calendar.*;
import com.google.gdata.data.extensions.*;
import com.google.gdata.util.*;

import java.net.*;
import java.io.*;

import sample.util.*;

Oto cały program (bez obsługi wyjątków).

public class CalendarTest {

    public static void main(String[] args) {
        CalendarService myService = new CalendarService("exampleCo-exampleApp-1.0");
        myService.setUserCredentials("root@gmail.com", "pa$$word");

        URL feedUrl = new URL("http://www.google.com/calendar/feeds/default/allcalendars/full");
        CalendarFeed resultFeed = myService.getFeed(feedUrl, CalendarFeed.class);

        System.out.println("Your calendars:");
        System.out.println();

        for (int i = 0; i < resultFeed.getEntries().size(); i++) {
          CalendarEntry entry = resultFeed.getEntries().get(i);
          System.out.println("\t" + entry.getTitle().getPlainText());
        }

    }
}

This little program will request all the calendars you own and display all the titles. It's a little longer than the canonical "Hello, World!" example, but it's very simple once we break it down. The first couple of lines creates a service object and sets the user credentials.

CalendarService myService = new CalendarService("exampleCo-exampleApp-1.0");
myService.setUserCredentials("root@gmail.com", "pa$$word");

Następnie ustawisz adres URL zasobu. W tym przypadku możesz poprosić o listę wszystkich kalendarzy od uwierzytelnionego użytkownika.

URL feedUrl = new URL("http://www.google.com/calendar/feeds/default/allcalendars/full");

Wiersz poniżej wykonuje faktyczne polecenie GET adresu URL i umieszcza wynikowy plik danych w bezpiecznym miejscu.

CalendarFeed resultFeed = myService.getFeed(feedUrl, CalendarFeed.class);

Poniższa pętla for będzie iterować po każdym wpisie i wyświetli tytuł. Tytuł jest przechowywany jako TextConstruct, więc do uzyskania zwykłego tekstu wymagane jest dodatkowe wywołanie funkcji.

for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    CalendarEntry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
}

To było całkiem proste – Przyjrzyjmy się kilku innym kwestiom. Poniższy fragment kodu pozwala utworzyć i wstawić obiekt. W naszym przykładzie będzie to nowy wpis w wydarzeniu z kalendarza.

URL postURL = new URL("http://www.google.com/calendar/feeds/root@gmail.com/private/full");
CalendarEventEntry myEvent = new CalendarEventEntry();

//Set the title and description
myEvent.setTitle(new PlainTextConstruct("Pi Day Party"));
myEvent.setContent(new PlainTextConstruct("I am throwing a Pi Day Party!"));

//Create DateTime events and create a When object to hold them, then add
//the When event to the event
DateTime startTime = DateTime.parseDateTime("2007-03-14T15:00:00-08:00");
DateTime endTime = DateTime.parseDateTime("2007-03-14T17:00:00-08:00");
When eventTimes = new When();
eventTimes.setStartTime(startTime);
eventTimes.setEndTime(endTime);
myEvent.addTime(eventTimes);

// POST the request and receive the response:
CalendarEventEntry insertedEntry = myService.insert(postURL, myEvent);

Kolejną typową operacją jest utworzenie zapytania.

//Create a new query object and set the parameters
Query myQuery = new Query(feedURL);
myQuery.setFullTextQuery("Pi");

//Send the request with the built query URL
CalendarEventFeed myResultsFeed = myService.query(myQuery, CalendarEventFeed.class);

//Take the first match and print the title
if (myResultsFeed.getEntries().size() > 0) {
    CalendarEventEntry firstMatchEntry = new CalendarEventEntry();
    myResultsFeed.getEntries().get(0);
    System.out.println(firstMatchEntry.getTitle().getPlainText());
}

Podczas debugowania inna użyteczna operacja jest usuwana nieprzetworzony plik XML. Możesz skorzystać z przydatnego narzędzia, które pomoże Ci to zrobić w bibliotece. Sprawdź, czy plik samples.util.* jest zaimportowany. Następnie skopiuj plik danych lub wpis.

CommonUtils.dump(resultFeed, System.out);

Więcej informacji o narzędziach do debugowania znajdziesz w artykule Debugowanie interfejsu API danych Google: analiza ruchu z programu, z którego dowiesz się, jak włączyć logowanie w bibliotece klienta.

Dzięki temu zorientujesz się, jak działa tworzenie aplikacji przy użyciu biblioteki klienta. Więcej informacji znajdziesz w sekcji podsumowania, w której znajdziesz listę dostępnych przewodników dla programistów korzystających z interfejsu Google Data API.

Podsumowanie

Mamy nadzieję, że teraz możesz tworzyć i uruchamiać aplikacje z wykorzystaniem biblioteki klienta Java GData! Nie udało mi się znaleźć żadnych popularnych IDE, których możesz użyć, ale możesz skorzystać z popularnych narzędzi, takich jak Eclipse lub NetBeans. Oto kilka dodatkowych linków, które mogą być przydatne:

Jeśli masz pytania dotyczące korzystania z biblioteki klienta Java w jakimkolwiek interfejsie API, możesz nas o tym poinformować, publikując na forach interfejsu API.