Triển khai trình kết nối

Trang này của phần hướng dẫn về Cloud Search cho biết cách thiết lập nguồn dữ liệu và trình kết nối nội dung để lập chỉ mục dữ liệu. Để bắt đầu từ đầu hướng dẫn này, hãy tham khảo Hướng dẫn bắt đầu sử dụng Cloud Search

Xây dựng trình kết nối

Thay đổi thư mục đang hoạt động thành cloud-search-samples/end-to-end/connector thư mục và chạy lệnh này:

mvn package -DskipTests

Lệnh này sẽ tải xuống các phần phụ thuộc bắt buộc cần thiết để tạo trình kết nối nội dung và biên dịch mã.

Tạo thông tin xác thực cho tài khoản dịch vụ

Trình kết nối yêu cầu thông tin đăng nhập tài khoản dịch vụ để gọi Cloud Search API. Cách tạo thông tin xác thực:

1. Quay lại Bảng điều khiển Google Cloud.
2. Trong bảng điều hướng bên trái, hãy nhấp vào Thông tin xác thực. "Thông tin xác thực" trang xuất hiện.
3. Nhấp vào danh sách thả xuống + TẠO TÍN DỤNG rồi chọn Tài khoản dịch vụ. Phần "Tạo tài khoản dịch vụ" trang xuất hiện.
4. Trong trường Tên tài khoản dịch vụ, hãy nhập "hướng dẫn".
5. Hãy lưu ý giá trị Mã tài khoản dịch vụ (ngay sau tên Tài khoản dịch vụ). Giá trị này sẽ được sử dụng sau.
6. Nhấp vào TẠO. "Quyền đối với tài khoản dịch vụ (không bắt buộc)" xuất hiện.
7. Nhấp vào TIẾP TỤC. Thông báo "Cấp cho người dùng quyền truy cập vào tài khoản dịch vụ này (không bắt buộc)" xuất hiện.
8. Nhấp vào XONG. Phần "Thông tin đăng nhập" màn hình xuất hiện.
9. Trong phần Tài khoản dịch vụ, hãy nhấp vào email tài khoản dịch vụ. Chiến lược đặt giá thầu "Dịch vụ thông tin tài khoản" cách chạy trang.
10. Trong phần Khoá, hãy nhấp vào danh sách thả xuống THÊM KHOÁ rồi chọn Tạo khoá mới. Nút "Tạo khoá riêng tư" xuất hiện.
11. Nhấp vào TẠO.
12. (không bắt buộc) Nếu hộp thoại "Bạn có muốn cho phép tải xuống trên console.cloud.google.com?” xuất hiện, nhấp vào Cho phép.
13. Một tệp khoá riêng tư sẽ được lưu vào máy tính của bạn. Ghi chú vị trí của tệp đã tải xuống. Tệp này dùng để định cấu hình trình kết nối nội dung để mã này có thể tự xác thực khi gọi Google Cloud Search API.

Khởi động dịch vụ hỗ trợ của bên thứ ba

Trước khi có thể gọi bất kỳ API Cloud Search nào khác, bạn phải khởi chạy API của bên thứ ba hỗ trợ dành cho Google Cloud Search.

Để bắt đầu hỗ trợ bên thứ ba cho Cloud Search:

1. Dự án nền tảng Cloud Search của bạn có chứa thông tin đăng nhập vào tài khoản dịch vụ. Tuy nhiên, để khởi động dịch vụ hỗ trợ của bên thứ ba, bạn phải tạo trang web thông tin đăng nhập của ứng dụng. Để xem hướng dẫn về cách tạo ứng dụng web thông tin xác thực, tham khảo Tạo thông tin xác thực. Sau khi hoàn tất bước này, bạn sẽ có một ID ứng dụng khách và tệp mật khẩu ứng dụng khách.

2. Sử dụng Sân chơi OAuth 2 của Google để lấy mã truy cập:

   1. Nhấp vào phần cài đặt rồi đánh dấu chọn Người dùng sử dụng thông tin xác thực của riêng bạn.
   2. Nhập mã ứng dụng khách và mật khẩu ứng dụng khách ở bước 1.
   3. Nhấp vào Đóng.
   4. Trong trường phạm vi, hãy nhập https://www.googleapis.com/auth/cloud_search.settings rồi nhấp vào Uỷ quyền. Sân chơi OAuth 2 trả về mã uỷ quyền.
   5. Nhấp vào Mã uỷ quyền Exchange cho mã thông báo. Một mã thông báo sẽ được trả về.

