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 để truyền dữ liệu trong kho lưu trữ của doanh nghiệp và điền nguồn dữ liệu. Google cung cấp các tuỳ chọn sau để phát triển trình kết nối nội dung:

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

  • API REST hoặc thư viện API cấp thấp. Hãy sử dụng các tuỳ 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 API REST hoặc thư viện. Để tạo trình kết nối nội dung bằng API REST, hãy tham khảo phần Tạo trình kết nối nội dung bằng API REST.

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 tham số cấu hình.
  2. Kéo các phần dữ liệu có thể lập chỉ mục rời rạc được gọi là "items" từ kho lưu trữ nội dung của bên thứ ba.
  3. Kết hợp dữ liệu ACL, siêu dữ liệu và nội dung vào các mục có thể lập chỉ mục.
  4. Lập chỉ mục các mục cho nguồn dữ liệu Cloud Search.
  5. (không bắt buộc) Theo dõi để thay đổi thông báo từ kho lưu trữ nội dung của bên thứ ba. Các thông báo thay đổi được chuyển đổi thành yêu cầu lập chỉ mục để nguồn dữ liệu Cloud Search luôn đồng bộ 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 SDK trình kết nối nội dung

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

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

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

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 của bạn

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 thông số được định nghĩa là cặp khóa-giá trị, chẳng hạn như api.sourceId=1234567890abcdef.

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

  • Đối với 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 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 nhận dạng 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ã nhận dạng duy nhất cho tài khoản Google Workspace của doanh nghiệp bạn.

Trừ khi muốn ghi đè các giá trị mặc định của các tham số do Google cung cấp khác, bạn không cần khai báo các giá trị này trong tệp cấu hình. Để biết thêm thông tin về các tham số cấu hình do Google cung cấp, chẳng hạn như cách tạo một số mã và khoá nhất định, hãy tham khảo Các tham 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 vào trình kết nối

Đặt thuộc tính hệ thống config để chuyển tệp cấu hình đến trình kết nối của bạn. 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 khởi động trình kết nối với tệp cấu hình MyConfig.properties:

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

Nếu đối số này bị thiếu, 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 truyền tải của bạn

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

Chiến lược truyền tải đầy đủ

Chiến lược truyền tải đầy đủ 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 dùng khi bạn có kho lưu trữ nhỏ và có thể chi trả toàn bộ chi phí cho hoạt động truyền tải đầy đủ mỗi khi bạn lập chỉ mục.

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

Chiến lược truyền tải danh sách

Chiến lược truyền tải danh sách sẽ quét toàn bộ kho lưu trữ, bao gồm 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ẽ chuyển lần thứ hai và chỉ lập chỉ mục các mục mới hoặc đã được cập nhật kể từ lần lập chỉ mục cuối cùng. Chiến lược này thường được dùng để thực hiện cập nhật gia tăng cho chỉ mục hiện có (thay vì phải truyền tải đầy đủ mỗi khi bạn cập nhật chỉ mục).

Chiến lược truyền tải này phù hợp khi kho lưu trữ thay đổi khó khăn hoặc không được hỗ trợ, bạn có dữ liệu không 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 biểu đồ

Chiến lược truyền tải biểu đồ quét toàn bộ nút mẹ để xác định trạng thái của từng mục. Sau đó, trình kết nối chuyển lầ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 cuối cùng. Cuối cùng, trình kết nối chuyển bất kỳ mã con nào, sau đó lập chỉ mục các mục trong các nút con mới hoặc đã được cập nhật. Trình kết nối tiếp tục đệ quy qua tất cả các nút con cho đến khi tất cả các mục đã được giải quyết. Phương thức truyền tải nà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 dữ liệu, chẳng hạn như một loạt thư mục hoặc trang web.

Mỗi chiến lược truyền tải này do một lớp trình kết nối mẫu trong SDK triển khai. Mặc dù bạn có thể triển khai chiến lược truyền tải của riêng mình, nhưng các mẫu này giúp đẩy nhanh tốc độ phát triển trình kết nối. Để tạo trình kết nối bằng mẫu, hãy chuyển sang phần tương ứng với chiến lược truyền tải của bạn:

