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

Trình kết nối nội dung là một chương trình phần mềm dùng để duyệt qua dữ liệu trong kho lưu trữ của doanh nghiệp và điền sẵn một nguồn dữ liệu. Google cung cấp các lựa chọn sau đây để phát triển trình kết nối nội dung:

  • Content Connector SDK. Đây là một lựa chọn phù hợp nếu bạn đang lập trình bằng Java. Content Connector SDK là một trình bao bọc xung quanh REST API, cho phép bạn nhanh chóng tạo các trình kết nối. Để tạo một trình kết nối nội dung bằng SDK, hãy tham khảo bài viết Tạo trình kết nối nội dung bằng Content Connector SDK.

  • Một REST API hoặc thư viện API cấp thấp. Hãy sử dụng các lựa chọn này nếu bạn không lập trình bằng Java hoặc nếu cơ sở mã của bạn phù hợp hơn với một REST API hoặc một thư viện. Để tạo một trình kết nối nội dung bằng REST API, hãy tham khảo bài viết Tạo một trình kết nối nội dung bằng REST API.

Một trình kết nối nội dung thông thường sẽ thực hiện các tác vụ sau:

  1. Đọc và xử lý các thông số cấu hình.
  2. Lấy các khối dữ liệu rời rạc có thể lập chỉ mục (gọi là "mục") từ kho lưu trữ nội dung của bên thứ ba.
  3. Kết hợp ACL, siêu dữ liệu và dữ liệu nội dung thành các mục có thể lập chỉ mục.
  4. Lập chỉ mục các mục vào nguồn dữ liệu Cloud Search.
  5. (không bắt buộc) Lắng nghe thông báo thay đổi từ kho lưu trữ nội dung của bên thứ ba. Thông báo thay đổi được chuyển đổi thành yêu cầu lập chỉ mục để giữ cho nguồn dữ liệu Cloud Search đồng bộ hoá với kho lưu trữ của bên thứ ba. Trình kết nối chỉ thực hiện tác vụ này nếu kho lưu trữ hỗ trợ tính năng phát hiện thay đổi.

Tạo trình kết nối nội dung bằng Content Connector SDK

Các phần sau đây giải thích cách tạo một trình kết nối nội dung bằng Content Connector SDK.

Thiết lập phần phụ thuộc

Bạn phải thêm một số phần phụ thuộc vào tệp bản dựng để sử dụng SDK. Nhấp vào một thẻ bên dưới để xem các phần phụ thuộc cho môi trường tạo bản dựng:

Maven

<dependency>
<groupId>com.google.enterprise.cloudsearch</groupId>
<artifactId>google-cloudsearch-indexing-connector-sdk</artifactId>
<version>v1-0.0.3</version>
</dependency>

Gradle

compile group: 'com.google.enterprise.cloudsearch',
        name: 'google-cloudsearch-indexing-connector-sdk',
        version: 'v1-0.0.3'

Tạo cấu hình trình kết nối

Mỗi trình kết nối đều có một tệp cấu hình chứa các tham số mà trình kết nối sử dụng, chẳng hạn như mã nhận dạng cho kho lưu trữ của bạn. Các tham số được xác định là các cặp khoá-giá trị, chẳng hạn như api.sourceId=1234567890abcdef.

SDK Google Cloud Search chứa một số thông số cấu hình do Google cung cấp mà tất cả các trình kết nối đều sử dụng. Bạn phải khai báo các thông số sau do Google cung cấp trong tệp cấu hình:

  • Đối với một trình kết nối nội dung, bạn phải khai báo api.sourceId và api.serviceAccountPrivateKeyFile vì các tham số này xác định vị trí của kho lưu trữ và khoá riêng tư cần thiết để truy cập vào kho lưu trữ.
  • Đối với trình kết nối danh tính, bạn phải khai báo api.identitySourceId vì tham số này xác định vị trí của nguồn danh tính bên ngoài. Nếu đang đồng bộ hoá người dùng, bạn cũng phải khai báo api.customerId làm mã nhận dạng duy nhất cho tài khoản Google Workspace của doanh nghiệp.

Trừ phi muốn ghi đè các giá trị mặc định của những tham số khác do Google cung cấp, bạn không cần khai báo các tham số đó trong tệp cấu hình. Để biết thêm thông tin về các thông số cấu hình do Google cung cấp, chẳng hạn như cách tạo một số mã nhận dạng và khoá nhất định, hãy tham khảo bài viết Các thông số cấu hình do Google cung cấp.

Bạn cũng có thể xác định các tham số dành riêng cho kho lưu trữ của riêng mình để sử dụng trong tệp cấu hình.

Truyền tệp cấu hình đến trình kết nối

Đặt thuộc tính hệ thống config để truyền tệp cấu hình đến trình kết nối. Bạn có thể đặt thuộc tính bằng cách sử dụng đối số -D khi khởi động trình kết nối. Ví dụ: lệnh sau đây sẽ khởi động trình kết nối bằng tệp cấu hình MyConfig.properties:

java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector

Nếu thiếu đối số này, SDK sẽ cố gắng truy cập vào một tệp cấu hình mặc định có tên là connector-config.properties.

Xác định chiến lược duyệt qua

Chức năng chính của một trình kết nối nội dung là duyệt qua một kho lưu trữ và lập chỉ mục dữ liệu của kho lưu trữ đó. Bạn phải triển khai một chiến lược duyệt qua dựa trên kích thước và bố cục của dữ liệu trong kho lưu trữ. Bạn có thể tự thiết kế chiến lược hoặc chọn trong số các chiến lược sau được triển khai trong SDK:

Chiến lược duyệt qua toàn bộ

Chiến lược duyệt qua toàn bộ sẽ quét toàn bộ kho lưu trữ và lập chỉ mục mọi mục một cách mù quáng. Chiến lược này thường được sử dụng khi bạn có một kho lưu trữ nhỏ và có thể chịu được chi phí chung của việc thực hiện một lượt truyền tải đầy đủ mỗi khi bạn lập chỉ mục.

Chiến lược duyệt qua này phù hợp với các kho lưu trữ nhỏ có hầu hết dữ liệu tĩnh, không phân cấp. Bạn cũng có thể sử dụng chiến lược duyệt qua này khi kho lưu trữ khó phát hiện thay đổi hoặc không hỗ trợ phát hiện thay đổi.

Chiến lược duyệt qua danh sách

Chiến lược duyệt qua danh sách sẽ quét toàn bộ kho lưu trữ, bao gồm cả tất cả các nút con, xác định trạng thái của từng mục. Sau đó, trình kết nối sẽ thực hiện lần truyền thứ hai và chỉ lập chỉ mục những mục mới hoặc đã được cập nhật kể từ lần lập chỉ mục gần đây nhất. Chiến lược này thường được dùng để thực hiện các bản cập nhật gia tăng cho một chỉ mục hiện có (thay vì phải thực hiện một lần truyền tải đầy đủ mỗi khi bạn cập nhật chỉ mục).

Chiến lược duyệt qua này phù hợp khi khó phát hiện thay đổi hoặc kho lưu trữ không hỗ trợ, bạn có dữ liệu không theo hệ phân cấp và bạn đang làm việc với các tập dữ liệu rất lớn.

Truyền tải qua biểu đồ