3. Để bắt đầu hỗ trợ bên thứ ba cho Cloud Search, hãy sử dụng curl sau . Hãy nhớ thay thế [YOUR_ACCESS_TOKEN] bằng mã thông báo thu được trong bước 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
   

   Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của operation. Ví dụ:

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

   Nếu không thành công, hãy liên hệ với bộ phận hỗ trợ của Cloud Search.

4. Sử dụng operations.get để xác minh rằng dịch vụ hỗ trợ của bên thứ ba đã được khởi chạy:

   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
   

   Khi quá trình khởi chạy bên thứ ba hoàn tất, quá trình này sẽ chứa trường done được đặt thành true. Ví dụ:

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

Tạo nguồn dữ liệu

Tiếp theo, hãy tạo một nguồn dữ liệu trong bảng điều khiển dành cho quản trị viên. Nguồn dữ liệu cung cấp không gian tên để lập chỉ mục nội dung bằng trình kết nối.

1. Mở Bảng điều khiển dành cho quản trị viên của Google.
2. Nhấp vào biểu tượng Ứng dụng. Trang "Quản trị ứng dụng" trang xuất hiện.
3. Nhấp vào Google Workspace. Trang "Quản trị các ứng dụng trên Google Workspace" trang xuất hiện.
4. Cuộn xuống rồi nhấp vào Cloud Search. Phần "Chế độ cài đặt của Google Workspace" trang sẽ xuất hiện.
5. Nhấp vào Nguồn dữ liệu của bên thứ ba. "Nguồn dữ liệu" trang xuất hiện.
6. Nhấp vào dấu + màu vàng hình tròn. Phần "Thêm nguồn dữ liệu mới" xuất hiện.
7. Trong trường Tên hiển thị, hãy nhập "hướng dẫn".
8. Trong trường Địa chỉ email của tài khoản dịch vụ, hãy nhập địa chỉ email của tài khoản dịch vụ bạn đã tạo ở phần trước. Nếu không biết địa chỉ email của tài khoản dịch vụ, tra cứu giá trị trong thời gian tài khoản dịch vụ .
9. Nhấp vào THÊM. "Nguồn dữ liệu đã tạo thành công" xuất hiện.
10. Nhấp vào *OK. Lưu ý Mã nguồn cho nguồn dữ liệu mới tạo. Chiến lược phát hành đĩa đơn Mã nguồn được dùng để định cấu hình trình kết nối nội dung.

Tạo mã truy cập cá nhân cho API GitHub

Trình kết nối yêu cầu quyền truy cập đã xác thực vào API GitHub để có đủ hạn mức. Để đơn giản, trình kết nối tận dụng thông tin mã truy cập thay vì OAuth. Mã thông báo cá nhân cho phép xác thực với tư cách là một người dùng có một nhóm các quyền hạn chế tương tự như OAuth.

1. Đăng nhập vào GitHub.
2. Ở góc trên bên phải, hãy nhấp vào ảnh hồ sơ của bạn. Trình đơn thả xuống sẽ xuất hiện.
3. Nhấp vào Cài đặt.
4. Nhấp vào Cài đặt dành cho nhà phát triển.
5. Nhấp vào Mã truy cập cá nhân.
6. Nhấp vào Tạo mã truy cập cá nhân.
7. Trong trường Ghi chú, nhập "Hướng dẫn tìm kiếm trên đám mây".
8. Kiểm tra phạm vi public_repo.
9. Nhấp vào Tạo mã thông báo.
10. Ghi lại mã thông báo đã tạo. Trình kết nối sử dụng mã này để gọi GitHub API và cung cấp hạn mức API để thực hiện việc lập chỉ mục.

Định cấu hình trình kết nối

Sau khi tạo thông tin xác thực và nguồn dữ liệu, hãy cập nhật trình kết nối cấu hình để bao gồm các giá trị này:

1. Từ dòng lệnh, hãy thay đổi thư mục thành cloud-search-samples/end-to-end/connector/.
2. Mở tệp sample-config.properties bằng trình chỉnh sửa văn bản.
3. Đặt tham số api.serviceAccountPrivateKeyFile thành đường dẫn tệp của thông tin đăng nhập dịch vụ bạn đã tải xuống trước đó.
4. Đặt tham số api.sourceId thành mã nhận dạng của nguồn dữ liệu mà bạn được tạo trước đó.
5. Đặt tham số github.user thành tên người dùng GitHub của bạn.
6. Đặt tham số github.token thành mã truy cập mà bạn đã tạo trước đó.
7. Lưu tệp.

