Na tej stronie samouczka Cloud Search dowiesz się, jak skonfigurować źródło danych i oprogramowanie sprzęgające treści do indeksowania danych. Aby rozpocząć od początku tego samouczka, zapoznaj się z samouczkiem Pierwsze kroki z Cloud Search.
Tworzenie oprogramowania sprzęgającego
Zmień katalog roboczy na cloud-search-samples/end-to-end/connector i uruchom to polecenie:
mvn package -DskipTests
To polecenie pobiera wymagane zależności potrzebne do utworzenia oprogramowania sprzęgającego treści i kompiluje kod.
Tworzenie danych logowania do konta usługi
Oprogramowanie sprzęgające wymaga danych logowania do konta usługi, aby wywoływać interfejsy Cloud Search API. Aby utworzyć dane logowania:
- Wróć do konsoli Google Cloud.
- W menu po lewej stronie kliknij Dane logowania. Wyświetli się strona „Dane logowania”.
- Kliknij listę + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. Wyświetli się strona „Utwórz konto usługi”.
- W polu Nazwa konta usługi wpisz „tutorial”.
- Zapisz wartość Identyfikator konta usługi (bezpośrednio po nazwie konta usługi). Ta wartość zostanie użyta później.
- Kliknij UTWÓRZ. Wyświetli się okno „Uprawnienia konta usługi (opcjonalnie)”.
- Kliknij DALEJ. Wyświetli się okno „Przyznaj użytkownikom dostęp do tego konta usługi (opcjonalnie)”.
- Kliknij GOTOWE. Wyświetli się ekran „Dane logowania”.
- W sekcji Konta usługi kliknij adres e-mail konta usługi. Wyświetli się strona „Szczegóły konta usługi”.
- W sekcji Klucze kliknij listę DODAJ KLUCZ i wybierz Utwórz nowy klucz. Wyświetli się okno „Utwórz klucz prywatny”.
- Kliknij UTWÓRZ.
- (opcjonalnie) Jeśli pojawi się okno „Czy chcesz zezwolić na pobieranie w konsoli console.cloud.google.com?”, kliknij Zezwól.
- Plik klucza prywatnego zostanie zapisany na komputerze. Zapisz lokalizację pobranego pliku. Ten plik służy do konfigurowania oprogramowania sprzęgającego treści, aby mogło się uwierzytelniać podczas wywoływania interfejsów Google Cloud Search API.
Inicjowanie obsługi innych firm
Zanim wywołasz inne interfejsy Cloud Search API, zainicjuj obsługę innych firm w Google Cloud Search.
Aby zainicjować obsługę innych firm:
- Utwórz dane logowania aplikacji internetowej w projekcie platformy Cloud Search. Zobacz Tworzenie danych logowania. Potrzebujesz identyfikatora klienta i tajnego klucza klienta.
- Uzyskaj token dostępu za pomocą
OAuth 2.0 Playground:
- Kliknij Konfiguracja OAuth 2.0 (ikona ustawień) i zaznacz Użyj własnych danych logowania OAuth.
- Wpisz identyfikator klienta i tajny klucz klienta.
- W polu zakresów wpisz
https://www.googleapis.com/auth/cloud_search.settingsi kliknij Autoryzuj interfejsy API. - Kliknij Kod autoryzacji wymiany dla tokenów.
Uruchom to polecenie curl, zastępując
[YOUR_ACCESS_TOKEN]swoim tokenem:curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressedJeśli operacja się uda, treść odpowiedzi będzie zawierała
operation. Jeśli się nie uda, skontaktuj się z zespołem pomocy Cloud Search.Aby sprawdzić inicjację, użyj
operations.get:curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressedInicjowanie jest zakończone, gdy
donema wartośćtrue.
Tworzenie źródła danych
Następnie utwórz źródło danych w konsoli administracyjnej. Źródło danych zapewnia przestrzeń nazw do indeksowania treści za pomocą oprogramowania sprzęgającego.
- Otwórz konsolę administracyjną Google.
- Kliknij ikonę Aplikacje. Wyświetli się strona „Administracja aplikacjami”.
- Kliknij Google Workspace. Wyświetli się strona „Administracja aplikacjami Google Workspace”.
- Przewiń w dół i kliknij Cloud Search. Wyświetli się strona „Ustawienia Google Workspace”.
- Kliknij Zewnętrzne źródła danych. Wyświetli się strona „Źródła danych”.
- Kliknij okrągły żółty przycisk +. Wyświetli się okno „Dodaj nowe źródło danych”.
- W polu Wyświetlana nazwa wpisz „tutorial”.
- W polu Adresy e-mail kont usługi wpisz adres e-mail konta usługi utworzonego w poprzedniej sekcji. Jeśli nie znasz adresu e-mail konta usługi, znajdź tę wartość na stronie Konta usługi.
- Kliknij DODAJ. Wyświetli się okno „Źródło danych zostało utworzone”.
- Kliknij *OK. Zapisz Identyfikator źródła nowo utworzonego źródła danych. Identyfikator źródła służy do konfigurowania oprogramowania sprzęgającego treści.
Generowanie osobistego tokena dostępu do interfejsu GitHub API
Aby mieć wystarczający limit, oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu GitHub API. Dla uproszczenia oprogramowanie sprzęgające korzysta z osobistych tokenów dostępu zamiast z OAuth. Tokeny osobiste umożliwiają uwierzytelnianie jako użytkownik z ograniczonym zestawem uprawnień podobnym do OAuth.
- Zaloguj się w GitHubie.
- W prawym górnym rogu kliknij swoje zdjęcie profilowe. Wyświetli się menu.
- Kliknij Ustawienia.
- Kliknij Ustawienia programisty.
- Kliknij Osobiste tokeny dostępu.
- Kliknij Wygeneruj osobisty token dostępu.
- W polu Notatka wpisz „Samouczek Cloud Search”.
- Zaznacz zakres public_repo.
- Kliknij Wygeneruj token.
- Zapisz wygenerowany token. Jest on używany przez oprogramowanie sprzęgające do wywoływania interfejsów GitHub API i zapewnia limit interfejsu API do indeksowania.
Konfigurowanie wtyczki
Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację oprogramowania sprzęgającego, aby uwzględnić te wartości:
- W wierszu poleceń zmień katalog na
cloud-search-samples/end-to-end/connector/. - Otwórz plik
sample-config.propertiesw edytorze tekstu. - Ustaw parametr
api.serviceAccountPrivateKeyFilena ścieżkę pliku danych logowania do usługi pobranego wcześniej. - Ustaw parametr
api.sourceIdna identyfikator utworzonego wcześniej źródła danych. - Ustaw parametr
github.userna swoją nazwę użytkownika w GitHubie. - Ustaw parametr
github.tokenna utworzony wcześniej token dostępu. - Zapisz plik.
Aktualizowanie schematu
Oprogramowanie sprzęgające indeksuje zarówno treści uporządkowane, jak i nieuporządkowane. Zanim zaczniesz indeksować dane, musisz zaktualizować schemat źródła danych. Aby zaktualizować schemat, uruchom to polecenie:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Uruchamianie oprogramowania sprzęgającego
Aby uruchomić oprogramowanie sprzęgające i rozpocząć indeksowanie, uruchom to polecenie:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Domyślna konfiguracja oprogramowania sprzęgającego polega na indeksowaniu jednego repozytorium w organizacji googleworkspace. Indeksowanie repozytorium trwa około 1 minuty.
Po wstępnym indeksowaniu oprogramowanie sprzęgające nadal sprawdza zmiany w repozytorium, które należy uwzględnić w indeksie Cloud Search.
Sprawdzanie kodu
W pozostałych sekcjach opisujemy, jak utworzyć oprogramowanie sprzęgające.
Uruchamianie aplikacji
Punktem wejścia do oprogramowania sprzęgającego jest klasa GithubConnector. Metoda
main tworzy instancję pakietu SDK's IndexingApplication
i ją uruchamia.
Dostarczony przez pakiet SDK ListingConnector
implementuje strategię przechodzenia
która wykorzystuje kolejki Cloud Search
do śledzenia stanu elementów w indeksie. W celu uzyskania dostępu do treści z GitHuba deleguje on zadania do GithubRepository, zaimplementowanego przez przykładowe oprogramowanie sprzęgające.
Przechodzenie przez repozytoria GitHub
Podczas pełnego przechodzenia wywoływana jest metoda getIds()
, aby umieścić w kolejce elementy, które mogą wymagać indeksowania.
Oprogramowanie sprzęgające może indeksować wiele repozytoriów lub organizacji. Aby zminimalizować skutki awarii, przechodzenie odbywa się po jednym repozytorium GitHub. Wraz z wynikami przechodzenia zwracany jest punkt kontrolny zawierający listę repozytoriów, które mają być indeksowane w kolejnych wywołaniach getIds(). Jeśli wystąpi błąd, indeksowanie jest wznawiane w bieżącym repozytorium, a nie od początku.
Metoda collectRepositoryItems() obsługuje przechodzenie przez jedno repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations
reprezentującą elementy, które mają zostać umieszczone w kolejce. Elementy są umieszczane jako nazwa zasobu i wartość skrótu reprezentująca bieżący stan elementu.
Wartość skrótu jest używana w kolejnych przejściach przez repozytoria GitHub. Ta wartość umożliwia lekkie sprawdzenie, czy treść uległa zmianie, bez konieczności przesyłania dodatkowej treści. Oprogramowanie sprzęgające umieszcza w kolejce wszystkie elementy. Jeśli element jest nowy lub wartość skrótu uległa zmianie, jest on udostępniany do sprawdzania w kolejce. W przeciwnym razie element jest uznawany za niezmieniony.
Przetwarzanie kolejki
Po zakończeniu pełnego przechodzenia oprogramowanie sprzęgające zaczyna sprawdzać w kolejce elementy, które wymagają indeksowania. Dla każdego elementu pobranego z kolejki wywoływana jest metoda getDoc(). Metoda odczytuje element z GitHuba i przekształca go w odpowiednią reprezentację do indeksowania.
Ponieważ oprogramowanie sprzęgające działa na danych na żywo, które mogą się w każdej chwili zmienić, metoda getDoc() sprawdza też, czy element w kolejce jest nadal prawidłowy, i usuwa z indeksu wszystkie elementy, które już nie istnieją.
Dla każdego obiektu GitHub, który jest indeksowany przez oprogramowanie sprzęgające, odpowiednia metoda indexItem() obsługuje tworzenie reprezentacji elementu w Cloud Search. Aby na przykład utworzyć reprezentację elementów treści:
Następnie wdróż interfejs wyszukiwania.