Chiến lược duyệt qua biểu đồ sẽ quét toàn bộ nút gốc để xác định trạng thái của từng mục. Sau đó, trình kết nối sẽ thực hiện lần truyền thứ hai và chỉ lập chỉ mục các mục trong nút gốc là mới hoặc đã được cập nhật kể từ lần lập chỉ mục gần đây nhất. Cuối cùng, trình kết nối sẽ truyền mọi mã nhận dạng con, sau đó lập chỉ mục các mục trong những nút con mới hoặc đã được cập nhật. Trình kết nối tiếp tục đệ quy thông qua tất cả các nút con cho đến khi tất cả các mục được giải quyết. Thao tác duyệt qua như vậy thường được dùng cho các kho lưu trữ phân cấp, trong đó việc liệt kê tất cả mã nhận dạng là không thực tế.

Chiến lược này phù hợp nếu bạn có dữ liệu phân cấp cần được thu thập thông tin, chẳng hạn như một loạt thư mục hoặc trang web.

Mỗi chiến lược duyệt qua này được triển khai bằng một lớp trình kết nối mẫu trong SDK. Mặc dù bạn có thể triển khai chiến lược duyệt qua của riêng mình, nhưng những mẫu này sẽ giúp tăng tốc đáng kể quá trình phát triển trình kết nối. Để tạo một trình kết nối bằng mẫu, hãy chuyển đến phần tương ứng với chiến lược duyệt qua của bạn:

Tạo trình kết nối truyền tải đầy đủ bằng lớp mẫu

Phần này của tài liệu đề cập đến các đoạn mã trong ví dụ FullTraversalSample.

Triển khai điểm truy cập của trình kết nối

Điểm truy cập vào một trình kết nối là phương thức main(). Nhiệm vụ chính của phương thức này là tạo một phiên bản của lớp Application và gọi phương thức start() để chạy trình kết nối.

Trước khi gọi application.start(), hãy dùng lớp IndexingApplication.Builder để tạo thực thể cho mẫu FullTraversalConnector. FullTraversalConnector chấp nhận một đối tượng Repository mà bạn triển khai các phương thức. Đoạn mã sau đây cho thấy cách triển khai phương thức main():

FullTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a full
 * traversal connector.
 *
 * @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 SampleRepository();
  IndexingConnector connector = new FullTraversalConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

Ở chế độ nền, SDK sẽ gọi phương thức initConfig() sau khi phương thức main() của trình kết nối gọi Application.build. Phương thức initConfig() thực hiện các tác vụ sau:

  1. Gọi phương thức Configuation.isInitialized() để đảm bảo rằng Configuration chưa được khởi chạy.
  2. Khởi chạy một đối tượng Configuration bằng các cặp khoá-giá trị do Google cung cấp. Mỗi cặp khoá-giá trị được lưu trữ trong một đối tượng ConfigValue trong đối tượng Configuration.

Triển khai giao diện Repository

Mục đích duy nhất của đối tượng Repository là thực hiện việc duyệt qua và lập chỉ mục các mục trong kho lưu trữ. Khi sử dụng một mẫu, bạn chỉ cần ghi đè một số phương thức nhất định trong giao diện Repository để tạo một trình kết nối nội dung. Các phương thức mà bạn ghi đè phụ thuộc vào mẫu và chiến lược duyệt qua mà bạn sử dụng. Đối với FullTraversalConnector, hãy ghi đè các phương thức sau:

  • Phương thức init(). Để thực hiện mọi hoạt động thiết lập và khởi chạy kho lưu trữ dữ liệu, hãy ghi đè phương thức init().

  • Phương thức getAllDocs(). Để duyệt qua và lập chỉ mục tất cả các mục trong kho lưu trữ dữ liệu, hãy ghi đè phương thức getAllDocs(). Phương thức này được gọi một lần cho mỗi lần duyệt qua theo lịch (theo định nghĩa trong cấu hình của bạn).

  • (không bắt buộc) Phương thức getChanges(). Nếu kho lưu trữ của bạn hỗ trợ tính năng phát hiện thay đổi, hãy ghi đè phương thức getChanges(). Phương thức này được gọi một lần cho mỗi lần duyệt qua gia tăng theo lịch (như được xác định bằng cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục cho các mục đó.

  • (không bắt buộc) Phương thức close(). Nếu bạn cần dọn dẹp kho lưu trữ, hãy ghi đè phương thức close(). Phương thức này được gọi một lần trong quá trình tắt trình kết nối.

Mỗi phương thức của đối tượng Repository đều trả về một số loại đối tượng ApiOperation. Đối tượng ApiOperation thực hiện một hành động dưới dạng một hoặc có thể là nhiều lệnh gọi IndexingService.indexItem() để thực hiện việc lập chỉ mục thực tế cho kho lưu trữ của bạn.

Nhận các tham số cấu hình tuỳ chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn sẽ cần lấy mọi tham số tuỳ chỉnh từ đối tượng Configuration. Nhiệm vụ này thường được thực hiện trong phương thức init() của lớp Repository.

Lớp Configuration có một số phương thức để lấy các loại dữ liệu khác nhau từ một cấu hình. Mỗi phương thức trả về một đối tượng ConfigValue. Sau đó, bạn sẽ sử dụng phương thức get() của đối tượng ConfigValue để truy xuất giá trị thực tế. Đoạn mã sau đây, từ FullTraversalSample, cho biết cách truy xuất một giá trị số nguyên tuỳ chỉnh duy nhất từ một đối tượng Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Để lấy và phân tích cú pháp một thông số chứa nhiều giá trị, hãy sử dụng một trong các trình phân tích cú pháp loại của lớp Configuration để phân tích cú pháp dữ liệu thành các khối riêng biệt. Đoạn mã sau đây (trong trình kết nối hướng dẫn) sử dụng phương thức getMultiValue để lấy danh sách tên kho lưu trữ GitHub:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Thực hiện một lượt truyền tải đầy đủ

Ghi đè getAllDocs() để thực hiện một lần duyệt qua toàn bộ và lập chỉ mục kho lưu trữ của bạn. Phương thức getAllDocs() chấp nhận một điểm kiểm tra. Điểm kiểm tra được dùng để tiếp tục lập chỉ mục tại một mục cụ thể nếu quy trình bị gián đoạn. Đối với mỗi mục trong kho lưu trữ, hãy thực hiện các bước sau trong phương thức getAllDocs():

  1. Thiết lập quyền.
  2. Đặt siêu dữ liệu cho mục mà bạn đang lập chỉ mục.
  3. Kết hợp siêu dữ liệu và mục thành một RepositoryDoc có thể lập chỉ mục.
  4. Đóng gói từng mục có thể lập chỉ mục vào một trình lặp do phương thức getAllDocs() trả về. Xin lưu ý rằng getAllDocs() thực sự trả về một CheckpointCloseableIterable. Đây là một lần lặp lại của các đối tượng ApiOperation. Mỗi đối tượng đại diện cho một yêu cầu API được thực hiện trên một RepositoryDoc, chẳng hạn như lập chỉ mục.

Nếu tập hợp các mục quá lớn để xử lý trong một lệnh gọi, hãy thêm một điểm kiểm tra và đặt hasMore(true) để cho biết có nhiều mục hơn để lập chỉ mục.

Đặt quyền cho một mục

Kho lưu trữ của bạn sử dụng Danh sách kiểm soát quyền truy cập (ACL) để xác định những người dùng hoặc nhóm có quyền truy cập vào một mục. ACL là danh sách mã nhận dạng của các nhóm hoặc người dùng có thể truy cập vào mục.

Bạn phải sao chép ACL mà kho lưu trữ của bạn sử dụng để đảm bảo chỉ những người dùng có quyền truy cập vào một mục mới có thể thấy mục đó trong kết quả tìm kiếm. Bạn phải thêm ACL cho một mục khi lập chỉ mục mục đó để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp độ truy cập phù hợp cho mục đó.

Content Connector SDK cung cấp một bộ gồm nhiều lớp và phương thức ACL để mô hình hoá ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL cho từng mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi lập chỉ mục một mục. Nếu ACL của kho lưu trữ sử dụng các khái niệm như kế thừa ACL, thì việc mô hình hoá ACL đó có thể khó khăn. Để biết thêm thông tin về ACL của Google Cloud Search, hãy tham khảo bài viết ACL của Google Cloud Search.

Lưu ý: Cloud Search Indexing API hỗ trợ các ACL một miền. Nó không hỗ trợ ACL trên nhiều miền. Dùng lớp Acl.Builder để đặt quyền truy cập vào từng mục bằng ACL. Đoạn mã sau đây (lấy từ mẫu duyệt qua đầy đủ) cho phép tất cả người dùng hoặc "chủ thể" (getCustomerPrincipal()) là "người đọc" của tất cả các mục (.setReaders()) khi thực hiện một tìm kiếm.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Bạn cần hiểu rõ ACL để mô hình hoá ACL một cách phù hợp cho kho lưu trữ. Ví dụ: bạn có thể đang lập chỉ mục các tệp trong một hệ thống tệp sử dụng một số loại mô hình kế thừa, theo đó các thư mục con sẽ kế thừa quyền từ thư mục mẹ. Việc lập mô hình tính năng kế thừa ACL cần có thêm thông tin được đề cập trong bài viết ACL của Google Cloud Search

Đặt siêu dữ liệu cho một mục

Siêu dữ liệu được lưu trữ trong đối tượng Item. Để tạo một Item, bạn cần tối thiểu một mã nhận dạng chuỗi duy nhất, loại mặt hàng, ACL, URL và phiên bản cho mặt hàng. Đoạn mã sau đây cho thấy cách tạo một Item bằng lớp trợ giúp IndexingItemBuilder.

FullTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Using the SDK item builder class to create the document with appropriate attributes
// (this can be expanded to include metadata fields etc.)
Item item = IndexingItemBuilder.fromConfiguration(Integer.toString(id))
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .build();

Tạo mục có thể lập chỉ mục

Sau khi đặt siêu dữ liệu cho mục, bạn có thể tạo mục có thể lập chỉ mục thực tế bằng cách sử dụng lớp RepositoryDoc.Builder. Ví dụ sau đây cho thấy cách tạo một mục duy nhất có thể lập chỉ mục.

FullTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %d", id);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

// Create the fully formed document
RepositoryDoc doc = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT)
    .build();