Tạo trình kết nối truyền tải đầy đủ bằng cách sử dụng một 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 đến 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 bản sao 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 sử dụng lớp IndexingApplication.Builder để tạo bản sao mẫu FullTraversalConnector. FullTraversalConnector chấp nhận một đối tượng Repository có các phương thức mà bạn triển khai. Đoạn mã sau đây cho biết 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();
}

Đằng sau đó, 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 tạo.
  2. Khởi động 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ị sẽ đượ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 truyền tải 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 trong giao diện Repository để tạo trình kết nối nội dung. Các phương thức bạn ghi đè phụ thuộc vào mẫu và chiến lược truyền tải. Đố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(). Để truyền 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 truyền tải theo lịch (như được xác định theo 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 truyền tải tăng dần theo lịch (như được xác định theo cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục 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 khi tắt trình kết nối.

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

Nhận thông số cấu hình tùy chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn cần lấy mọi thông số tuỳ chỉnh từ đối tượng Configuration. Tác 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 nhiều loại dữ liệu từ một cấu hình. Mỗi phương thức sẽ 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 của FullTraversalSample cho thấy cách truy xuất một giá trị số nguyên tuỳ chỉnh 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();
}

Để nhận và phân tích cú pháp một tham 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 phân đoạn riêng biệt. Đoạn mã sau đây từ trình kết nối hướng dẫn sử dụng phương thức getMultiValue để lấy danh sách kho lưu trữ GitHub:

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

Thực hiện truyền tải đầy đủ

Ghi đè getAllDocs() để truyền tải đầy đủ 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 quá trình này 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. Đặt 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 biến lặp bằng phương thức getAllDocs(). Lưu ý rằng getAllDocs() thực sự trả về một CheckpointCloseableIterable, tức là lặp lại 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ư lập chỉ mục.

Nếu một tập hợp các mục quá lớn để xử lý trong một lệnh gọi, hãy bao gồm một điểm kiểm tra và tập hợp hasMore(true) để cho biết có thêm các mục có sẵ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ữ 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ể xem mục đó trong kết quả tìm kiếm. Bạn phải bao gồm ACL của một mục khi lập chỉ mục một mục để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp truy cập chính xác vào mục đó.

SDK trình kết nối nội dung cung cấp một tập hợp phong phú các lớp ACL và phương thức để lập mô hình ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL của mỗi mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi bạn 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, việc lập mô hình ACL đó có thể phức tạp. Để biết thêm thông tin về Google Cloud Search ACL, hãy tham khảo Google Cloud Search ACL.

Lưu ý: API lập chỉ mục Cloud Search hỗ trợ các ACL miền đơn. Không hỗ trợ ACL giữa nhiều miền. Sử 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, được lấy từ mẫu truyền tải đầy đủ, cho phép tất cả người dùng hoặc "hiệu trưởng" (getCustomerPrincipal()) trở thành "người đọc" của tất cả các mục (.setReaders()) khi thực hiện 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 được ACL để lập mô hình ACL đúng cách cho kho lưu trữ. Ví dụ: bạn có thể 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, nhờ đó, các thư mục con kế thừa quyền từ thư mục mẹ. Việc kế thừa tính kế thừa ACL yêu cầu thêm thông tin trong 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ục, ACL, URL và phiên bản của mục đó. Đoạn mã sau đây cho biết cách tạo Item bằng lớp trình 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 này, 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 trình bày cách tạo một mục 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 thời gian chờ lập chỉ mục để phân phát lâu hơn, đồng thời dung lượng định mức 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 (chèn lấp) toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp thời gian từ khi lập chỉ mục đến khi phân phát video ngắn hơn, nên cũng đạt đến hạn mức công suất giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các bản cập nhật và thay đổi đối với kho lưu trữ. Nếu không xác đị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 biến lặp

Phương thức getAllDocs() sẽ 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 đối tượng biến lặp. Đoạn mã sau đây cho biết cách tạo và trả về một biến lặp.

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

SDK thực thi từng lệnh gọi lập chỉ mục có trong biến lặp.

Các bước tiếp theo

Dưới đây là một vài 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à giá trị băm không bắt buộc cho mỗi mục trong kho lưu trữ. Trình kết nối truyền tải danh sách sẽ đẩy mã mục vào Hàng đợi lập chỉ mục trong Google Cloud Search và truy xuất từng mã một để lập chỉ mục. Google Cloud Search duy trì các hàng đợi và so sánh các nội dung trong hàng đợi để xác định trạng thái mục, chẳng hạn như 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 Cloud Search, hãy tham khảo Hàng đợi lập chỉ mục 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 đến 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 bản sao 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 sử dụng lớp IndexingApplication.Builder để tạo bản sao mẫu ListingConnector. ListingConnector chấp nhận đối tượng Repository có các phương thức bạn triển khai. Đoạn mã sau đây cho biết cách tạo thực thể cho ListingConnector và Repository liên kết với thuộc tính đó:

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

Đằng sau đó, 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 tạo.
  2. Khởi động 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ị sẽ đượ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 truyền tải 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 trình kết nối nội dung. Các phương pháp ghi đè phụ thuộc vào mẫu và chiến lược truyền tải 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ị hàm băm cho tất cả bản ghi trong kho lưu trữ, hãy ghi đè phương thức getIds().

  • Phương thức getDoc(). Để thêm mới, 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 truyền tải tăng dần theo lịch (như được xác định theo cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục 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 khi tắt trình kết nối.

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

Nhận thông số cấu hình tùy chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn cần lấy mọi thông số tuỳ chỉnh từ đối tượng Configuration. Tác 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 nhiều loại dữ liệu từ một cấu hình. Mỗi phương thức sẽ 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 của FullTraversalSample cho thấy cách truy xuất một giá trị số nguyên tuỳ chỉnh 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();
}

Để nhận và phân tích cú pháp một tham 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 phân đoạn riêng biệt. Đoạn mã sau đây từ trình kết nối hướng dẫn sử dụng phương thức getMultiValue để lấy danh sách kho lưu trữ GitHub:

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

Thực hiện truyền tải 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ả 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 sử dụng để tiếp tục lập chỉ mục tại một mục cụ thể nếu quá trình này 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 Cloud Search.

Đẩy ID mục và giá trị băm

Ghi đè getIds() để tìm nạp mã mặt hàng và giá trị băm nội dung liên quan từ kho lưu trữ. Sau đó, các cặp giá trị mã nhận dạng và giá trị băm sẽ được đóng gói thành yêu cầu hoạt động đẩy để đưa vào Hàng đợi lập chỉ mục Cloud Search. Trước tiên, mã nhận dạng gốc hoặc mã gốc sẽ được đẩy trước, sau đó đến mã nhận dạng con cho đến khi toàn bộ hệ thống phân cấp 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ần được lập chỉ mục. Bạn có thể sử 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 quá trình này 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():

  • Nhận từng mã mặt hàng và giá trị hàm băm liên kết từ kho lưu trữ.
  • Đóng gói mỗi cặp giá trị mã nhận dạng và giá trị băm thành một PushItems.
  • Kết hợp mỗi PushItems vào một biến lặp bằng phương thức getIds(). Xin lưu ý rằng getIds() thực sự trả về một CheckpointCloseableIterable là vòng lặp 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ục và giá trị hàm băm rồi chèn vào PushItems. PushItems là yêu cầu ApiOperation để đẩy một mục vào Hàng đợi lập chỉ mục trong 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 thành một lần đẩy ApiOperation.

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

Các mục được đẩy đến Hàng đợi lập chỉ mục 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 Cloud Search. Một mục có thể là mới, đã 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 mục đã sửa đổi. Xoá các mục khỏi chỉ mục không còn tồn tại trong kho lưu trữ nguồn.

Phương thức getDoc() chấp nhận một Mục trong Hàng đợi lập chỉ mục trong 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ã của mục có nằm trong Hàng đợi lập chỉ mục Cloud Search trong kho lưu trữ hay không. Nếu không, hãy xoá mục đó khỏi chỉ mục.

  2. Thăm dò chỉ mục về trạng thái mục và nếu có thay đổi (ACCEPTED) thì không nên làm gì cả.

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

    1. Đặt 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ợ trả về null trên phương thức getDoc(). Trả về kết quả null trong một NullPointerException.

Xử lý các mục đã xóa

Đoạn mã sau đây cho biết 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);
}

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 mục trong Hàng đợi lập chỉ mục 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 này cũng như siêu dữ liệu khác có thể cho biết sự thay đổi. Trong ví dụ, 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ữ 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ể xem mục đó trong kết quả tìm kiếm. Bạn phải bao gồm ACL của một mục khi lập chỉ mục một mục để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp truy cập chính xác vào mục đó.

