Na tej stronie samouczka Cloud Search dowiesz się, jak skonfigurować źródło danych i oprogramowanie sprzęgające treści na potrzeby indeksowania danych. Aby rozpocząć od początku tego samouczka, zapoznaj się z samouczkiem wprowadzającym do Cloud Search.
Tworzenie oprogramowania sprzęgającego
Zmień katalog roboczy na katalog cloud-search-samples/end-to-end/connector
i uruchom to polecenie:
mvn package -DskipTests
Polecenie pobiera zależności wymagane do utworzenia łącznika treści i skompiluje kod.
Utwórz dane logowania do konta usługi
Do wywoływania interfejsów Cloud Search API oprogramowanie sprzęgające wymaga danych logowania konta usługi. Aby utworzyć dane logowania:
- Wróć do konsoli Google Cloud.
- W menu po lewej stronie kliknij Dane logowania. Pojawi się strona „Dane logowania”.
- Kliknij listę + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. Pojawi się strona „Utwórz konto usługi”.
- W polu Nazwa konta usługi wpisz „tutorial”.
- Zapisz wartość identyfikatora konta usługi (zaraz po nazwie konta usługi). Zostanie ona użyta później.
- Kliknij UTWÓRZ. Pojawi się okno „Uprawnienia konta usługi (opcjonalne)”.
- Kliknij DALEJ. Pojawi się okno „Przyznaj użytkownikom dostęp do tego konta usługi (opcjonalnie)”.
- Kliknij GOTOWE. Pojawi 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. Pojawi się okno „Utwórz klucz prywatny”.
- Kliknij UTWÓRZ.
- (Opcjonalnie) Jeśli pojawi się okno „Czy chcesz zezwolić na pobieranie na console.cloud.google.com?”, kliknij Zezwól.
- Plik z kluczem prywatnym jest zapisywany na Twoim komputerze. Zapamiętaj lokalizację pobranego pliku. Ten plik służy do konfigurowania oprogramowania sprzęgającego treści tak, aby mogło się uwierzytelnić podczas wywoływania interfejsów Google Cloud Search API.
Inicjowanie pomocy zewnętrznej
Zanim będzie można wywoływać inne interfejsy API Cloud Search, musisz zainicjować obsługę Google Cloud Search przez inną firmę.
Aby zainicjować obsługę Cloud Search przez inną firmę:
Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Aby jednak zainicjować pomoc zewnętrzną, musisz utworzyć dane logowania do aplikacji internetowej. Instrukcje tworzenia danych logowania do aplikacji internetowej znajdziesz w sekcji Tworzenie danych logowania. Po wykonaniu tej czynności powinien być już identyfikator klienta i plik z tajnym kluczem klienta.
Aby uzyskać token dostępu, skorzystaj z narzędzia Google do testowania protokołu OAuth 2:
- Kliknij ustawienia i zaznacz Użyj własnych danych uwierzytelniających.
- Wpisz identyfikator klienta i tajny klucz klienta z kroku 1.
- Kliknij Zamknij.
- W polu zakresów wpisz
https://www.googleapis.com/auth/cloud_search.settings
i kliknij Autoryzuj. Narzędzie do testowania OAuth 2 zwraca kod autoryzacji. - Kliknij Exchange authorization code for token (Kod autoryzacji giełdy dla tokenów). Zwracany jest token.
Aby zainicjować obsługę Cloud Search przez inną firmę, użyj tego polecenia curl. Pamiętaj, aby zastąpić
[YOUR_ACCESS_TOKEN]
tokenem uzyskanym w kroku 2.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 '{}' \ --compressed
Jeśli operacja się uda, treść odpowiedzi będzie zawierała wystąpienie obiektu
operation
. Przykład:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
W przypadku niepowodzenia skontaktuj się z zespołem pomocy Cloud Search.
Użyj polecenia operations.get, aby sprawdzić, czy pomoc innych firm została zainicjowana:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
Po zakończeniu inicjowania usługi zewnętrznej zawiera pole
done
ustawione natrue
. Na przykład:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: 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. Pojawi się strona „Administrowanie aplikacjami”.
- Kliknij Google Workspace. Pojawi się strona „Administracja aplikacjami Google Workspace”.
- Przewiń w dół i kliknij Cloud Search. Pojawi się strona „Ustawienia Google Workspace”.
- Kliknij Zewnętrzne źródła danych. Pojawi się strona „Źródła danych”.
- Kliknij okrągły żółty znak +. Pojawi się okno „Dodaj nowe źródło danych”.
- W polu Wyświetlana nazwa wpisz „tutorial”.
- W polu Adresy e-mail konta usługi wpisz adres e-mail konta usługi utworzonego w poprzedniej sekcji. Jeśli nie znasz adresu e-mail konta usługi, wyszukaj wartość na stronie Konta usługi.
- Kliknij DODAJ. Pojawi się okno „Utworzono źródło danych”.
- Kliknij *OK. Zapisz identyfikator źródła dla nowo utworzonego źródła danych. Identyfikator źródła służy do konfigurowania łącznika treści.
Generowanie osobistego tokena dostępu dla interfejsu GitHub API
Oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu GitHub API, aby zapewnić wystarczający limit. Dla uproszczenia oprogramowanie sprzęgające korzysta z osobistych tokenów dostępu zamiast z protokołu OAuth. Tokeny osobiste umożliwiają uwierzytelnianie użytkownika z ograniczonym zestawem uprawnień podobnych do OAuth.
- Zaloguj się w GitHubie.
- W prawym górnym rogu kliknij swoje zdjęcie profilowe. Pojawi się menu.
- Kliknij Ustawienia.
- Kliknij Ustawienia programisty.
- Kliknij Osobiste tokeny dostępu.
- Kliknij Generate personal access token (Wygeneruj osobisty token dostępu).
- W polu Notatka wpisz „Samouczek Cloud Search”.
- Sprawdź 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 udostępnia limit interfejsu API umożliwiający indeksowanie.
Konfigurowanie oprogramowania sprzęgającego
Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację oprogramowania sprzęgającego, dodając te wartości:
- W wierszu poleceń zmień katalog na
cloud-search-samples/end-to-end/connector/
. - Otwórz plik
sample-config.properties
w edytorze tekstu. - Ustaw parametr
api.serviceAccountPrivateKeyFile
na ścieżkę pliku pobranych wcześniej danych logowania do usługi. - Ustaw parametr
api.sourceId
na identyfikator wcześniej utworzonego źródła danych. - Ustaw parametr
github.user
na swoją nazwę użytkownika GitHub. - Ustaw parametr
github.token
na utworzony wcześniej token dostępu. - Zapisz plik.
Zaktualizuj schemat
Oprogramowanie sprzęgające indeksuje zarówno treści uporządkowane, jak i nieuporządkowane. Przed indeksowaniem danych musisz zaktualizować schemat źródła danych. Uruchom to polecenie, aby zaktualizować schemat:
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 polecenie:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Domyślną konfiguracją oprogramowania sprzęgającego jest indeksowanie pojedynczego repozytorium w organizacji googleworkspace
. Indeksowanie repozytorium trwa około minuty.
Po wstępnym indeksowaniu oprogramowanie sprzęgające nadal wyszukuje w repozytorium zmiany, które muszą zostać odzwierciedlone w indeksie Cloud Search.
Sprawdzanie kodu
W pozostałych sekcjach omawiamy sposób tworzenia oprogramowania sprzęgającego.
Uruchamianie aplikacji
Punktem wejścia oprogramowania sprzęgającego jest klasa GithubConnector
. Metoda main
tworzy instancję IndexingApplication
pakietu SDK i uruchamia go.
Parametr ListingConnector
udostępniany przez pakiet SDK implementuje strategię przemierzania, która wykorzystuje kolejki Cloud Search do śledzenia stanu elementów w indeksie. Przekazuje on dostęp do treści z GitHuba do interfejsu GithubRepository
zaimplementowanego przez przykładowe oprogramowanie sprzęgające.
Przeglądanie repozytoriów GitHub
Podczas pełnego przemierzania wywoływana jest metoda getIds()
, która przekazuje do kolejki elementy, które być może trzeba zindeksować.
Oprogramowanie sprzęgające może indeksować wiele repozytoriów lub organizacji. Aby zminimalizować wpływ awarii, poruszamy się po 1 repozytorium GitHub naraz. Zwracany punkt kontrolny z wynikami przemierzania zawierającymi listę repozytoriów do zindeksowania w kolejnych wywołaniach funkcji getIds()
. W przypadku błędu indeksowanie zostanie wznowione w bieżącym repozytorium, zamiast zaczynać od początku.
Metoda collectRepositoryItems()
obsługuje przemierzanie pojedynczego repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations
reprezentujących elementy, które mają zostać przekazane do kolejki. Elementy są przekazywane jako nazwa zasobu i wartość skrótu reprezentująca bieżący stan elementu.
Wartość skrótu jest używana podczas kolejnych przemierzania repozytoriów GitHub. Pozwala ona łatwo sprawdzić, czy treści się zmieniły, bez konieczności przesyłania dodatkowych treści. Łącznik na ślepo umieszcza wszystkie elementy w kolejce. Jeśli element jest nowy lub wartość skrótu uległa zmianie, jest on dostępny do odpytywania w kolejce. W przeciwnym razie produkt zostanie uznany za niezmodyfikowany.
Przetwarzam kolejkę
Po zakończeniu pełnego przemierzania oprogramowanie sprzęgające rozpoczyna odpytywanie kolejki w poszukiwaniu elementów, które mają zostać zindeksowane. Metoda getDoc()
jest wywoływana w przypadku każdego elementu pobranego z kolejki. Ta metoda odczytuje element z GitHuba i przekształca go w odpowiednią reprezentację do indeksowania.
Ponieważ oprogramowanie sprzęgające działa na podstawie bieżących danych, które można zmienić w dowolnym momencie, getDoc()
sprawdza też, czy element w kolejce jest nadal prawidłowy i usuwa z indeksu wszystkie elementy, które już nie istnieją.
W przypadku każdego z obiektów GitHub indeksowanego przez oprogramowanie sprzęgające używana jest odpowiednia metoda indexItem()
, która tworzy reprezentację elementu dla Cloud Search. Aby na przykład utworzyć reprezentację elementów treści:
Następnie wdróż interfejs wyszukiwania.