RepositoryDoc là một loại ApiOperation thực hiện yêu cầu IndexingService.indexItem() thực tế.

Bạn cũng có thể sử dụng phương thức setRequestMode() của lớp RepositoryDoc.Builder để xác định yêu cầu lập chỉ mục là ASYNCHRONOUS hoặc SYNCHRONOUS:

ASYNCHRONOUS
Chế độ không đồng bộ dẫn đến độ trễ từ lập chỉ mục đến phân phát lâu hơn và đáp ứng hạn mức thông lượng lớn cho các yêu cầu lập chỉ mục. Bạn nên dùng chế độ không đồng bộ để lập chỉ mục ban đầu (quảng cáo thay thế) cho toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp giảm độ trễ từ khi lập chỉ mục đến khi phân phát và đáp ứng hạn mức thông lượng giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các nội dung cập nhật và thay đổi đối với kho lưu trữ. Nếu bạn không chỉ định, chế độ yêu cầu sẽ mặc định là SYNCHRONOUS.

Đóng gói từng mục có thể lập chỉ mục trong một trình lặp

Phương thức getAllDocs() trả về một Iterator, cụ thể là CheckpointCloseableIterable của các đối tượng RepositoryDoc. Bạn có thể sử dụng lớp CheckpointClosableIterableImpl.Builder để tạo và trả về một trình lặp. Đoạn mã sau đây cho biết cách tạo và trả về một trình lặp.

FullTraversalSample.java
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(allDocs).build();

SDK sẽ thực thi từng lệnh gọi lập chỉ mục nằm trong trình lặp.

Các bước tiếp theo

Sau đây là một số bước tiếp theo bạn có thể thực hiện:

Tạo trình kết nối truyền tải danh sách bằng lớp mẫu

Hàng đợi lập chỉ mục Cloud Search được dùng để lưu giữ mã nhận dạng và các giá trị băm không bắt buộc cho từng mục trong kho lưu trữ. Trình kết nối duyệt qua danh sách sẽ đẩy mã nhận dạng mục vào Hàng đợi lập chỉ mục của Google Cloud Search và truy xuất từng mã nhận dạng một để lập chỉ mục. Google Cloud Search duy trì các hàng đợi và so sánh nội dung hàng đợi để xác định trạng thái của mục, chẳng hạn như liệu một mục có bị xoá khỏi kho lưu trữ hay không. Để biết thêm thông tin về Hàng đợi lập chỉ mục của Cloud Search, hãy tham khảo bài viết Hàng đợi lập chỉ mục của Cloud Search.

Phần này của tài liệu đề cập đến các đoạn mã trong ví dụ ListTraversalSample.

Triển khai điểm truy cập của trình kết nối

Điểm truy cập vào một trình kết nối là phương thức main(). Nhiệm vụ chính của phương thức này là tạo một phiên bản của lớp Application và gọi phương thức start() để chạy trình kết nối.

Trước khi gọi application.start(), hãy dùng lớp IndexingApplication.Builder để tạo thực thể cho mẫu ListingConnector. ListingConnector chấp nhận một đối tượng Repository mà bạn triển khai các phương thức. Đoạn mã sau đây cho biết cách khởi tạo ListingConnector và Repository được liên kết:

ListTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a
 * list traversal connector.
 *
 * @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 SampleRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

Ở chế độ nền, SDK sẽ gọi phương thức initConfig() sau khi phương thức main() của trình kết nối gọi Application.build. Phương thức initConfig():

  1. Gọi phương thức Configuation.isInitialized() để đảm bảo rằng Configuration chưa được khởi chạy.
  2. Khởi chạy một đối tượng Configuration bằng các cặp khoá-giá trị do Google cung cấp. Mỗi cặp khoá-giá trị được lưu trữ trong một đối tượng ConfigValue trong đối tượng Configuration.

Triển khai giao diện Repository