SDK trình kết nối nội dung cung cấp một tập hợp phong phú các lớp ACL và phương thức để lập mô hình ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL của mỗi mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi bạn 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, việc lập mô hình ACL đó có thể phức tạp. Để biết thêm thông tin về Google Cloud Search ACL, hãy tham khảo Google Cloud Search ACL.

Lưu ý: API lập chỉ mục Cloud Search hỗ trợ các ACL miền đơn. Không hỗ trợ ACL giữa nhiều miền. Sử 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, được lấy từ mẫu truyền tải đầy đủ, cho phép tất cả người dùng hoặc "hiệu trưởng" (getCustomerPrincipal()) trở thành "người đọc" của tất cả các mục (.setReaders()) khi thực hiện 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 được ACL để lập mô hình ACL đúng cách cho kho lưu trữ. Ví dụ: bạn có thể 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, nhờ đó, các thư mục con kế thừa quyền từ thư mục mẹ. Việc kế thừa tính kế thừa ACL yêu cầu thêm thông tin trong 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ục, ACL, URL và phiên bản của mục đó. Đoạn mã sau đây cho biết cách tạo Item bằng lớp trình 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 này, 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 trình bày cách tạo một mục 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 thời gian chờ lập chỉ mục để phân phát lâu hơn, đồng thời dung lượng định mức 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 (chèn lấp) toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp thời gian từ khi lập chỉ mục đến khi phân phát video ngắn hơn, nên cũng đạt đến hạn mức công suất giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các bản cập nhật và thay đổi đối với kho lưu trữ. Nếu không xác định, chế độ yêu cầu sẽ mặc định là SYNCHRONOUS.

