Wdrażanie oprogramowania sprzęgającego

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ąć ten samouczek od początku, 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 API Cloud Search. Aby utworzyć dane logowania:

  1. Wróć do konsoli Google Cloud.
  2. W menu po lewej stronie kliknij Dane logowania. Wyświetli się strona „Dane logowania”.
  3. Kliknij listę + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. Wyświetli się strona „Utwórz konto usługi”.
  4. W polu Nazwa konta usługi wpisz „tutorial”.
  5. Zapisz wartość Identyfikator konta usługi (bezpośrednio po nazwie konta usługi). Ta wartość będzie używana później.
  6. Kliknij UTWÓRZ. Wyświetli się okno „Uprawnienia konta usługi (opcjonalnie)”.
  7. Kliknij DALEJ. Wyświetli się okno „Przyznaj użytkownikom dostęp do tego konta usługi (opcjonalnie)”.
  8. Kliknij GOTOWE. Wyświetli się ekran „Dane logowania”.
  9. W sekcji Konta usługi kliknij adres e-mail konta usługi. Wyświetli się strona „Szczegóły konta usługi”.
  10. W sekcji Klucze kliknij listę DODAJ KLUCZ i wybierz Utwórz nowy klucz. Wyświetli się okno „Utwórz klucz prywatny”.
  11. Kliknij UTWÓRZ.
  12. (Opcjonalnie) Jeśli pojawi się okno „Czy chcesz zezwolić na pobieranie w konsoli.cloud.google.com?”, kliknij Zezwól.
  13. 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 API Google Cloud Search.

Inicjowanie obsługi usług innych firm

Zanim wywołasz inne interfejsy API Cloud Search, zainicjuj obsługę usług innych firm w Google Cloud Search.

Aby zainicjować obsługę usług innych firm:

  1. Utwórz dane logowania aplikacji internetowej w projekcie platformy Cloud Search. Zobacz Tworzenie danych logowania. Potrzebujesz identyfikatora klienta i tajnego klucza klienta.
  2. Uzyskaj token dostępu za pomocą OAuth 2.0 Playground:
    1. Kliknij Konfiguracja OAuth 2.0 (ikonę ustawień) i zaznacz Użyj własnych danych logowania OAuth.
    2. Wpisz identyfikator klienta i tajny klucz klienta.
    3. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj interfejsy API.
    4. Kliknij Kod autoryzacji wymiany dla tokenów.

  3. 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 '{}' \
  --compressed

    Jeśli operacja się uda, treść odpowiedzi będzie zawierała operation. Jeśli się nie uda, skontaktuj się z zespołem pomocy Cloud Search.

  4. 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' \
--compressed

    Inicjowanie jest zakończone, gdy done ma 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.

  1. Otwórz konsolę administracyjną Google.
  2. Kliknij ikonę Aplikacje. Wyświetli się strona „Administracja aplikacjami”.
  3. Kliknij Google Workspace. Wyświetli się strona „Administracja aplikacjami Google Workspace”.
  4. Przewiń w dół i kliknij Cloud Search. Wyświetli się strona „Ustawienia Google Workspace”.
  5. Kliknij Zewnętrzne źródła danych. Wyświetli się strona „Źródła danych”.
  6. Kliknij okrągły żółty przycisk +. Wyświetli się okno „Dodaj nowe źródło danych”.
  7. W polu Wyświetlana nazwa wpisz „tutorial”.
  8. 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.
  9. Kliknij DODAJ. Wyświetli się okno „Źródło danych zostało utworzone”.
  10. 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 API GitHub

Aby mieć wystarczający limit, oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu API GitHub. 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.

  1. Zaloguj się w GitHubie.
  2. W prawym górnym rogu kliknij swoje zdjęcie profilowe. Wyświetli się menu.
  3. Kliknij Ustawienia.
  4. Kliknij Ustawienia programisty.
  5. Kliknij Osobiste tokeny dostępu.
  6. Kliknij Wygeneruj osobisty token dostępu.
  7. W polu Notatka wpisz „Samouczek Cloud Search”.
  8. Zaznacz zakres public_repo.
  9. Kliknij Wygeneruj token.
  10. Zapisz wygenerowany token. Jest on używany przez oprogramowanie sprzęgające do wywoływania interfejsów API GitHub i zapewnia limit interfejsu API do przeprowadzania indeksowania.

Konfigurowanie oprogramowania sprzęgającego

Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację oprogramowania sprzęgającego, aby uwzględnić te wartości:

  1. W wierszu poleceń zmień katalog na cloud-search-samples/end-to-end/connector/.
  2. Otwórz plik sample-config.properties w edytorze tekstu.
  3. Ustaw parametr api.serviceAccountPrivateKeyFile na ścieżkę pliku danych logowania usługi pobranych wcześniej.
  4. Ustaw parametr api.sourceId na identyfikator utworzonego wcześniej źródła danych.
  5. Ustaw parametr github.user na swoją nazwę użytkownika w GitHubie.
  6. Ustaw parametr github.token na utworzony wcześniej token dostępu.
  7. 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 odzwierciedlić 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.