Mục đích duy nhất của đối tượng Repository là thực hiện việc duyệt qua và lập chỉ mục các mục trong kho lưu trữ. Khi sử dụng mẫu, bạn chỉ cần ghi đè một số phương thức nhất định trong giao diện Repository để tạo một trình kết nối nội dung. Các phương thức mà bạn ghi đè sẽ phụ thuộc vào mẫu và chiến lược duyệt qua mà bạn sử dụng. Đối với ListingConnector, hãy ghi đè các phương thức sau:

  • Phương thức init(). Để thực hiện mọi hoạt động thiết lập và khởi chạy kho lưu trữ dữ liệu, hãy ghi đè phương thức init().

  • Phương thức getIds(). Để truy xuất mã nhận dạng và giá trị băm cho tất cả các bản ghi trong kho lưu trữ, hãy ghi đè phương thức getIds().

  • Phương thức getDoc(). Để thêm, cập nhật, sửa đổi hoặc xoá các mục khỏi chỉ mục, hãy ghi đè phương thức getDoc().

  • (không bắt buộc) Phương thức getChanges(). Nếu kho lưu trữ của bạn hỗ trợ tính năng phát hiện thay đổi, hãy ghi đè phương thức getChanges(). Phương thức này được gọi một lần cho mỗi lần duyệt qua gia tăng theo lịch (như được xác định bằng cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục cho các mục đó.

  • (không bắt buộc) Phương thức close(). Nếu bạn cần dọn dẹp kho lưu trữ, hãy ghi đè phương thức close(). Phương thức này được gọi một lần trong quá trình tắt trình kết nối.

Mỗi phương thức của đối tượng Repository đều trả về một loại đối tượng ApiOperation. Đối tượng ApiOperation thực hiện một hành động dưới dạng một hoặc có thể là nhiều lệnh gọi IndexingService.indexItem() để thực hiện việc lập chỉ mục thực tế cho kho lưu trữ của bạn.

Nhận các tham số cấu hình tuỳ chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn sẽ cần lấy mọi tham số tuỳ chỉnh từ đối tượng Configuration. Nhiệm vụ này thường được thực hiện trong phương thức init() của lớp Repository.

Lớp Configuration có một số phương thức để lấy các loại dữ liệu khác nhau từ một cấu hình. Mỗi phương thức trả về một đối tượng ConfigValue. Sau đó, bạn sẽ sử dụng phương thức get() của đối tượng ConfigValue để truy xuất giá trị thực tế. Đoạn mã sau đây, từ FullTraversalSample, cho biết cách truy xuất một giá trị số nguyên tuỳ chỉnh duy nhất từ một đối tượng Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Để lấy và phân tích cú pháp một thông số chứa nhiều giá trị, hãy sử dụng một trong các trình phân tích cú pháp loại của lớp Configuration để phân tích cú pháp dữ liệu thành các khối riêng biệt. Đoạn mã sau đây (trong trình kết nối hướng dẫn) sử dụng phương thức getMultiValue để lấy danh sách tên kho lưu trữ GitHub:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Thực hiện việc duyệt qua danh sách

Ghi đè phương thức getIds() để truy xuất mã nhận dạng và giá trị băm cho tất cả các bản ghi trong kho lưu trữ. Phương thức getIds() chấp nhận một điểm kiểm tra. Điểm kiểm tra được dùng để tiếp tục lập chỉ mục tại một mục cụ thể nếu quy trình bị gián đoạn.

Tiếp theo, hãy ghi đè phương thức getDoc() để xử lý từng mục trong Hàng đợi lập chỉ mục của Cloud Search.

Đẩy mã mặt hàng và giá trị băm

Ghi đè getIds() để tìm nạp mã nhận dạng mặt hàng và các giá trị băm nội dung được liên kết của mã nhận dạng đó từ kho lưu trữ. Sau đó, các cặp mã nhận dạng và giá trị băm sẽ được đóng gói vào yêu cầu thao tác đẩy đến Hàng đợi lập chỉ mục của Cloud Search. Mã nhận dạng gốc hoặc mã nhận dạng cấp trên thường được đẩy trước, sau đó là mã nhận dạng cấp dưới cho đến khi toàn bộ hệ phân cấp của các mục được xử lý.

Phương thức getIds() chấp nhận một điểm kiểm tra đại diện cho mục cuối cùng được lập chỉ mục. Bạn có thể dùng điểm kiểm tra để tiếp tục lập chỉ mục tại một mục cụ thể nếu quy trình bị gián đoạn. Đối với mỗi mục trong kho lưu trữ, hãy thực hiện các bước sau trong phương thức getIds():

  • Lấy từng mã mặt hàng và giá trị băm được liên kết từ kho lưu trữ.
  • Đóng gói mỗi cặp giá trị băm và giá trị nhận dạng vào một PushItems.
  • Kết hợp từng PushItems thành một trình lặp do phương thức getIds() trả về. Xin lưu ý rằng getIds() thực sự trả về một CheckpointCloseableIterable. Đây là một lần lặp lại của các đối tượng ApiOperation, mỗi đối tượng đại diện cho một yêu cầu API được thực hiện trên RepositoryDoc, chẳng hạn như đẩy các mục vào hàng đợi.

Đoạn mã sau đây cho biết cách lấy từng mã mặt hàng và giá trị băm rồi chèn chúng vào một PushItems. PushItems là một yêu cầu ApiOperation để đẩy một mục vào Hàng đợi lập chỉ mục của Cloud Search.

ListTraversalSample.java
PushItems.Builder allIds = new PushItems.Builder();
for (Map.Entry<Integer, Long> entry : this.documents.entrySet()) {
  String documentId = Integer.toString(entry.getKey());
  String hash = this.calculateMetadataHash(entry.getKey());
  PushItem item = new PushItem().setMetadataHash(hash);
  log.info("Pushing " + documentId);
  allIds.addPushItem(documentId, item);
}

Đoạn mã sau đây cho biết cách sử dụng lớp PushItems.Builder để đóng gói các mã nhận dạng và giá trị băm vào một lệnh đẩy ApiOperation duy nhất.

ListTraversalSample.java
ApiOperation pushOperation = allIds.build();
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(
      Collections.singletonList(pushOperation))
  .build();
return iterator;

Các mục được chuyển đến Hàng đợi lập chỉ mục của Cloud Search để xử lý thêm.

Truy xuất và xử lý từng mục

Ghi đè getDoc() để xử lý từng mục trong Hàng đợi lập chỉ mục của Cloud Search. Một mục có thể là mới, đã được sửa đổi, không thay đổi hoặc không còn tồn tại trong kho lưu trữ nguồn. Truy xuất và lập chỉ mục từng mục mới hoặc đã sửa đổi. Xoá các mục không còn tồn tại trong kho lưu trữ nguồn khỏi chỉ mục.

Phương thức getDoc() chấp nhận một Mục từ Hàng đợi lập chỉ mục của Google Cloud Search. Đối với mỗi mục trong hàng đợi, hãy thực hiện các bước sau trong phương thức getDoc():

  1. Kiểm tra xem mã nhận dạng của mục, trong Hàng đợi lập chỉ mục Cloud Search, có tồn tại trong kho lưu trữ hay không. Nếu không, hãy xoá mục đó khỏi chỉ mục.

  2. Lấy thông tin về trạng thái của mục từ chỉ mục và nếu một mục không thay đổi (ACCEPTED), thì không làm gì cả.

  3. Chỉ mục đã thay đổi hoặc có mục mới:

    1. Thiết lập các quyền.
    2. Đặt siêu dữ liệu cho mục mà bạn đang lập chỉ mục.
    3. Kết hợp siêu dữ liệu và mục thành một RepositoryDoc có thể lập chỉ mục.
    4. Trả về RepositoryDoc.

Lưu ý: Mẫu ListingConnector không hỗ trợ việc trả về null trên phương thức getDoc(). Trả về null kết quả trong NullPointerException.

Xử lý các mục đã xoá

Đoạn mã sau đây cho thấy cách xác định xem một mục có tồn tại trong kho lưu trữ hay không và nếu không, hãy xoá mục đó.

ListTraversalSample.java
String resourceName = item.getName();
int documentId = Integer.parseInt(resourceName);

if (!documents.containsKey(documentId)) {
  // Document no longer exists -- delete it
  log.info(() -> String.format("Deleting document %s", item.getName()));
  return ApiOperations.deleteItem(resourceName);
}

Xin lưu ý rằng documents là một cấu trúc dữ liệu đại diện cho kho lưu trữ. Nếu không tìm thấy documentID trong documents, hãy trả về APIOperations.deleteItem(resourceName) để xoá mục khỏi chỉ mục.

Xử lý các mục không thay đổi

Đoạn mã sau đây cho biết cách thăm dò trạng thái của mục trong Hàng đợi lập chỉ mục của Cloud Search và xử lý một mục không thay đổi.

ListTraversalSample.java
String currentHash = this.calculateMetadataHash(documentId);
if (this.canSkipIndexing(item, currentHash)) {
  // Document neither modified nor deleted, ack the push
  log.info(() -> String.format("Document %s not modified", item.getName()));
  PushItem pushItem = new PushItem().setType("NOT_MODIFIED");
  return new PushItems.Builder().addPushItem(resourceName, pushItem).build();
}

Để xác định xem mục có bị sửa đổi hay không, hãy kiểm tra trạng thái của mục cũng như siêu dữ liệu khác có thể cho biết sự thay đổi. Trong ví dụ này, hàm băm siêu dữ liệu được dùng để xác định xem mục đã được thay đổi hay chưa.

ListTraversalSample.java
/**
 * Checks to see if an item is already up to date
 *
 * @param previousItem Polled item
 * @param currentHash  Metadata hash of the current github object
 * @return PushItem operation
 */
private boolean canSkipIndexing(Item previousItem, String currentHash) {
  if (previousItem.getStatus() == null || previousItem.getMetadata() == null) {
    return false;
  }
  String status = previousItem.getStatus().getCode();
  String previousHash = previousItem.getMetadata().getHash();
  return "ACCEPTED".equals(status)
      && previousHash != null
      && previousHash.equals(currentHash);
}

Đặt quyền cho một mục

Kho lưu trữ của bạn sử dụng Danh sách kiểm soát quyền truy cập (ACL) để xác định những người dùng hoặc nhóm có quyền truy cập vào một mục. ACL là danh sách mã nhận dạng của các nhóm hoặc người dùng có thể truy cập vào mục.

Bạn phải sao chép ACL mà kho lưu trữ của bạn sử dụng để đảm bảo chỉ những người dùng có quyền truy cập vào một mục mới có thể thấy mục đó trong kết quả tìm kiếm. Bạn phải thêm ACL cho một mục khi lập chỉ mục mục đó để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp độ truy cập phù hợp cho mục đó.

Content Connector SDK cung cấp một bộ gồm nhiều lớp và phương thức ACL để mô hình hoá ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL cho từng mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi lập chỉ mục một mục. Nếu ACL của kho lưu trữ sử dụng các khái niệm như kế thừa ACL, thì việc mô hình hoá ACL đó có thể khó khăn. Để biết thêm thông tin về ACL của Google Cloud Search, hãy tham khảo bài viết ACL của Google Cloud Search.

Lưu ý: Cloud Search Indexing API hỗ trợ các ACL một miền. Nó không hỗ trợ ACL trên nhiều miền. Dùng lớp Acl.Builder để đặt quyền truy cập vào từng mục bằng ACL. Đoạn mã sau đây (lấy từ mẫu duyệt qua đầy đủ) cho phép tất cả người dùng hoặc "chủ thể" (getCustomerPrincipal()) là "người đọc" của tất cả các mục (.setReaders()) khi thực hiện một tìm kiếm.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Bạn cần hiểu rõ ACL để mô hình hoá ACL một cách phù hợp cho kho lưu trữ. Ví dụ: bạn có thể đang lập chỉ mục các tệp trong một hệ thống tệp sử dụng một số loại mô hình kế thừa, theo đó các thư mục con sẽ kế thừa quyền từ thư mục mẹ. Việc lập mô hình tính năng kế thừa ACL cần có thêm thông tin được đề cập trong bài viết ACL của Google Cloud Search

Đặt siêu dữ liệu cho một mục

Siêu dữ liệu được lưu trữ trong đối tượng Item. Để tạo một Item, bạn cần tối thiểu một mã nhận dạng chuỗi duy nhất, loại mặt hàng, ACL, URL và phiên bản cho mặt hàng. Đoạn mã sau đây cho thấy cách tạo một Item bằng lớp trợ giúp IndexingItemBuilder.

ListTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Set metadata hash so queue can detect changes
String metadataHash = this.calculateMetadataHash(documentId);

// Using the SDK item builder class to create the document with
// appropriate attributes. This can be expanded to include metadata
// fields etc.
Item item = IndexingItemBuilder.fromConfiguration(Integer.toString(documentId))
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .setHash(metadataHash)
    .build();

Tạo một mục có thể lập chỉ mục

Sau khi đặt siêu dữ liệu cho mục, bạn có thể tạo mục có thể lập chỉ mục thực tế bằng cách sử dụng RepositoryDoc.Builder. Ví dụ sau đây cho thấy cách tạo một mục duy nhất có thể lập chỉ mục.

ListTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %d", documentId);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

// Create the fully formed document
RepositoryDoc doc = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT)
    .build();

