Diese Seite wurde von der Cloud Translation API übersetzt.

Connector bereitstellen

Auf dieser Seite der Cloud Search-Anleitung erfahren Sie, wie Sie eine Datenquelle und einen Inhalts-Connector für die Indexierung von Daten einrichten. Den ersten Teil des Tutorials finden Sie auf dieser Seite.

Connector erstellen

Ändern Sie Ihr Arbeitsverzeichnis in das Verzeichnis cloud-search-samples/end-to-end/connector und führen Sie den folgenden Befehl aus:

mvn package -DskipTests

Der Befehl lädt die erforderlichen Abhängigkeiten herunter, die zum Erstellen des Inhaltsconnectors erforderlich sind, und kompiliert den Code.

Anmeldedaten für ein Dienstkonto erstellen

Der Connector benötigt Dienstkonto-Anmeldedaten, um die Cloud Search APIs aufzurufen. So erstellen Sie die Anmeldedaten:

Kehren Sie zur Google Cloud Console zurück.
Klicken Sie im linken Navigationsmenü auf Anmeldedaten. Die Seite „Anmeldedaten“ wird angezeigt.
Klicken Sie auf die Drop-down-Liste + ANMELDEDATEN ERSTELLEN und wählen Sie Dienstkonto aus. Die Seite „Dienstkonto erstellen“ wird angezeigt.
Geben Sie im Feld Name des Dienstkontos „tutorial“ ein.
Notieren Sie sich die Dienstkonto-ID (direkt nach dem Namen des Dienstkontos). Dieser Wert wird später verwendet.
Klicke auf ERSTELLEN. Das Dialogfeld „Dienstkontoberechtigungen (optional)“ wird angezeigt.
Klicke auf WEITER. Das Dialogfeld „Nutzern Zugriff auf dieses Dienstkonto gewähren (optional)“ wird angezeigt.
Klicke auf FERTIG. Der Bildschirm „Anmeldedaten“ wird angezeigt.
Klicken Sie unter „Dienstkonten“ auf die E-Mail-Adresse des Dienstkontos. Die Seite „Dienstkontodetails“ wird angezeigt.
Klicken Sie unter „Schlüssel“ auf die Drop-down-Liste SCHLÜSSEL HINZUFÜGEN und wählen Sie Neuen Schlüssel erstellen aus. Das Dialogfeld „Privaten Schlüssel erstellen“ wird angezeigt.
Klicke auf ERSTELLEN.
Optional: Wenn das Dialogfeld „Möchten Sie Downloads aufconsole.cloud.google.com zulassen?“ angezeigt wird, klicken Sie auf Zulassen.
Eine Datei mit dem privaten Schlüssel wird auf Ihrem Computer gespeichert. Notieren Sie sich den Speicherort der heruntergeladenen Datei. Mit dieser Datei wird der Inhaltsconnector konfiguriert, damit er sich beim Aufrufen der Google Cloud Search APIs authentifizieren kann.

Support für Drittanbieter initialisieren

Bevor Sie andere Cloud Search APIs aufrufen können, müssen Sie die Unterstützung von Drittanbietern für Google Cloud Search initialisieren.

So initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search:

Ihr Projekt für die Cloud Search Platform enthält Anmeldedaten für ein Dienstkonto. Für die Initialisierung des Supports von Drittanbietern müssen Sie jedoch Anmeldedaten für Webanwendungen erstellen. Eine Anleitung zum Erstellen von Anmeldedaten für Webanwendungen finden Sie unter Anmeldedaten erstellen. Nach Abschluss dieses Schritts sollten Sie eine Client-ID und eine Clientschlüsseldatei haben.
Verwenden Sie den OAuth 2 Playground für Google, um ein Zugriffstoken abzurufen:
1. Klicken Sie auf „Settings“ (Einstellungen) und klicken Sie das Kästchen User your own authcredential (Eigene Authentifizierungsdaten verwenden) an.
2. Geben Sie die Client-ID und den Clientschlüssel aus Schritt 1 ein.
3. Klicken Sie auf Schließen.
4. Geben Sie im Feld „Bereiche“ https://www.googleapis.com/auth/cloud_search.settings ein und klicken Sie auf Autorisieren. Der OAuth 2 Playground gibt einen Autorisierungscode zurück.
5. Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.

Initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search mit dem folgenden curl-Befehl. Ersetzen Sie [YOUR_ACCESS_TOKEN] durch das Token aus Schritt 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

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von operation. Beispiel:

{
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
}

Wenn das nicht funktioniert, wenden Sie sich an den Cloud Search-Support.

Mit operations.get können Sie prüfen, ob die Unterstützung von Drittanbietern initialisiert wurde:

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

Wenn die Initialisierung des Drittanbieters abgeschlossen ist, enthält das Feld done auf true gesetzt. Beispiel:

{
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
done: true
}

Datenquelle erstellen

Erstellen Sie als Nächstes eine Datenquelle in der Admin-Konsole. Die Datenquelle stellt einen Namespace für die Indexierung von Inhalten mithilfe des Connectors bereit.

Öffnen Sie die Admin-Konsole.
Klicken Sie auf das Apps-Symbol. Die Seite „App-Verwaltung“ wird angezeigt.
Klicken Sie auf Google Workspace. Die Seite „Google Workspace-Apps verwalten“ wird angezeigt.
Scrollen Sie nach unten und klicken Sie auf Cloud Search. Die Seite „Einstellungen für Google Workspace“ wird angezeigt.
Klicken Sie auf Datenquellen von Drittanbietern. Die Seite „Datenquellen“ wird angezeigt.
Klicken Sie auf das runde gelbe +. Das Dialogfeld „Neue Datenquelle hinzufügen“ wird angezeigt.
Geben Sie im Feld Anzeigename „tutorial“ ein.
Geben Sie im Feld E-Mail-Adressen des Dienstkontos die E-Mail-Adresse des Dienstkontos ein, das Sie im vorherigen Abschnitt erstellt haben. Wenn Sie die E-Mail-Adresse des Dienstkontos nicht kennen, suchen Sie den Wert auf der Seite Dienstkonten nach.
Klicken Sie auf HINZUFÜGEN. Das Dialogfeld „Datenquelle wurde erstellt“ wird angezeigt.
Klicken Sie auf OK. Notieren Sie sich die Quellen-ID der neu erstellten Datenquelle. Mit der Quellen-ID wird der Inhaltsconnector konfiguriert.

Persönliches Zugriffstoken für die GitHub API generieren

Der Connector benötigt authentifizierten Zugriff auf die GitHub API, um ein ausreichendes Kontingent zu haben. Der Einfachheit halber verwendet der Connector persönliche Zugriffstokens anstelle von OAuth. Persönliche Tokens ermöglichen die Authentifizierung als Nutzer mit einer begrenzten Reihe von Berechtigungen, ähnlich wie bei OAuth.

Melden Sie sich bei GitHub an.
Klicke oben rechts auf dein Profilbild. Ein Dropdown-Menü wird angezeigt.
Klicke auf Einstellungen.
Klicken Sie auf Entwicklereinstellungen.
Klicken Sie auf Persönliche Zugriffstokens.
Klicken Sie auf Generate personal access token (Persönliches Zugriffstoken generieren).
Geben Sie in das Feld Hinweis „Cloud Search-Anleitung“ ein.
Prüfen Sie den Bereich public_repo.
Klicken Sie auf Token generieren.
Notieren Sie sich das generierte Token. Es wird vom Connector verwendet, um die GitHub APIs aufzurufen, und stellt ein API-Kontingent für die Indexierung bereit.

Connector konfigurieren

Nachdem Sie die Anmeldedaten und die Datenquelle erstellt haben, aktualisieren Sie die Connector-Konfiguration mit den folgenden Werten:

Ändern Sie das Verzeichnis über die Befehlszeile in cloud-search-samples/end-to-end/connector/.
Öffnen Sie die Datei sample-config.properties in einem Texteditor.
Legen Sie für den Parameter api.serviceAccountPrivateKeyFile den Dateipfad der Dienstanmeldedaten fest, die Sie zuvor heruntergeladen haben.
Legen Sie für den Parameter api.sourceId die ID der zuvor erstellten Datenquelle fest.
Legen Sie den Parameter github.user auf Ihren GitHub-Nutzernamen fest.
Legen Sie für den Parameter github.token das zuvor erstellte Zugriffstoken fest.
Speichern Sie die Datei.

Schema aktualisieren

