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

Trang này trong 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

Tạo trình kết nối

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

mvn package -DskipTests

Lệnh này sẽ tải các phần phụ thuộ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 tài khoản dịch vụ

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

1. Quay lại Google Cloud Console.
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. Trang "Thông tin xác thực" sẽ xuất hiện.
3. Nhấp vào danh sách thả xuống + TẠO THÔNG TIN XÁC THỰC rồi chọn Tài khoản dịch vụ. Trang "Tạo tài khoản dịch vụ" sẽ 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. 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. Hộp thoại "Quyền cho tài khoản dịch vụ (không bắt buộc)" sẽ xuất hiện.
7. Nhấp vào TIẾP TỤC. Hộp thoại "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)" sẽ xuất hiện.
8. Nhấp vào XONG. Màn hình "Thông tin xác thực" sẽ xuất hiện.
9. Trong mục Tài khoản dịch vụ, hãy nhấp vào email của tài khoản dịch vụ. Trang "chi tiết tài khoản dịch vụ" sẽ xuất hiện.
10. Trong phần Khoá, hãy nhấp vào danh sách thả xuống THÊM KHÓA rồi chọn Tạo khoá mới. Hộp thoại "Tạo khoá riêng tư" sẽ xuất hiện.
11. Nhấp vào TẠO.
12. (không bắt buộc) Nếu hộp thoại "Do you want to allow downloads on console.cloud.google.com?" (Bạn có muốn cho phép tải xuống trên console.cloud.google.com không?) xuất hiện, hãy nhấp vào Allow (Cho phép).
13. Tệp khoá riêng tư sẽ được lưu vào máy tính của bạn. Ghi lại 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 để trình kết nối có thể tự xác thực khi gọi các API Google Cloud Search.

Khởi chạy tính năng hỗ trợ 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 dịch vụ hỗ trợ của bên thứ ba cho Google Cloud Search.

Cách khởi chạy tính năng hỗ trợ của bên thứ ba cho Cloud Search:

1. Dự án trên Cloud Search Platform chứa thông tin xác thực của tài khoản dịch vụ. Tuy nhiên, để khởi chạy tính năng hỗ trợ bên thứ ba, bạn phải tạo thông tin xác thực ứng dụng web. Để biết hướng dẫn về cách tạo thông tin xác thực ứng dụng web, hãy tham khảo phần 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 mã ứng dụng khách và tệp khoá bí mật của ứng dụng.

2. Sử dụng OAuth 2 playground của Google để lấy mã truy cập:

   1. Nhấp vào phần cài đặt rồi đánh dấu vào 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 từ bước 1.
   3. Nhấp vào Close (Đó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. OAuth 2 playground sẽ trả về một mã uỷ quyền.
   5. Nhấp vào Đổi mã uỷ quyền lấy mã thông báo. Hệ thống sẽ trả về một mã thông báo.

3. Để khởi chạy tính năng hỗ trợ bên thứ ba cho Cloud Search, hãy sử dụng lệnh curl sau. Hãy nhớ thay thế [YOUR_ACCESS_TOKEN] bằng mã thông báo thu được ở 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 nhóm hỗ trợ Cloud Search.

4. Sử dụng operations.get để xác minh rằng tính năng hỗ trợ 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, nó 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 một 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" sẽ xuất hiện.
3. Nhấp vào Google Workspace. Trang "Quản trị ứng dụng Google Workspace" sẽ xuất hiện.
4. Di chuyển xuống rồi nhấp vào Cloud Search (Tìm kiếm trên đám mây). Trang "Cài đặt cho Google Workspace" sẽ xuất hiện.
5. Nhấp vào Nguồn dữ liệu của bên thứ ba. Trang "Nguồn dữ liệu" sẽ xuất hiện.
6. Nhấp vào biểu tượng + màu vàng tròn. Hộp thoại "Thêm nguồn dữ liệu mới" sẽ 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ụ mà bạn đã tạo ở phần trước. Nếu bạn không biết địa chỉ email của tài khoản dịch vụ, hãy tra cứu giá trị này trong trang tài khoản dịch vụ.
9. Nhấp vào THÊM. Hộp thoại "Đã tạo thành công nguồn dữ liệu" sẽ xuất hiện.
10. Nhấp vào *OK. Ghi lại Mã nguồn của nguồn dữ liệu mới tạo. 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 sẽ tận dụng mã truy cập cá nhân thay vì OAuth. Mã thông báo cá nhân cho phép xác thực dưới dạng người dùng có một bộ 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. Một 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 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ú, hãy nhập "Hướng dẫn về 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. Lưu ý mã thông báo đã tạo. Trình kết nối sử dụng API này để gọi các API GitHub 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 cấu hình của trình kết nối để bao gồm các giá trị sau:

1. Trên 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 xác thực dịch vụ mà 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 đã 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 này 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 dữ liệu, 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 cho trình kết nối là lập chỉ mục một kho lưu trữ duy nhất trong tổ chức googleworkspace. Quá trình lập chỉ mục kho lưu trữ sẽ mất khoảng 1 phút. Sau lần lập chỉ mục ban đầu, trình kết nối sẽ 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.

Xem lại mã

Các phần còn lại sẽ kiểm tra cách tạo trình kết nối.

Khởi động ứng dụng

Điểm truy cập vào trình kết nối là lớp GithubConnector. Phương thức main tạo bản sao IndexingApplication của SDK và khởi động SDK đó.

/**
 * 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 triển khai một chiến lược duyệt qua 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. Phương thức này uỷ quyền cho GithubRepository do trình kết nối mẫu triển khai để truy cập nội dung từ GitHub.

Di chuyển qua các kho lưu trữ GitHub

Trong quá trình duyệt toàn bộ, phương thức getIds() sẽ đượ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ỗi lần chỉ truy cập một kho lưu trữ GitHub. Một điểm kiểm tra sẽ được trả về cùng với kết quả của quá trình duyệt qua chứa danh sách các kho lưu trữ sẽ được lập chỉ mục trong các lệnh gọi tiếp theo đến getIds(). Nếu xảy ra lỗi, quá trình lập chỉ mục sẽ tiếp tục tại kho lưu trữ hiện tại thay vì bắt đầu 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 cập vào một kho lưu trữ GitHub. Phương thức này trả về một tập hợp ApiOperations đại diện cho 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à giá trị băm thể hiện trạng thái hiện tại của mục.

Giá trị băm được dùng trong các lần truy cập tiếp theo vào kho lưu trữ GitHub. Giá trị này cung cấp một quy trình kiểm tra nhẹ để xác định xem nội dung có thay đổi hay không mà không cần tải thêm nội dung. Trình kết nối sẽ đưa tất cả các mục vào hàng đợi một cách ngẫu nhiên. Nếu mục là mới hoặc giá trị băm đã thay đổi, thì mục đó sẽ được cung cấp để thăm dò ý kiến trong hàng đợi. Nếu không, mục đó sẽ được coi là không được 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;
}

Xử lý hàng đợi

Sau khi hoàn tất quá trình duyệt toàn bộ, trình kết nối sẽ bắt đầu thăm dò ý kiến về hàng đợi cho các mục cần được lập chỉ mục. Phương thức getDoc() được gọi cho mỗi mục được lấy từ hàng đợi. Phương thức này đọc mục từ GitHub và chuyển đổi mục đó thành nội dung trình bày thích 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 có thể thay đổi bất cứ 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á mọi mục 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, phương thức indexItem() tương ứng sẽ xử lý việc tạo bản trình bày mục cho Tìm kiếm trên đám mây. 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