RepositoryDoc là một loại ApiOperation thực hiện yêu cầu IndexingService.indexItem() thực tế.

Bạn cũng có thể sử dụng phương thức setRequestMode() của lớp RepositoryDoc.Builder để xác định yêu cầu lập chỉ mục là ASYNCHRONOUS hoặc SYNCHRONOUS:

ASYNCHRONOUS
Chế độ không đồng bộ dẫn đến độ trễ từ lập chỉ mục đến phân phát lâu hơn và đáp ứng hạn mức thông lượng lớn cho các yêu cầu lập chỉ mục. Bạn nên dùng chế độ không đồng bộ để lập chỉ mục ban đầu (quảng cáo thay thế) cho toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp giảm độ trễ từ khi lập chỉ mục đến khi phân phát và đáp ứng hạn mức thông lượng giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các nội dung cập nhật và thay đổi đối với kho lưu trữ. Nếu bạn không chỉ định, chế độ yêu cầu sẽ mặc định là SYNCHRONOUS.

Các bước tiếp theo

Sau đây là một số bước tiếp theo bạn có thể thực hiện:

Tạo trình kết nối truyền tải đồ thị bằng lớp mẫu

Hàng đợi lập chỉ mục của Cloud Search được dùng để lưu giữ mã nhận dạng và các giá trị băm không bắt buộc cho từng mục trong kho lưu trữ. Trình kết nối truyền tải đồ thị sẽ đẩy mã nhận dạng mục vào Hàng đợi lập chỉ mục của Google Cloud Search và truy xuất từng mã nhận dạng một để lập chỉ mục. Google Cloud Search duy trì các hàng đợi và so sánh nội dung hàng đợi để xác định trạng thái của mục, chẳng hạn như liệu một mục đã bị xoá khỏi kho lưu trữ hay chưa. Để biết thêm thông tin về Hàng đợi lập chỉ mục của Cloud Search, hãy tham khảo Hàng đợi lập chỉ mục của Google Cloud Search.