Các bước tiếp theo

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

  • (không bắt buộc) Triển khai phương thức close() để giải phóng mọi tài nguyên trước khi tắt.
  • (không bắt buộc) Tạo trình kết nối danh tính bằng SDK trình kết nối nội dung.

Tạo trình kết nối truyền tải biểu đồ sử dụng lớp mẫu

Hàng đợi lập chỉ mục Cloud Search dùng để lưu giữ mã nhận dạng và giá trị hàm băm tuỳ chọn cho mỗi mục trong kho lưu trữ. Trình kết nối truyền tải biểu đồ đẩy mã mục đến Hàng đợi lập chỉ mục trong Google Cloud Search và truy xuất từng mã để 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 mục, chẳng hạn như 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 Cloud Search, hãy tham khảo Hàng đợi lập chỉ mục Google Cloud Search.

Trong chỉ mục, nội dung mục được tìm nạp từ kho lưu trữ dữ liệu và mọi mã mục con được đẩy vào hàng đợi. Trình kết nối tiến hành xử lý đệ quy mã mẹ và mã 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 đến 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 bản sao 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 sử dụng lớp IndexingApplication.Builder để tạo mẫu ListingConnector. ListingConnector chấp nhận một đối tượng Repository có các phương thức mà bạn triển khai.

Đoạn mã sau đây cho biết cách tạo thực thể cho ListingConnector và Repository liên kết với thuộc tính đó:

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

Đằng sau đó, 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 tạo.
  2. Khởi động 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ị sẽ đượ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 truyền tải 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 trong giao diện Repository để tạo trình kết nối nội dung. Các phương thức bạn ghi đè phụ thuộc vào mẫu và chiến lược truyền tải mà bạn sử dụng. Đối với ListingConnector, bạn 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ị hàm băm cho tất cả bản ghi trong kho lưu trữ, hãy ghi đè phương thức getIds().

  • Phương thức getDoc(). Để thêm mới, 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 truyền tải tăng dần theo lịch (như được xác định theo cấu hình của bạn) để truy xuất các mục đã sửa đổi và lập chỉ mục 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 khi tắt trình kết nối.

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