Cập nhật giản đồ

Trình kết nối lập chỉ mục cả nội dung có cấu trúc và không có cấu trúc. Trước khi lập chỉ mục , bạn phải cập nhật giản đồ cho nguồn dữ liệu đó. Chạy lệnh sau để cập nhật giản đồ:

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

Chạy trình kết nối

Để chạy trình kết nối và bắt đầu lập chỉ mục, hãy chạy lệnh:

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

Cấu hình mặc định của trình kết nối là để lập chỉ mục một kho lưu trữ trong tổ chức googleworkspace. Quá trình lập chỉ mục kho lưu trữ mất khoảng 1 phút. Sau khi lập chỉ mục ban đầu, trình kết nối tiếp tục thăm dò ý kiến về những thay đổi đối với kho lưu trữ cần được phản ánh trong chỉ mục Cloud Search.

Đang xem xét mã

Các phần còn lại kiểm tra cách xây dựng trình kết nối.

Khởi động ứng dụng

Điểm truy cập đến trình kết nối là lớp GithubConnector. Chiến lược phát hành đĩa đơn Phương thức main tạo thực thể cho IndexingApplication của SDK và khởi động nó.

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

ListingConnector do SDK cung cấp và triển khai một chiến lược truyền tải tận dụng hàng đợi Cloud Search để theo dõi trạng thái của các mục trong chỉ mục. Ứng dụng này uỷ quyền cho GithubRepository, được triển khai bằng trình kết nối mẫu để truy cập nội dung từ GitHub.

Truyền tải các kho lưu trữ GitHub

Trong khi truyền tải toàn bộ, getIds() được gọi để đẩy các mục có thể cần được lập chỉ mục vào hàng đợi.

Trình kết nối có thể lập chỉ mục nhiều kho lưu trữ hoặc tổ chức. Để giảm thiểu tác động của một lỗi, một kho lưu trữ GitHub được truyền tải tại một thời điểm. Một điểm kiểm tra được trả về cùng với kết quả truyền tải chứa danh sách kho lưu trữ được lập chỉ mục trong các lệnh gọi tiếp theo tới getIds(). Nếu xảy ra lỗi xảy ra, việc lập chỉ mục sẽ được tiếp tục tại kho lưu trữ hiện tại thay vì bắt đầu ngay từ đầu.

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

Phương thức collectRepositoryItems() xử lý việc truyền tải một Kho lưu trữ GitHub. Phương thức này trả về một tập hợp ApiOperations biểu thị các mục cần đẩy vào hàng đợi. Các mục được đẩy dưới dạng tên tài nguyên và một giá trị băm biểu thị trạng thái hiện tại của mục.

Giá trị băm được sử dụng trong các lần truyền tải tiếp theo trên GitHub kho lưu trữ mới. Giá trị này cung cấp một dấu kiểm nhỏ để xác định xem nội dung đã thay đổi mà không phải tải lên nội dung bổ sung. Trình kết nối một cách mù quáng thêm tất cả các mục vào hàng đợi. Nếu là mục mới hoặc giá trị băm đã thay đổi, thì mục đó sẽ được tạo có sẵn để thăm dò ý kiến trong hàng đợi. Nếu không, mặt hàng đó sẽ được coi là chưa sửa đổi.

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

Đang xử lý hàng đợi

Sau khi quá trình truyền tải đầy đủ hoàn tất, trình kết nối bắt đầu thăm dò hàng đợi các mục cần được lập chỉ mục. getDoc() được gọi cho mỗi mục được lấy từ hàng đợi. Phương thức đọc mục từ GitHub và chuyển đổi mục đó thành cách trình bày phù hợp để lập chỉ mục.

Khi trình kết nối đang chạy dựa trên dữ liệu trực tiếp và có thể thay đổi bất kỳ lúc nào getDoc() cũng xác minh rằng mục trong hàng đợi vẫn hợp lệ và xoá bất kỳ mục nào khỏi chỉ mục không còn tồn tại.

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

Đối với mỗi đối tượng GitHub mà trình kết nối lập chỉ mục, tham số tương ứng Phương thức indexItem() xử lý việc tạo bản trình bày mục cho Cloud Search. Ví dụ: để tạo bản trình bày cho các mục nội dung:

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

Tiếp theo, hãy triển khai giao diện tìm kiếm.

Trước Tiếp theo