Trong quá trình lập chỉ mục, nội dung của mục sẽ được tìm nạp từ kho dữ liệu và mọi mã mục con sẽ được đẩy vào hàng đợi. Trình kết nối sẽ tiếp tục xử lý đệ quy các mã nhận dạng mẹ và con cho đến khi tất cả các mục được xử lý.

Phần này của tài liệu đề cập đến các đoạn mã trong ví dụ GraphTraversalSample.

Triển khai điểm truy cập của trình kết nối

Điểm truy cập vào một trình kết nối là phương thức main(). Nhiệm vụ chính của phương thức này là tạo một phiên bản của lớp Application và gọi phương thức start() để chạy trình kết nối.

Trước khi gọi application.start(), hãy dùng lớp IndexingApplication.Builder để tạo thực thể cho mẫu ListingConnector. ListingConnector chấp nhận một đối tượng Repository mà bạn triển khai các phương thức.

Đoạn mã sau đây cho biết cách khởi tạo ListingConnector và Repository được liên kết:

GraphTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a graph
 * traversal connector.
 *
 * @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 SampleRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

Ở chế độ nền, SDK sẽ gọi phương thức initConfig() sau khi phương thức main() của trình kết nối gọi Application.build. Phương thức initConfig():

  1. Gọi phương thức Configuation.isInitialized() để đảm bảo rằng Configuration chưa được khởi chạy.
  2. Khởi chạy một đối tượng Configuration bằng các cặp khoá-giá trị do Google cung cấp. Mỗi cặp khoá-giá trị được lưu trữ trong một đối tượng ConfigValue trong đối tượng Configuration.

Triển khai giao diện Repository

Mục đích duy nhất của đối tượng Repository là thực hiện việc duyệt qua và lập chỉ mục các mục trong kho lưu trữ. Khi sử dụng một mẫu, bạn chỉ cần ghi đè một số phương thức nhất định trong giao diện Repository để tạo một trình kết nối nội dung. Các phương thức mà bạn ghi đè phụ thuộc vào mẫu và chiến lược duyệt qua mà bạn sử dụng. Đối với ListingConnector, bạn sẽ ghi đè các phương thức sau:

  • Phương thức init(). Để thực hiện mọi hoạt động thiết lập và khởi chạy kho lưu trữ dữ liệu, hãy ghi đè phương thức init().

  • Phương thức getIds(). Để truy xuất mã nhận dạng và giá trị băm cho tất cả các bản ghi trong kho lưu trữ, hãy ghi đè phương thức getIds().

  • Phương thức getDoc(). Để thêm, cập nhật, sửa đổi hoặc xoá các mục khỏi chỉ mục, hãy ghi đè phương thức getDoc().

  • (không bắt buộc) Phương thức getChanges(). Nếu kho lưu trữ của bạn hỗ trợ tính năng phát hiện thay đổi, hãy ghi đè phương thức getChanges(). Phương thức này được gọi một lần cho mỗi lần duyệt qua gia tăng theo lịch (như được xác định bằng cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục cho các mục đó.

  • (không bắt buộc) Phương thức close(). Nếu bạn cần dọn dẹp kho lưu trữ, hãy ghi đè phương thức close(). Phương thức này được gọi một lần trong quá trình tắt trình kết nối.

Mỗi phương thức của đối tượng Repository đều trả về một số loại đối tượng ApiOperation. Một đối tượng ApiOperation thực hiện một hành động dưới dạng một hoặc có thể là nhiều lệnh gọi IndexingService.indexItem() để thực hiện việc lập chỉ mục thực tế cho kho lưu trữ của bạn.

Nhận các tham số cấu hình tuỳ chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn sẽ cần lấy mọi tham số tuỳ chỉnh từ đối tượng Configuration. Nhiệm vụ này thường được thực hiện trong phương thức init() của lớp Repository.

Lớp Configuration có một số phương thức để lấy các loại dữ liệu khác nhau từ một cấu hình. Mỗi phương thức trả về một đối tượng ConfigValue. Sau đó, bạn sẽ sử dụng phương thức get() của đối tượng ConfigValue để truy xuất giá trị thực tế. Đoạn mã sau đây, từ FullTraversalSample, cho biết cách truy xuất một giá trị số nguyên tuỳ chỉnh duy nhất từ một đối tượng Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Để lấy và phân tích cú pháp một thông số chứa nhiều giá trị, hãy sử dụng một trong các trình phân tích cú pháp loại của lớp Configuration để phân tích cú pháp dữ liệu thành các khối riêng biệt. Đoạn mã sau đây (trong trình kết nối hướng dẫn) sử dụng phương thức getMultiValue để lấy danh sách tên kho lưu trữ GitHub:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Thực hiện việc duyệt đồ thị

Ghi đè phương thức getIds() để truy xuất mã nhận dạng và giá trị băm cho tất cả các bản ghi trong kho lưu trữ. Phương thức getIds() chấp nhận một điểm kiểm tra. Điểm kiểm tra được dùng để tiếp tục lập chỉ mục tại một mục cụ thể nếu quy trình bị gián đoạn.

Tiếp theo, hãy ghi đè phương thức getDoc() để xử lý từng mục trong Hàng đợi lập chỉ mục của Cloud Search.

Đẩy mã mặt hàng và giá trị băm

Ghi đè getIds() để tìm nạp mã nhận dạng mặt hàng và các giá trị băm nội dung được liên kết của mã nhận dạng đó từ kho lưu trữ. Sau đó, các cặp mã nhận dạng và giá trị băm sẽ được đóng gói vào yêu cầu thao tác đẩy đến Hàng đợi lập chỉ mục của Cloud Search. Mã nhận dạng gốc hoặc mã nhận dạng cấp trên thường được đẩy trước, sau đó là mã nhận dạng cấp dưới cho đến khi toàn bộ hệ phân cấp của các mục được xử lý.

Phương thức getIds() chấp nhận một điểm kiểm tra đại diện cho mục cuối cùng được lập chỉ mục. Bạn có thể dùng điểm kiểm tra để tiếp tục lập chỉ mục tại một mục cụ thể nếu quy trình bị gián đoạn. Đối với mỗi mục trong kho lưu trữ, hãy thực hiện các bước sau trong phương thức getIds():

  • Lấy từng mã mặt hàng và giá trị băm được liên kết từ kho lưu trữ.
  • Đóng gói mỗi cặp giá trị băm và giá trị nhận dạng vào một PushItems.
  • Kết hợp từng PushItems thành một trình lặp do phương thức getIds() trả về. Xin lưu ý rằng getIds() thực sự trả về một CheckpointCloseableIterable. Đây là một lần lặp lại của các đối tượng ApiOperation, mỗi đối tượng đại diện cho một yêu cầu API được thực hiện trên RepositoryDoc, chẳng hạn như đẩy các mục vào hàng đợi.

Đoạn mã sau đây cho biết cách lấy từng mã nhận dạng mặt hàng và giá trị băm rồi chèn chúng vào một PushItems. PushItems là một yêu cầu ApiOperation để đẩy một mục vào Hàng đợi lập chỉ mục của Cloud Search.

GraphTraversalSample.java
PushItems.Builder allIds = new PushItems.Builder();
PushItem item = new PushItem();
allIds.addPushItem("root", item);

Đoạn mã sau đây cho biết cách sử dụng lớp PushItems.Builder để đóng gói các mã nhận dạng và giá trị băm vào một lệnh đẩy duy nhất ApiOperation.

GraphTraversalSample.java
ApiOperation pushOperation = allIds.build();
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(
      Collections.singletonList(pushOperation))
  .build();

Các mục được chuyển đến Hàng đợi lập chỉ mục của Cloud Search để xử lý thêm.

Truy xuất và xử lý từng mục

Ghi đè getDoc() để xử lý từng mục trong Hàng đợi lập chỉ mục của Cloud Search. Một mục có thể là mới, đã được sửa đổi, không thay đổi hoặc không còn tồn tại trong kho lưu trữ nguồn. Truy xuất và lập chỉ mục từng mục mới hoặc đã sửa đổi. Xoá các mục không còn tồn tại trong kho lưu trữ nguồn khỏi chỉ mục.

Phương thức getDoc() chấp nhận một Mục từ Hàng đợi lập chỉ mục của Cloud Search. Đối với mỗi mục trong hàng đợi, hãy thực hiện các bước sau trong phương thức getDoc():

  1. Kiểm tra xem mã nhận dạng của mục đó, trong Hàng đợi lập chỉ mục của Cloud Search, có tồn tại trong kho lưu trữ hay không. Nếu không, hãy xoá mục đó khỏi chỉ mục. Nếu mặt hàng đó có tồn tại, hãy tiếp tục với bước tiếp theo.

  2. Chỉ mục đã thay đổi hoặc có mục mới:

    1. Thiết lập các quyền.
    2. Đặt siêu dữ liệu cho mục mà bạn đang lập chỉ mục.
    3. Kết hợp siêu dữ liệu và mục thành một RepositoryDoc có thể lập chỉ mục.
    4. Đặt mã nhận dạng của thành phần con vào Hàng đợi lập chỉ mục Cloud Search để xử lý thêm.
    5. Trả về RepositoryDoc.

Xử lý các mục đã xoá

Đoạn mã sau đây cho biết cách xác định xem một mục có tồn tại trong chỉ mục hay không và nếu không, hãy xoá mục đó.

GraphTraversalSample.java
String resourceName = item.getName();
if (documentExists(resourceName)) {
  return buildDocumentAndChildren(resourceName);
}
// Document doesn't exist, delete it
log.info(() -> String.format("Deleting document %s", resourceName));
return ApiOperations.deleteItem(resourceName);

Đặt quyền cho một mục

Kho lưu trữ của bạn sử dụng Danh sách kiểm soát quyền truy cập (ACL) để xác định những người dùng hoặc nhóm có quyền truy cập vào một mục. ACL là danh sách mã nhận dạng của các nhóm hoặc người dùng có thể truy cập vào mục.

Bạn phải sao chép ACL mà kho lưu trữ của bạn sử dụng để đảm bảo chỉ những người dùng có quyền truy cập vào một mục mới có thể thấy mục đó trong kết quả tìm kiếm. Bạn phải thêm ACL cho một mục khi lập chỉ mục mục đó để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp độ truy cập phù hợp cho mục đó.

Content Connector SDK cung cấp một bộ gồm nhiều lớp và phương thức ACL để mô hình hoá ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL cho từng mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi lập chỉ mục một mục. Nếu ACL của kho lưu trữ sử dụng các khái niệm như kế thừa ACL, thì việc mô hình hoá ACL đó có thể khó khăn. Để biết thêm thông tin về ACL của Google Cloud Search, hãy tham khảo bài viết ACL của Google Cloud Search.

Lưu ý: Cloud Search Indexing API hỗ trợ các ACL một miền. Nó không hỗ trợ ACL trên nhiều miền. Dùng lớp Acl.Builder để đặt quyền truy cập vào từng mục bằng ACL. Đoạn mã sau đây (lấy từ mẫu duyệt qua đầy đủ) cho phép tất cả người dùng hoặc "chủ thể" (getCustomerPrincipal()) là "người đọc" của tất cả các mục (.setReaders()) khi thực hiện một tìm kiếm.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Bạn cần hiểu rõ ACL để mô hình hoá ACL một cách phù hợp cho kho lưu trữ. Ví dụ: bạn có thể đang lập chỉ mục các tệp trong một hệ thống tệp sử dụng một số loại mô hình kế thừa, theo đó các thư mục con sẽ kế thừa quyền từ thư mục mẹ. Việc lập mô hình tính năng kế thừa ACL cần có thêm thông tin được đề cập trong bài viết ACL của Google Cloud Search

Đặt siêu dữ liệu cho một mục

Siêu dữ liệu được lưu trữ trong đối tượng Item. Để tạo một Item, bạn cần tối thiểu một mã nhận dạng chuỗi duy nhất, loại mặt hàng, ACL, URL và phiên bản cho mặt hàng. Đoạn mã sau đây cho thấy cách tạo một Item bằng lớp trợ giúp IndexingItemBuilder.

GraphTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Using the SDK item builder class to create the document with
// appropriate attributes. This can be expanded to include metadata
// fields etc.
Item item = IndexingItemBuilder.fromConfiguration(documentId)
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .build();

Tạo mục có thể lập chỉ mục

Sau khi đặt siêu dữ liệu cho mục, bạn có thể tạo mục có thể lập chỉ mục thực tế bằng cách sử dụng RepositoryDoc.Builder. Ví dụ sau đây cho thấy cách tạo một mục duy nhất có thể lập chỉ mục.

GraphTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %s", documentId);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

RepositoryDoc.Builder docBuilder = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT);