Nhận thông số cấu hình tùy chỉnh

Trong quá trình xử lý cấu hình của trình kết nối, bạn cần lấy mọi thông số tuỳ chỉnh từ đối tượng Configuration. Tác 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 nhiều loại dữ liệu từ một cấu hình. Mỗi phương thức sẽ 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 của FullTraversalSample cho thấy cách truy xuất một giá trị số nguyên tuỳ chỉnh 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();
}

Để nhận và phân tích cú pháp một tham 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 phân đoạn riêng biệt. Đoạn mã sau đây từ trình kết nối hướng dẫn sử dụng phương thức getMultiValue để lấy danh sách kho lưu trữ GitHub:

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

Thực hiện truyền tải biểu đồ

Ghi đè phương thức getIds() để truy xuất mã nhận dạng và giá trị băm cho tất 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 sử dụng để tiếp tục lập chỉ mục tại một mục cụ thể nếu quá trình này 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 Cloud Search.

Đẩy ID mục và giá trị băm

Ghi đè getIds() để tìm nạp mã mặt hàng và giá trị băm nội dung liên quan từ kho lưu trữ. Sau đó, các cặp giá trị mã nhận dạng và giá trị băm sẽ được đóng gói thành yêu cầu hoạt động đẩy để đưa vào Hàng đợi lập chỉ mục Cloud Search. Trước tiên, mã nhận dạng gốc hoặc mã gốc sẽ được đẩy trước, sau đó đến mã nhận dạng con cho đến khi toàn bộ hệ thống phân cấp 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ần được lập chỉ mục. Bạn có thể sử 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 quá trình này 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():

  • Nhận từng mã mặt hàng và giá trị hàm băm liên kết từ kho lưu trữ.
  • Đóng gói mỗi cặp giá trị mã nhận dạng và giá trị băm thành một PushItems.
  • Kết hợp từng PushItems vào một biến lặp bằng phương thức getIds() trả về. Xin lưu ý rằng getIds() thực sự trả về một CheckpointCloseableIterable là vòng lặp 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ục và giá trị hàm băm rồi chèn vào PushItems. PushItems là yêu cầu ApiOperation để đẩy một mục vào Hàng đợi lập chỉ mục 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 thành một lần nhấn ApiOperation duy nhất.

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

Các mục được đẩy đến Hàng đợi lập chỉ mục 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 Cloud Search. Một mục có thể là mới, đã 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 mục đã sửa đổi. Xoá các mục khỏi chỉ mục không còn tồn tại trong kho lưu trữ nguồn.

Phương thức getDoc() chấp nhận một Mục trong Hàng đợi lập chỉ mục 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ã của mục có nằm trong Hàng đợi lập chỉ mục Cloud Search 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ụ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 mục mới:

    1. Đặt 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 con trong Hàng đợi lập chỉ mục Cloud Search để xử lý thêm.
    5. Trả về RepositoryDoc.

Xử lý các mục đã xóa

Đ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à không 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ữ 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ể xem mục đó trong kết quả tìm kiếm. Bạn phải bao gồm ACL của một mục khi lập chỉ mục một mục để Google Cloud Search có thông tin cần thiết nhằm cung cấp cấp truy cập chính xác vào mục đó.

SDK trình kết nối nội dung cung cấp một tập hợp phong phú các lớp ACL và phương thức để lập mô hình ACL của hầu hết các kho lưu trữ. Bạn phải phân tích ACL của mỗi mục trong kho lưu trữ và tạo ACL tương ứng cho Google Cloud Search khi bạn 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, việc lập mô hình ACL đó có thể phức tạp. Để biết thêm thông tin về Google Cloud Search ACL, hãy tham khảo Google Cloud Search ACL.