Der Connector indexiert sowohl strukturierte als auch unstrukturierte Inhalte. Bevor Sie Daten indexieren können, müssen Sie das Schema für die Datenquelle aktualisieren. Führen Sie den folgenden Befehl aus, um das Schema zu aktualisieren:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
    -Dexec.args="-Dconfig=sample-config.properties"

Connector ausführen

Führen Sie den folgenden Befehl aus, um den Connector auszuführen und mit der Indexierung zu beginnen:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
    -Dexec.args="-Dconfig=sample-config.properties"

In der Standardkonfiguration wird für den Connector ein einzelnes Repository in der Organisation googleworkspace indexiert. Die Indexierung des Repositorys dauert etwa eine Minute. Nach der ersten Indexierung fragt der Connector weiterhin Änderungen am Repository ab, die im Cloud Search-Index berücksichtigt werden müssen.

Code prüfen

In den verbleibenden Abschnitten wird untersucht, wie der Connector aufgebaut ist.

Anwendung starten

Der Einstiegspunkt für den Connector ist die Klasse GithubConnector. Die Methode main instanziiert die IndexingApplication des SDKs und startet sie.

GithubConnector.java

Auf GitHub ansehen

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

Mit dem vom SDK bereitgestellten ListingConnector wird eine Durchlaufstrategie implementiert, bei der Cloud Search-Warteschlangen verwendet werden, um den Status von Elementen im Index nachzuverfolgen. Er delegiert an GithubRepository, der vom Beispiel-Connector implementiert wurde, um auf Inhalte von GitHub zuzugreifen.

GitHub-Repositories durchlaufen

Bei vollständigen Durchläufen wird die Methode getIds() aufgerufen, um zu indexierende Elemente in die Warteschlange zu verschieben.

Der Connector kann mehrere Repositories oder Organisationen indexieren. Um die Auswirkungen eines Fehlers zu minimieren, wird jeweils ein GitHub-Repository durchlaufen. Ein Prüfpunkt wird zurückgegeben, bei dem die Ergebnisse des Durchlaufs die Liste der Repositories enthalten, die in nachfolgenden Aufrufen von getIds() indexiert werden sollen. Wenn ein Fehler auftritt, wird die Indexierung im aktuellen Repository fortgesetzt, anstatt von vorn zu beginnen.

GithubRepository.java

Auf GitHub ansehen

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

Die Methode collectRepositoryItems() steuert den Durchlauf eines einzelnen GitHub-Repositorys. Bei dieser Methode wird eine Sammlung von ApiOperations zurückgegeben, die die Elemente darstellt, die in die Warteschlange verschoben werden sollen. Elemente werden als Ressourcenname und als Hashwert übertragen, der den aktuellen Status des Elements darstellt.

Der Hashwert wird bei nachfolgenden Durchläufen der GitHub-Repositories verwendet. Mit diesem Wert lässt sich einfach prüfen, ob sich der Inhalt geändert hat, ohne dass zusätzliche Inhalte hochgeladen werden müssen. Der Connector stellt alle Elemente blind in die Warteschlange. Wenn das Element neu ist oder sich der Hashwert geändert hat, wird es für das Abfragen in der Warteschlange zur Verfügung gestellt. Andernfalls gilt das Element als unverändert.

GithubRepository.java

Auf GitHub ansehen

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

Warteschlange wird verarbeitet

Nach Abschluss des vollständigen Durchlaufs beginnt der Connector damit, Elemente in der Warteschlange abzufragen, die indexiert werden müssen. Für jedes Element, das aus der Warteschlange genommen wird, wird die Methode getDoc() aufgerufen. Die Methode liest das Element aus GitHub und konvertiert es in die für die Indexierung geeignete Darstellung.

Da der Connector für Livedaten ausgeführt wird, die sich jederzeit ändern können, überprüft getDoc() auch, ob das Element in der Warteschlange noch gültig ist, und löscht alle Elemente aus dem Index, die nicht mehr vorhanden sind.

GithubRepository.java

Auf GitHub ansehen

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

Für jedes vom Connector indexierte GitHub-Objekt wird die Elementdarstellung für Cloud Search von der entsprechenden indexItem()-Methode erstellt. So erstellen Sie beispielsweise die Darstellung für Inhaltselemente:

GithubRepository.java

Auf GitHub ansehen

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

Als Nächstes stellen Sie die Suchoberfläche bereit.

Zurück Weiter