RepositoryDoc là một loại ApiOperation thực hiện yêu cầu IndexingService.indexItem() thực tế.

Bạn cũng có thể sử dụng phương thức setRequestMode() của lớp RepositoryDoc.Builder để xác định yêu cầu lập chỉ mục là ASYNCHRONOUS hoặc SYNCHRONOUS:

ASYNCHRONOUS
Chế độ không đồng bộ dẫn đến độ trễ từ lập chỉ mục đến phân phát lâu hơn và đáp ứng hạn mức thông lượng lớn cho các yêu cầu lập chỉ mục. Bạn nên dùng chế độ không đồng bộ để lập chỉ mục ban đầu (quảng cáo thay thế) cho toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp giảm độ trễ từ khi lập chỉ mục đến khi phân phát và đáp ứng hạn mức thông lượng giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các nội dung cập nhật và thay đổi đối với kho lưu trữ. Nếu bạn không chỉ định, chế độ yêu cầu sẽ mặc định là SYNCHRONOUS.

Đặt mã nhận dạng của thành phần con vào Hàng đợi lập chỉ mục Cloud Search

Đoạn mã sau đây cho biết cách đưa mã nhận dạng của các mục con (đối với mục mẹ đang được xử lý) vào hàng đợi để xử lý. Các mã nhận dạng này được xử lý sau khi mục mẹ được lập chỉ mục.

GraphTraversalSample.java
// Queue the child nodes to visit after indexing this document
Set<String> childIds = getChildItemNames(documentId);
for (String id : childIds) {
  log.info(() -> String.format("Pushing child node %s", id));
  PushItem pushItem = new PushItem();
  docBuilder.addChildId(id, pushItem);
}

RepositoryDoc doc = docBuilder.build();

Các bước tiếp theo

Sau đây là một số bước tiếp theo bạn có thể thực hiện:

Tạo trình kết nối nội dung bằng REST API

Các phần sau đây giải thích cách tạo một trình kết nối nội dung bằng REST API.

Xác định chiến lược duyệt qua

