Ta strona została przetłumaczona przez Cloud Translation API.

Wdrażanie oprogramowania sprzęgającego

Na tej stronie samouczka Cloud Search znajdziesz informacje o tym, jak skonfigurować oprogramowanie sprzęgające źródła danych i treści na potrzeby indeksowania danych. Aby zacząć 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 to pobiera zależności wymagane do skompilowania oprogramowania sprzęgającego treści i skompiluje kod.

Utwórz dane logowania do konta usługi

Aby móc wywoływać interfejsy Cloud Search API, oprogramowanie sprzęgające wymaga danych logowania do 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). Ta wartość jest używana 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. Pojawi się strona „Szczegóły konta usługi”.
W sekcji Keys (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 klucza prywatnego zostanie zapisany na Twoim komputerze. Zapisz lokalizację pobranego pliku. Ten plik służy do konfigurowania oprogramowania sprzęgającego zawartości, dzięki czemu może się on uwierzytelniać podczas wywoływania interfejsów Google Cloud Search API.

Inicjowanie pomocy innych firm

Zanim będzie można wywołać inne interfejsy Cloud Search API, musisz zainicjować zewnętrzną obsługę Google Cloud Search.

Aby zainicjować obsługę zewnętrznej usługi Cloud Search:

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 tego kroku będziesz mieć identyfikator klienta i plik z tajnym kluczem klienta.
Aby uzyskać token dostępu, użyj udostępnianego przez Google protokołu OAuth 2:
1. Kliknij Ustawienia i zaznacz Używaj własnych danych uwierzytelniających.
2. Wpisz identyfikator klienta i tajny klucz klienta z kroku 1.
3. Kliknij Zamknij.
4. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj. Środowisko testowe OAuth 2 zwraca kod autoryzacji.
5. Kliknij Exchange authorization code for tokens (Kod autoryzacji wymiany dla tokenów). Zwracany jest token.

Aby zainicjować zewnętrzną obsługę Cloud Search, użyj tego polecenia curl. Zastąp [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 problem nie ustąpi, skontaktuj się z zespołem pomocy Cloud Search.

Użyj pliku operations.get, aby sprawdzić, czy zainicjowano obsługę klienta zewnętrznego:

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 będzie ona zawierać pole done ustawione na 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 zapewnia przestrzeń nazw do indeksowania treści za pomocą oprogramowania sprzęgającego.

Otwórz konsolę administracyjną Google.
Kliknij ikonę Aplikacje. Pojawi się strona „Administracja aplikacjami”.
Kliknij Google Workspace. Pojawi się strona „Administrowanie aplikacjami w 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 przycisk +. Pojawi 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ź wartość na stronie Konta usługi.
Kliknij DODAJ. Pojawi się okno „Utworzone ź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 oprogramowania sprzęgającego treści.

Generowanie osobistego tokena dostępu dla interfejsu GitHub API

Oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu GitHub API, aby mieć wystarczający limit. Dla uproszczenia oprogramowanie sprzęgające wykorzystuje osobiste tokeny dostępu zamiast protokołu OAuth. Tokeny osobiste pozwalają na uwierzytelnianie użytkownika z ograniczonym zestawem uprawnień podobnych do protokołu 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 Uwaga wpisz „Samouczek Cloud Search”.
Sprawdź zakres public_repo.
Kliknij Wygeneruj token.
Zanotuj wygenerowany token. Jest ono używane przez oprogramowanie sprzęgające do wywoływania interfejsów GitHub API i udostępnia limit interfejsów API na potrzeby indeksowania.

Konfigurowanie oprogramowania sprzęgającego

Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację oprogramowania sprzęgającego, aby uwzględniała 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 z pobranymi wcześniej danymi logowania do usługi.
Ustaw parametr api.sourceId na identyfikator utworzonego wcześniej ź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.

Zaktualizuj schemat

Oprogramowanie sprzęgające 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"

Uruchomienie 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 początkowym indeksowaniu oprogramowanie sprzęgające będzie nadal wyszukiwać zmiany w repozytorium, które muszą zostać odzwierciedlone w indeksie Cloud Search.

Sprawdzanie kodu

W pozostałych sekcjach przedstawiamy sposób stworzenia oprogramowania sprzęgającego.

Uruchamianie aplikacji

Punktem wejścia do oprogramowania sprzęgającego jest klasa GithubConnector. Metoda main tworzy instancję IndexingApplication pakietu SDK i go uruchamia.

GithubConnector.java

Wyświetl w GitHubie

/**
 * 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();
}

Komponent ListingConnector udostępniany przez pakiet SDK implementuje strategię przemierzania, która wykorzystuje kolejki Cloud Search do śledzenia stanu elementów w indeksie. Deleguje ją do usługi GithubRepository zaimplementowanej przez przykładowe oprogramowanie sprzęgające, która umożliwia dostęp do treści z GitHuba.

Przemierzanie repozytoriów GitHub

Podczas pełnego przemierzania metoda getIds() jest wywoływana w celu przekazania elementów, które mogą wymagać indeksowania do kolejki.

Oprogramowanie sprzęgające może indeksować wiele repozytoriów lub organizacji. Aby zminimalizować wpływ awarii, przeszukuje się jedno repozytorium GitHub. Wraz z wynikami przemierzania jest zwracany punkt kontrolny zawierający listę repozytoriów do zindeksowania w kolejnych wywołaniach funkcji getIds(). Jeśli wystąpi błąd, indeksowanie zostanie wznowione w bieżącym repozytorium, a nie od początku.

GithubRepository.java

Wyświetl w GitHubie

/**
 * 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 przemierzanie pojedynczego repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations reprezentującą 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 GitHuba. Ta wartość pozwala łatwo sprawdzić, czy treść się zmieniła, bez konieczności przesyłania dodatkowych treści. Łącznik ślepo umieszcza wszystkie elementy w kolejce. Jeśli element jest nowy lub jego wartość skrótu uległa zmianie, jest on dostępny do odpytywania w kolejce. W przeciwnym razie element zostanie uznany za niezmodyfikowany.

GithubRepository.java

Wyświetl w GitHubie

/**
 * 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;
}

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. Metoda odczytuje element z GitHuba i konwertuje go na prawidłową reprezentację na potrzeby indeksowania.

Ponieważ oprogramowanie sprzęgające działa na podstawie bieżących danych, które mogą się zmieniać w dowolnej chwili, getDoc() sprawdza również, czy element w kolejce jest nadal prawidłowy, i usuwa z indeksu wszystkie elementy, które już nie istnieją.

GithubRepository.java

Wyświetl w GitHubie

/**
 * 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));
  }
}

W przypadku każdego obiektu GitHuba indeksowanego przez oprogramowanie sprzęgające odpowiada odpowiednia metoda indexItem(), która obsługuje tworzenie reprezentacji elementów na potrzeby Cloud Search. Aby na przykład utworzyć reprezentację dla elementów treści:

GithubRepository.java

Wyświetl w GitHubie

/**
 * 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.

Wstecz Dalej