GithubConnector.java
/**
 * Main entry point for the connector. Creates and starts an indexing
 * application using the {@code ListingConnector} template and the sample's
 * custom {@code Repository} implementation.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new GithubRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args)
      .build();
  application.start();
}

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 po repozytoriach 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 zostanie wznowione w bieżącym repozytorium, a nie od początku.

GithubRepository.java
/**
 * Gets all of the existing item IDs from the data repository. While
 * multiple repositories are supported, only one repository is traversed
 * per call. The remaining repositories are saved in the checkpoint
 * are traversed on subsequent calls. This minimizes the amount of
 * data that needs to be reindex in the event of an error.
 *
 * <p>This method is called by {@link ListingConnector#traverse()} during
 * <em>full traversals</em>. Every document ID and metadata hash value in
 * the <em>repository</em> is pushed to the Cloud Search queue. Each pushed
 * document is later polled and processed in the {@link #getDoc(Item)} method.
 * <p>
 * The metadata hash values are pushed to aid document change detection. The
 * queue sets the document status depending on the hash comparison. If the
 * pushed ID doesn't yet exist in Cloud Search, the document's status is
 * set to <em>new</em>. If the ID exists but has a mismatched hash value,
 * its status is set to <em>modified</em>. If the ID exists and matches
 * the hash value, its status is unchanged.
 *
 * <p>In every case, the pushed content hash value is only used for
 * comparison. The hash value is only set in the queue during an
 * update (see {@link #getDoc(Item)}).
 *
 * @param checkpoint value defined and maintained by this connector
 * @return this is typically a {@link PushItems} instance
 */