Chức năng chính của một trình kết nối nội dung là duyệt qua một kho lưu trữ và lập chỉ mục dữ liệu của kho lưu trữ đó. Bạn phải triển khai một chiến lược duyệt qua dựa trên kích thước và bố cục của dữ liệu trong kho lưu trữ. Sau đây là 3 chiến lược duyệt qua phổ biến:

Chiến lược duyệt qua toàn bộ

Chiến lược duyệt qua toàn bộ sẽ quét toàn bộ kho lưu trữ và lập chỉ mục mọi mục một cách mù quáng. Chiến lược này thường được sử dụng khi bạn có một kho lưu trữ nhỏ và có thể chịu được chi phí chung của việc thực hiện một lượt truyền tải đầy đủ mỗi khi bạn lập chỉ mục.

Chiến lược duyệt qua này phù hợp với các kho lưu trữ nhỏ có hầu hết dữ liệu tĩnh, không phân cấp. Bạn cũng có thể sử dụng chiến lược duyệt qua này khi kho lưu trữ khó phát hiện thay đổi hoặc không hỗ trợ phát hiện thay đổi.

Chiến lược duyệt qua danh sách

Chiến lược duyệt qua danh sách sẽ quét toàn bộ kho lưu trữ, bao gồm cả tất cả các nút con, xác định trạng thái của từng mục. Sau đó, trình kết nối sẽ thực hiện lần truyền thứ hai và chỉ lập chỉ mục những mục mới hoặc đã được cập nhật kể từ lần lập chỉ mục gần đây nhất. Chiến lược này thường được dùng để thực hiện các bản cập nhật gia tăng cho một chỉ mục hiện có (thay vì phải thực hiện một lần truyền tải đầy đủ mỗi khi bạn cập nhật chỉ mục).

Chiến lược duyệt qua này phù hợp khi khó phát hiện thay đổi hoặc kho lưu trữ không hỗ trợ, bạn có dữ liệu không theo hệ phân cấp và bạn đang làm việc với các tập dữ liệu rất lớn.

Truyền tải qua biểu đồ

Chiến lược duyệt qua biểu đồ sẽ quét toàn bộ nút gốc để xác định trạng thái của từng mục. Sau đó, trình kết nối sẽ thực hiện lần truyền thứ hai và chỉ lập chỉ mục các mục trong nút gốc là mới hoặc đã được cập nhật kể từ lần lập chỉ mục gần đây nhất. Cuối cùng, trình kết nối sẽ truyền mọi mã nhận dạng con, sau đó lập chỉ mục các mục trong những nút con mới hoặc đã được cập nhật. Trình kết nối tiếp tục đệ quy thông qua tất cả các nút con cho đến khi tất cả các mục được giải quyết. Thao tác duyệt qua như vậy thường được dùng cho các kho lưu trữ phân cấp, trong đó việc liệt kê tất cả mã nhận dạng là không thực tế.

Chiến lược này phù hợp nếu bạn có dữ liệu phân cấp cần được thu thập thông tin, chẳng hạn như một loạt thư mục hoặc trang web.

Triển khai chiến lược duyệt qua và lập chỉ mục các mục

Mọi phần tử có thể lập chỉ mục cho Cloud Search đều được gọi là mục trong API Cloud Search. Một mục có thể là tệp, thư mục, một dòng trong tệp CSV hoặc một bản ghi cơ sở dữ liệu.

Sau khi đăng ký giản đồ, bạn có thể điền sẵn chỉ mục bằng cách:

  1. (không bắt buộc) Sử dụng items.upload để tải tệp lớn hơn 100 KiB lên để lập chỉ mục. Đối với các tệp nhỏ hơn, hãy nhúng nội dung dưới dạng inlineContent bằng cách sử dụng items.index.

  2. (không bắt buộc) Sử dụng media.upload để tải tệp nghe nhìn lên để lập chỉ mục.

  3. Sử dụng items.index để lập chỉ mục cho mục. Ví dụ: nếu giản đồ của bạn sử dụng định nghĩa đối tượng trong giản đồ phim, thì yêu cầu lập chỉ mục cho một mục duy nhất sẽ có dạng như sau:

    {
  "name": "datasource/<data_source_id>/items/titanic",
  "acl": {
    "readers": [
      {
        "gsuitePrincipal": {
          "gsuiteDomain": true
        }
      }
    ]
  },
  "metadata": {
    "title": "Titanic",
    "viewUrl": "http://www.imdb.com/title/tt2234155/?ref_=nv_sr_1",
    "objectType": "movie"
  },
  "structuredData": {
    "object": {
      "properties": [
        {
          "name": "movieTitle",
          "textValues": {
            "values": [
              "Titanic"
            ]
          }
        },
        {
          "name": "releaseDate",
          "dateValues": {
            "values": [
              {
                "year": 1997,
                "month": 12,
                "day": 19
              }
            ]
          }
        },
        {
          "name": "actorName",
          "textValues": {
            "values": [
              "Leonardo DiCaprio",
              "Kate Winslet",
              "Billy Zane"
            ]
          }
        },
        {
          "name": "genre",
          "enumValues": {
            "values": [
              "Drama",
              "Action"
            ]
          }
        },
        {
          "name": "userRating",
          "integerValues": {
            "values": [
              8
            ]
          }
        },
        {
          "name": "mpaaRating",
          "textValues": {
            "values": [
              "PG-13"
            ]
          }
        },
        {
          "name": "duration",
          "textValues": {
            "values": [
              "3 h 14 min"
            ]
          }
        }
      ]
    }
  },
  "content": {
    "inlineContent": "A seventeen-year-old aristocrat falls in love with a kind but poor artist aboard the luxurious, ill-fated R.M.S. Titanic.",
    "contentFormat": "TEXT"
  },
  "version": "01",
  "itemType": "CONTENT_ITEM"
}

  4. (Không bắt buộc) Sử dụng các lệnh gọi items.get để xác minh rằng một mục đã được lập chỉ mục.

Để thực hiện một lượt truyền tải đầy đủ, bạn sẽ định kỳ lập chỉ mục lại toàn bộ kho lưu trữ. Để thực hiện việc duyệt qua danh sách hoặc biểu đồ, bạn cần triển khai mã để xử lý các thay đổi về kho lưu trữ.

Xử lý các thay đổi về kho lưu trữ

Bạn có thể định kỳ thu thập và lập chỉ mục từng mục trong kho lưu trữ để thực hiện quy trình lập chỉ mục đầy đủ. Mặc dù hiệu quả trong việc đảm bảo chỉ mục của bạn luôn mới nhất, nhưng việc lập chỉ mục đầy đủ có thể tốn kém khi xử lý các kho lưu trữ lớn hơn hoặc có cấu trúc phân cấp.

Thay vì sử dụng các lệnh gọi chỉ mục để lập chỉ mục toàn bộ kho lưu trữ sau một khoảng thời gian, bạn cũng có thể sử dụng Hàng đợi lập chỉ mục của Google Cloud làm cơ chế theo dõi các thay đổi và chỉ lập chỉ mục những mục đã thay đổi. Bạn có thể sử dụng các yêu cầu items.push để đẩy các mục vào hàng đợi để sau này thăm dò và cập nhật. Để biết thêm thông tin về Hàng đợi lập chỉ mục của Google Cloud, hãy tham khảo phần Hàng đợi lập chỉ mục của Google Cloud.

Để biết thêm thông tin về Google Cloud Search API, hãy tham khảo Cloud Search API.