Na tej stronie samouczka Cloud Search znajdziesz informacje o konfigurowaniu źródła danych i sprzęgającego treści oprogramowania do 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 cloud-search-samples/end-to-end/connector
i uruchom to polecenie:
mvn package -DskipTests
To polecenie pobiera wymagane zależności potrzebne do skompilowania łącznika treści i kompiluje kod.
Tworzenie danych logowania do konta usługi
Aby wywoływać interfejsy Cloud Search API, sprzęg wymaga danych logowania do konta usługi. Aby utworzyć dane logowania:
- Wróć do konsoli Google Cloud.
- W panelu nawigacyjnym po lewej stronie kliknij Dane logowania. Pojawi się strona „Dane logowania”.
- Kliknij menu + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. Pojawi się strona „Tworzenie konta usługi”.
- W polu Nazwa konta usługi wpisz „tutorial”.
- Zanotuj wartość identyfikatora konta usługi (zaraz po nazwie konta usługi). Ta wartość jest używana później.
- Kliknij UTWÓRZ. Wyświetli się okno „Uprawnienia konta usługi (opcjonalnie)”.
- 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. Pojawi się strona „Szczegóły konta usługi”.
- W sekcji Klucze kliknij menu DODAJ KLUCZ i wybierz Utwórz nowy klucz. Wyświetli się okno „Tworzenie klucza prywatnego”.
- Kliknij UTWÓRZ.
- (Opcjonalnie) Jeśli pojawi się okno „Czy chcesz zezwolić na pobieranie na console.cloud.google.com?”, kliknij Zezwól.
- Plik klucza prywatnego jest zapisywany na komputerze. Zanotuj lokalizację pobranego pliku. Ten plik służy do konfigurowania łącznika treści, aby mógł się uwierzytelnić podczas wywoływania interfejsów Google Cloud Search API.
Inicjowanie pomocy zewnętrznej
Zanim zaczniesz wywoływać inne interfejsy Cloud Search, musisz zainicjować obsługę Google Cloud Search przez zewnętrznych dostawców.
Aby zainicjować obsługę Cloud Search przez inne firmy:
Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Jednak aby zainicjować obsługę przez zewnętrznego dostawcę, musisz utworzyć dane logowania do aplikacji internetowej. Instrukcje tworzenia danych logowania do aplikacji internetowej znajdziesz w artykule Tworzenie danych logowania. Po wykonaniu tego kroku powinieneś mieć identyfikator klienta i tajny klucz klienta.
Aby uzyskać token dostępu, użyj narzędzia Google OAuth 2 Playground:
- Kliknij Ustawienia i zaznacz Użyj własnych danych logowania.
- Wpisz identyfikator 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 OAuth 2 Playground zwraca kod autoryzacji. - Kliknij Kod autoryzacji wymiany dla tokenów. Zwracany jest token.
Aby zainicjować obsługę Cloud Search przez inne firmy, 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" }
Jeśli nie uda Ci się tego zrobić, skontaktuj się z zespołem pomocy Cloud Search.
Aby sprawdzić, czy obsługa zewnętrzna jest zainicjowana, użyj wywołania operations.get:
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 inicjalizacji przez usługę innej firmy pole
done
będzie zawierać wartośćtrue
. 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 udostępnia przestrzeń nazw do indeksowania treści za pomocą łącznika.
- Otwórz konsolę administracyjną Google.
- Kliknij ikonę aplikacji. Pojawi się strona „Administracja aplikacjami”.
- Kliknij Google Workspace. Pojawi się strona „Administracja Google Workspace”.
- Przewiń w dół i kliknij Cloud Search (Wyszukiwanie w chmurze). Pojawi się strona „Ustawienia Google Workspace”.
- Kliknij Zewnętrzne źródła danych. Pojawi się strona „Źródła danych”.
- Kliknij okrągłe żółte +. 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 go na stronie Konta usługi.
- Kliknij DODAJ. Pojawi 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 łącznika treści.
Wygeneruj osobisty token dostępu do interfejsu GitHub API
Aby mieć wystarczającą pulę, usługa łącząca wymaga uwierzytelnionego dostępu do interfejsu GitHub API. Ze względu na prostotę łącznik korzysta z osobowych tokenów dostępu zamiast 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. Pojawi się menu.
- Kliknij Ustawienia.
- Kliknij Ustawienia programisty.
- Kliknij Osobiste tokeny dostępu.
- Kliknij Wygeneruj osobisty token dostępu.
- W polu Uwaga wpisz „Samouczek Cloud Search”.
- Sprawdź zakres public_repo.
- Kliknij Wygeneruj token.
- Zapisz wygenerowany token. Jest ono używane przez oprogramowanie sprzęgające do wywoływania interfejsów GitHub API i zapewnia limit interfejsu API do indeksowania.
Konfigurowanie oprogramowania sprzęgającego
Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację łącznika, aby uwzględnić te wartości:
- Z poziomu wiersza 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ę do pliku danych uwierzytelniających usługę, który został wcześniej pobrany. - Parametr
api.sourceId
ustaw na identyfikator wcześniej utworzonego źródła danych. - Ustaw parametr
github.user
na swoją nazwę użytkownika GitHuba. - Ustaw parametr
github.token
na utworzony wcześniej token dostępu. - Zapisz plik.
Aktualizowanie schematu
Pośrednik indeksuje zarówno treści uporządkowane, jak i nieuporządkowane. Przed zindeksowaniem danych 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ć usługę łączenie danych 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 pojedynczego repozytorium w organizacji googleworkspace
. Indeksowanie repozytorium trwa około 1 minuty.
Po początkowym zindeksowaniu usługa sprzęgająca nadal sprawdza repozytorium pod kątem zmian, które należy uwzględnić w indeksie Cloud Search.
Sprawdzanie kodu
Pozostałe sekcje opisują sposób tworzenia tego oprogramowania.
Uruchamianie aplikacji
Punkt wejścia do tego łącznika to klasa GithubConnector
. Metoda main
tworzy instancję pakietu SDK IndexingApplication
i go uruchamia.
ListingConnector
udostępniany przez pakiet SDK stosuje strategię przeszukiwania, która wykorzystuje koleje Cloud Search do śledzenia stanu elementów w indeksie. Deleguje ona do GithubRepository
, która jest implementowana przez przykładowy łącznik, aby uzyskać dostęp do treści z GitHuba.
Przechodzenie przez repozytoria GitHub
Podczas pełnego przeszukiwania wywoływana jest metoda getIds()
, aby przesłać elementy, które mogą wymagać indeksowania w kole.
Może on indeksować wiele repozytoriów lub organizacji. Aby zminimalizować wpływ awarii, naraz przeszukiwane jest tylko jedno repozytorium GitHub. Wraz z wynikami przechodzenia zwracany jest punkt kontrolny zawierający listę repozytoriów, które mają zostać zindeksowane w kolejnych wywołaniach funkcji getIds()
. Jeśli wystąpi błąd, indeksowanie zostanie wznowione w bieżącym repozytorium, a nie rozpocznie się od początku.
Metoda collectRepositoryItems()
obsługuje przechodzenie przez pojedyncze repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations
, która reprezentuje elementy do umieszczenia w kole. Elementy są przesyłane jako nazwa zasobu i wartość hasza reprezentująca bieżący stan elementu.
Wartość hasha jest używana podczas kolejnych przeszukiwań repozytoriów GitHub. Ta wartość umożliwia szybkie sprawdzenie, czy treści uległy zmianie, bez konieczności przesyłania dodatkowych treści. Pośrednik bezmyślnie umieszcza wszystkie elementy w kolejce. Jeśli element jest nowy lub zmieniła się jego wartość skrótu, jest on dostępny do pobierania w kolejce. W przeciwnym razie produkt jest uważany za niemodyfikowany.
Przetwarzanie kolejki
Po zakończeniu pełnego przeszukiwania oprogramowanie sprzęgające rozpoczyna sprawdzanie kolejki pod kątem elementów, które wymagają zindeksowania. Metoda getDoc()
jest wywoływana w przypadku każdego elementu pobranego z kolejki. Metoda odczytuje element z GitHuba i przekształci go w odpowiednią reprezentację do indeksowania.
Ponieważ oprogramowanie sprzęgające działa na podstawie danych na żywo, które mogą ulec zmianie w dowolnym momencie, getDoc()
sprawdza też, czy element w kole jest nadal prawidłowy, oraz usuwa z indeksu elementy, które już nie istnieją.
W przypadku każdego z obiektów GitHub, które indeksuje łącznik, odpowiednia metoda indexItem()
odpowiada za tworzenie reprezentacji elementu w wyszukiwarce Cloud. Na przykład, aby utworzyć reprezentację dla elementów treści:
Następnie wdrocz interfejs wyszukiwania.