Lưu ý: API lập chỉ mục Cloud Search hỗ trợ các ACL miền đơn. Không hỗ trợ ACL giữa nhiều miền. Sử 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, được lấy từ mẫu truyền tải đầy đủ, cho phép tất cả người dùng hoặc "hiệu trưởng" (getCustomerPrincipal()) trở thành "người đọc" của tất cả các mục (.setReaders()) khi thực hiện 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 được ACL để lập mô hình ACL đúng cách cho kho lưu trữ. Ví dụ: bạn có thể 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, nhờ đó, các thư mục con kế thừa quyền từ thư mục mẹ. Việc kế thừa tính kế thừa ACL yêu cầu thêm thông tin trong 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ục, ACL, URL và phiên bản của mục đó. Đoạn mã sau đây cho biết cách tạo Item bằng lớp trình 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 này, 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 trình bày cách tạo một mục 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 thời gian chờ lập chỉ mục để phân phát lâu hơn, đồng thời dung lượng định mức 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 (chèn lấp) toàn bộ kho lưu trữ.
SYNCHRONOUS
Chế độ đồng bộ giúp thời gian từ khi lập chỉ mục đến khi phân phát video ngắn hơn, nên cũng đạt đến hạn mức công suất giới hạn. Bạn nên dùng chế độ đồng bộ để lập chỉ mục các bản cập nhật và thay đổi đối với kho lưu trữ. Nếu không xác định, chế độ yêu cầu sẽ mặc định là SYNCHRONOUS.

Đặt mã nhận dạng con trong Hàng đợi lập chỉ mục Cloud Search

Đoạn mã sau đây cho biết cách đưa mã con (đối với mục mẹ đang 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 cha 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

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

  • (không bắt buộc) Triển khai phương thức close() để giải phóng mọi tài nguyên trước khi tắt.
  • (không bắt buộc) Tạo trình kết nối danh tính bằng SDK trình kết nối danh tính.

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

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

Xác định chiến lược truyền tải của bạn

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

Chiến lược truyền tải đầy đủ

Chiến lược truyền tải đầy đủ 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 dùng khi bạn có kho lưu trữ nhỏ và có thể chi trả toàn bộ chi phí cho hoạt động truyền tải đầy đủ mỗi khi bạn lập chỉ mục.

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

Chiến lược truyền tải danh sách

Chiến lược truyền tải danh sách sẽ quét toàn bộ kho lưu trữ, bao gồm 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ẽ chuyển lần thứ hai và chỉ lập chỉ mục các mục mới hoặc đã được cập nhật kể từ lần lập chỉ mục cuối cùng. Chiến lược này thường được dùng để thực hiện cập nhật gia tăng cho chỉ mục hiện có (thay vì phải truyền tải đầy đủ mỗi khi bạn cập nhật chỉ mục).

Chiến lược truyền tải này phù hợp khi kho lưu trữ thay đổi khó khăn hoặc không được hỗ trợ, bạn có dữ liệu không 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 biểu đồ

Chiến lược truyền tải biểu đồ quét toàn bộ nút mẹ để xác định trạng thái của từng mục. Sau đó, trình kết nối chuyển lầ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 cuối cùng. Cuối cùng, trình kết nối chuyển bất kỳ mã con nào, sau đó lập chỉ mục các mục trong các nút con mới hoặc đã được cập nhật. Trình kết nối tiếp tục đệ quy qua tất cả các nút con cho đến khi tất cả các mục đã được giải quyết. Phương thức truyền tải nà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 dữ liệu, chẳng hạn như thư mục chuỗi hoặc trang web.

Triển khai chiến lược truyền tải và mục chỉ mục

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

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

  1. (không bắt buộc) Sử dụng items.upload để tải các tệp lớn hơn 100KiB 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 items.index.

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

  3. Sử dụng items.index để lập chỉ mục mục này. 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 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) Việc sử dụng các lệnh gọi items.get để xác minh một item đã được lập chỉ mục.

Để thực hiện toàn bộ quá trình truyền tải, bạn sẽ lập chỉ mục lại toàn bộ kho lưu trữ. Để thực hiện truyền tải danh sách hoặc biểu đồ, bạn cần triển khai mã để xử lý các thay đổi đối với 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ữ để lập chỉ mục đầy đủ. Mặc dù việc cập nhật chỉ mục rất hiệu quả, nhưng quá trình 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 phân cấp.

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

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