@Override
public CheckpointCloseableIterable<ApiOperation> getIds(byte[] checkpoint)
    throws RepositoryException {
  List<String> repositories;
  // Decode the checkpoint if present to get the list of remaining
  // repositories to index.
  if (checkpoint != null) {
    try {
      FullTraversalCheckpoint decodedCheckpoint = FullTraversalCheckpoint
          .fromBytes(checkpoint);
      repositories = decodedCheckpoint.getRemainingRepositories();
    } catch (IOException e) {
      throw new RepositoryException.Builder()
          .setErrorMessage("Unable to deserialize checkpoint")
          .setCause(e)
          .build();
    }
  } else {
    // No previous checkpoint, scan for repositories to index
    // based on the connector configuration.
    try {
      repositories = scanRepositories();
    } catch (IOException e) {
      throw toRepositoryError(e, Optional.of("Unable to scan repositories"));
    }
  }

  if (repositories.isEmpty()) {
    // Nothing left to index. Reset the checkpoint to null so the
    // next full traversal starts from the beginning
    Collection<ApiOperation> empty = Collections.emptyList();
    return new CheckpointCloseableIterableImpl.Builder<>(empty)
        .setCheckpoint((byte[]) null)
        .setHasMore(false)
        .build();
  }

  // Still have more repositories to index. Pop the next repository to
  // index off the list. The remaining repositories make up the next
  // checkpoint.
  String repositoryToIndex = repositories.get(0);
  repositories = repositories.subList(1, repositories.size());

  try {
    log.info(() -> String.format("Traversing repository %s", repositoryToIndex));
    Collection<ApiOperation> items = collectRepositoryItems(repositoryToIndex);
    FullTraversalCheckpoint newCheckpoint = new FullTraversalCheckpoint(repositories);
    return new CheckpointCloseableIterableImpl.Builder<>(items)
        .setHasMore(true)
        .setCheckpoint(newCheckpoint.toBytes())
        .build();
  } catch (IOException e) {
    String errorMessage = String.format("Unable to traverse repo: %s",
        repositoryToIndex);
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Metoda collectRepositoryItems() obsługuje przechodzenie po jednym repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations reprezentującą elementy, które mają zostać umieszczone w kolejce. Elementy są umieszczane w kolejce jako nazwa zasobu i wartość skrótu reprezentująca bieżący stan elementu.

Wartość skrótu jest używana podczas kolejnych przechodzeń po repozytoriach GitHub. Ta wartość umożliwia szybkie 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.

GithubRepository.java
/**
 * Fetch IDs to  push in to the queue for all items in the repository.
 * Currently captures issues & content in the master branch.
 *
 * @param name Name of repository to index
 * @return Items to push into the queue for later indexing
 * @throws IOException if error reading issues
 */
private Collection<ApiOperation> collectRepositoryItems(String name)
    throws IOException {
  List<ApiOperation> operations = new ArrayList<>();
  GHRepository repo = github.getRepository(name);

  // Add the repository as an item to be indexed
  String metadataHash = repo.getUpdatedAt().toString();
  String resourceName = repo.getHtmlUrl().getPath();
  PushItem repositoryPushItem = new PushItem()
      .setMetadataHash(metadataHash);
  PushItems items = new PushItems.Builder()
      .addPushItem(resourceName, repositoryPushItem)
      .build();

  operations.add(items);
  // Add issues/pull requests & files
  operations.add(collectIssues(repo));
  operations.add(collectContent(repo));
  return operations;
}

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 podstawie 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ą.

GithubRepository.java
/**
 * Gets a single data repository item and indexes it if required.
 *
 * <p>This method is called by the {@link ListingConnector} during a poll
 * of the Cloud Search queue. Each queued item is processed
 * individually depending on its state in the data repository.
 *
 * @param item the data repository item to retrieve
 * @return the item's state determines which type of
 * {@link ApiOperation} is returned:
 * {@link RepositoryDoc}, {@link DeleteItem}, or {@link PushItem}
 */
@Override
public ApiOperation getDoc(Item item) throws RepositoryException {
  log.info(() -> String.format("Processing item: %s ", item.getName()));
  Object githubObject;
  try {
    // Retrieve the item from GitHub
    githubObject = getGithubObject(item.getName());
    if (githubObject instanceof GHRepository) {
      return indexItem((GHRepository) githubObject, item);
    } else if (githubObject instanceof GHPullRequest) {
      return indexItem((GHPullRequest) githubObject, item);
    } else if (githubObject instanceof GHIssue) {
      return indexItem((GHIssue) githubObject, item);
    } else if (githubObject instanceof GHContent) {
      return indexItem((GHContent) githubObject, item);
    } else {
      String errorMessage = String.format("Unexpected item received: %s",
          item.getName());
      throw new RepositoryException.Builder()
          .setErrorMessage(errorMessage)
          .setErrorType(RepositoryException.ErrorType.UNKNOWN)
          .build();
    }
  } catch (FileNotFoundException e) {
    log.info(() -> String.format("Deleting item: %s ", item.getName()));
    return ApiOperations.deleteItem(item.getName());
  } catch (IOException e) {
    String errorMessage = String.format("Unable to retrieve item: %s",
        item.getName());
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Dla każdego obiektu GitHub, który jest indeksowany przez oprogramowanie sprzęgające, odpowiednia metoda indexItem() obsługuje tworzenie reprezentacji elementu dla Cloud Search. Aby na przykład utworzyć reprezentację elementów treści:

GithubRepository.java
/**
 * Build the ApiOperation to index a content item (file).
 *
 * @param content      Content item to index
 * @param previousItem Previous item state in the index
 * @return ApiOperation (RepositoryDoc if indexing,  PushItem if not modified)
 * @throws IOException if unable to create operation
 */
private ApiOperation indexItem(GHContent content, Item previousItem)
    throws IOException {
  String metadataHash = content.getSha();

  // If previously indexed and unchanged, just requeue as unmodified
  if (canSkipIndexing(previousItem, metadataHash)) {
    return notModified(previousItem.getName());
  }

  String resourceName = new URL(content.getHtmlUrl()).getPath();
  FieldOrValue<String> title = FieldOrValue.withValue(content.getName());
  FieldOrValue<String> url = FieldOrValue.withValue(content.getHtmlUrl());

  String containerName = content.getOwner().getHtmlUrl().getPath();
  String programmingLanguage = FileExtensions.getLanguageForFile(content.getName());

  // Structured data based on the schema
  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("organization", content.getOwner().getOwnerName());
  structuredData.put("repository", content.getOwner().getName());
  structuredData.put("path", content.getPath());
  structuredData.put("language", programmingLanguage);

  Item item = IndexingItemBuilder.fromConfiguration(resourceName)
      .setTitle(title)
      .setContainerName(containerName)
      .setSourceRepositoryUrl(url)
      .setItemType(IndexingItemBuilder.ItemType.CONTAINER_ITEM)
      .setObjectType("file")
      .setValues(structuredData)
      .setVersion(Longs.toByteArray(System.currentTimeMillis()))
      .setHash(content.getSha())
      .build();

  // Index the file content too
  String mimeType = FileTypeMap.getDefaultFileTypeMap()
      .getContentType(content.getName());
  AbstractInputStreamContent fileContent = new InputStreamContent(
      mimeType, content.read())
      .setLength(content.getSize())
      .setCloseInputStream(true);
  return new RepositoryDoc.Builder()
      .setItem(item)
      .setContent(fileContent, IndexingService.ContentFormat.RAW)
      .setRequestMode(IndexingService.RequestMode.SYNCHRONOUS)
      .build();
}

Następnie wdróż interfejs wyszukiwania.

Poprzedni Następny