Trang này của hướng dẫn về Cloud Search trình bày cách thiết lập nguồn dữ liệu và trình kết nối nội dung để lập chỉ mục dữ liệu. Để bắt đầu từ đầu hướng dẫn này, hãy tham khảo hướng dẫn bắt đầu sử dụng Cloud Search
Xây dựng trình kết nối
Thay đổi thư mục đang hoạt động của bạn thành thư mục cloud-search-samples/end-to-end/connector
rồi chạy lệnh sau:
mvn package -DskipTests
Lệnh này sẽ tải các phần phụ thuộc bắt buộc xuống để xây dựng trình kết nối nội dung và biên dịch mã.
Tạo thông tin xác thực cho tài khoản dịch vụ
Trình kết nối yêu cầu thông tin xác thực tài khoản dịch vụ để gọi các API Cloud Search. Cách tạo thông tin đăng nhập:
- Quay lại bảng điều khiển Google Cloud.
- Trong bảng điều hướng bên trái, hãy nhấp vào Thông tin xác thực. Trang "Thông tin xác thực" xuất hiện.
- Nhấp vào danh sách thả xuống + TẠO TRUNG TÂM rồi chọn Tài khoản dịch vụ. Trang "Tạo tài khoản dịch vụ" sẽ xuất hiện.
- Trong trường Tên tài khoản dịch vụ, hãy nhập "hướng dẫn".
- Ghi lại giá trị Mã tài khoản dịch vụ (ngay sau tên tài khoản Dịch vụ). Giá trị này sẽ được sử dụng về sau.
- Nhấp vào TẠO. Hộp thoại "Service account permissions (không bắt buộc)" sẽ xuất hiện.
- Nhấp vào TIẾP TỤC. Hộp thoại "Cấp cho người dùng quyền truy cập vào tài khoản dịch vụ này (không bắt buộc)" sẽ xuất hiện.
- Nhấp vào XONG. Màn hình "Thông tin xác thực" xuất hiện.
- Trong phần Tài khoản dịch vụ, hãy nhấp vào email của tài khoản dịch vụ. Trang "Thông tin chi tiết về tài khoản dịch vụ" xuất hiện.
- Trong phần Key (Khoá), hãy nhấp vào danh sách thả xuống ADD KEY (Thêm khoá) rồi chọn Create new key (Tạo khoá mới). Hộp thoại "Tạo khoá riêng tư" xuất hiện.
- Nhấp vào TẠO.
- (không bắt buộc) Nếu hộp thoại "Bạn có muốn cho phép tải xuống trên Console.cloud.google.com không?" xuất hiện, hãy nhấp vào Cho phép.
- Tệp khoá riêng tư sẽ được lưu vào máy tính của bạn. Ghi lại vị trí của tệp đã tải xuống. Tệp này dùng để định cấu hình trình kết nối nội dung, nhờ đó có thể tự xác thực khi gọi các API Google Cloud Search.
Khởi chạy dịch vụ hỗ trợ của bên thứ ba
Để có thể gọi bất kỳ API Cloud Search nào khác, bạn phải khởi chạy dịch vụ hỗ trợ bên thứ ba cho Google Cloud Search.
Để bắt đầu hỗ trợ bên thứ ba cho Cloud Search:
Dự án trên nền tảng Cloud Search của bạn chứa thông tin đăng nhập tài khoản dịch vụ. Tuy nhiên, để khởi chạy dịch vụ hỗ trợ của bên thứ ba, bạn phải tạo thông tin đăng nhập của ứng dụng web. Để biết hướng dẫn về cách tạo thông tin đăng nhập cho ứng dụng web, hãy tham khảo bài viết Tạo thông tin đăng nhập. Sau khi hoàn tất bước này, bạn sẽ có một mã ứng dụng khách và tệp mật khẩu ứng dụng khách.
Sử dụng OAuth 2 Playground của Google để lấy mã truy cập:
- Nhấp vào phần cài đặt rồi chọn Sử dụng thông tin xác thực của chính bạn.
- Nhập mã ứng dụng khách và mật khẩu ứng dụng khách ở bước 1.
- Nhấp vào Close (Đóng).
- Trong trường phạm vi, hãy nhập
https://www.googleapis.com/auth/cloud_search.settings
rồi nhấp vào Authorize (Cho phép). Playground OAuth 2 trả về mã uỷ quyền. - Nhấp vào Mã uỷ quyền trao đổi lấy mã thông báo. Mã thông báo sẽ được trả về.
Để khởi chạy dịch vụ hỗ trợ của bên thứ ba cho Cloud Search, hãy sử dụng lệnh curl sau. Hãy nhớ thay thế
[YOUR_ACCESS_TOKEN]
bằng mã thông báo thu được ở bước 2.curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của
operation
. Ví dụ:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
Nếu không thành công, hãy liên hệ với bộ phận hỗ trợ của Cloud Search.
Sử dụng operations.get để xác minh rằng dịch vụ hỗ trợ bên thứ ba đã được khởi chạy:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
Khi quá trình khởi chạy của bên thứ ba hoàn tất, trường này sẽ chứa trường
done
được đặt thànhtrue
. Ví dụ:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Tạo nguồn dữ liệu
Tiếp theo, hãy tạo nguồn dữ liệu trong bảng điều khiển dành cho quản trị viên. Nguồn dữ liệu cung cấp không gian tên để lập chỉ mục nội dung bằng trình kết nối.
- Mở Bảng điều khiển dành cho quản trị viên của Google.
- Nhấp vào biểu tượng Ứng dụng. Trang "Quản trị ứng dụng" xuất hiện.
- Nhấp vào Google Workspace. Trang "Quản trị Apps Google Workspace" sẽ xuất hiện.
- Di chuyển xuống rồi nhấp vào Cloud Search. Trang "Cài đặt cho Google Workspace" sẽ xuất hiện.
- Nhấp vào Nguồn dữ liệu của bên thứ ba. Trang "Nguồn dữ liệu" sẽ xuất hiện.
- Nhấp vào dấu + hình tròn màu vàng. Hộp thoại "Thêm nguồn dữ liệu mới" sẽ xuất hiện.
- Trong trường Tên hiển thị, hãy nhập "hướng dẫn".
- Trong trường Địa chỉ email của tài khoản dịch vụ, hãy nhập địa chỉ email của tài khoản dịch vụ mà bạn đã tạo ở phần trước. Nếu bạn không biết địa chỉ email của tài khoản dịch vụ, hãy tra cứu giá trị này trên trang tài khoản dịch vụ.
- Nhấp vào THÊM. Hộp thoại "Nguồn dữ liệu được tạo thành công" sẽ xuất hiện.
- Nhấp vào *OK. Hãy lưu ý Mã nguồn cho nguồn dữ liệu mới tạo. Mã nguồn được dùng để định cấu hình trình kết nối nội dung.
Tạo mã truy cập cá nhân cho API GitHub
Trình kết nối yêu cầu quyền truy cập đã xác thực vào API GitHub để có đủ hạn mức. Để đơn giản, trình kết nối sử dụng mã truy cập cá nhân thay vì OAuth. Mã thông báo cá nhân cho phép xác thực với tư cách người dùng với một nhóm quyền hạn chế tương tự như OAuth.
- Đăng nhập vào GitHub.
- Hãy nhấp vào ảnh hồ sơ của bạn ở góc trên bên phải. Một trình đơn thả xuống sẽ xuất hiện.
- Nhấp vào Cài đặt.
- Nhấp vào Chế độ cài đặt dành cho nhà phát triển.
- Nhấp vào Mã truy cập cá nhân.
- Nhấp vào Tạo mã truy cập cá nhân.
- Trong trường Note (Ghi chú), hãy nhập "Cloud Search" (Hướng dẫn về Cloud Search).
- Kiểm tra phạm vi public_repo.
- Nhấp vào Tạo mã thông báo.
- Hãy ghi lại mã thông báo đã tạo. Trình kết nối sử dụng đối tượng này để gọi API GitHub và cung cấp hạn mức API để thực hiện việc lập chỉ mục.
Định cấu hình trình kết nối
Sau khi tạo thông tin xác thực và nguồn dữ liệu, hãy cập nhật cấu hình trình kết nối để bao gồm các giá trị sau:
- Từ dòng lệnh, hãy thay đổi thư mục thành
cloud-search-samples/end-to-end/connector/
. - Mở tệp
sample-config.properties
bằng trình chỉnh sửa văn bản. - Đặt tham số
api.serviceAccountPrivateKeyFile
thành đường dẫn tệp của thông tin xác thực dịch vụ mà bạn đã tải xuống trước đó. - Đặt tham số
api.sourceId
thành mã nhận dạng của nguồn dữ liệu mà bạn đã tạo trước đó. - Đặt tham số
github.user
thành tên người dùng GitHub. - Đặt tham số
github.token
thành mã truy cập mà bạn đã tạo trước đó. - Lưu tệp.
Cập nhật giản đồ
Trình kết nối lập chỉ mục cả nội dung có cấu trúc và không có cấu trúc. Trước khi lập chỉ mục dữ liệu, bạn phải cập nhật giản đồ cho nguồn dữ liệu. Chạy lệnh sau đây để cập nhật giản đồ:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Chạy trình kết nối
Để chạy trình kết nối và bắt đầu lập chỉ mục, hãy chạy lệnh:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Cấu hình mặc định của trình kết nối là lập chỉ mục một kho lưu trữ duy nhất trong tổ chức googleworkspace
. Lập chỉ mục kho lưu trữ mất khoảng 1 phút.
Sau lần lập chỉ mục ban đầu, trình kết nối tiếp tục thăm dò ý kiến để tìm những thay đổi đối với kho lưu trữ cần được phản ánh trong chỉ mục của Cloud Search.
Xem xét mã
Các phần còn lại tìm hiểu cách xây dựng trình kết nối.
Khởi động ứng dụng
Điểm truy cập vào trình kết nối là lớp GithubConnector
. Phương thức main
sẽ tạo thực thể cho IndexingApplication
của SDK và khởi động phương thức đó.
ListingConnector
do SDK cung cấp triển khai một chiến lược truyền tải, trong đó tận dụng hàng đợi Cloud Search để theo dõi trạng thái của các mục trong chỉ mục. Lớp này uỷ quyền cho GithubRepository
, do trình kết nối mẫu triển khai, để truy cập vào nội dung từ GitHub.
Truyền tải kho lưu trữ GitHub
Trong quá trình truyền tải đầy đủ, phương thức getIds()
được gọi để đẩy các mục có thể cần được lập chỉ mục vào hàng đợi.
Trình kết nối có thể lập chỉ mục nhiều kho lưu trữ hoặc tổ chức. Để giảm thiểu tác động của lỗi, mỗi lần một kho lưu trữ GitHub sẽ được truyền tải. Một điểm kiểm tra sẽ được trả về cùng với kết quả của quá trình truyền tải chứa danh sách các kho lưu trữ cần được lập chỉ mục trong các lệnh gọi tiếp theo đến getIds()
. Nếu xảy ra lỗi, hoạt động lập chỉ mục sẽ tiếp tục tại kho lưu trữ hiện tại thay vì bắt đầu từ đầu.
Phương thức collectRepositoryItems()
xử lý việc truyền tải một kho lưu trữ GitHub. Phương thức này trả về một tập hợp ApiOperations
đại diện cho các mục cần được đẩy vào hàng đợi. Các mục được đẩy dưới dạng tên tài nguyên và giá trị băm đại diện cho trạng thái hiện tại của mục.
Giá trị băm được dùng trong các lần truyền tải tiếp theo của kho lưu trữ GitHub. Giá trị này cung cấp một quy trình kiểm tra đơn giản để xác định xem nội dung đã thay đổi mà không cần tải thêm nội dung lên hay chưa. Trình kết nối sẽ đưa tất cả các mục vào hàng đợi. Nếu mục là mới hoặc giá trị hàm băm đã thay đổi, mục đó sẽ có sẵn để thăm dò trong hàng đợi. Nếu không, mặt hàng sẽ được coi là chưa sửa đổi.
Đang xử lý danh sách chờ
Sau khi hoàn tất toàn bộ quá trình truyền tải, trình kết nối bắt đầu thăm dò trong hàng đợi các mục cần được lập chỉ mục. Phương thức getDoc()
được gọi cho mỗi mục được lấy từ hàng đợi. Phương thức này sẽ đọc mục từ GitHub và chuyển đổi mục đó thành cách biểu diễn thích hợp để lập chỉ mục.
Vì trình kết nối đang chạy dựa trên dữ liệu trực tiếp có thể thay đổi bất cứ lúc nào, nên getDoc()
cũng xác minh rằng mục trong hàng đợi vẫn hợp lệ và xoá mọi mục khỏi chỉ mục không còn tồn tại.
Đối với mỗi đối tượng GitHub mà trình kết nối lập chỉ mục, phương thức indexItem()
tương ứng sẽ xử lý việc tạo bản trình bày mục cho Cloud Search. Ví dụ: để tạo bản trình bày cho các mục nội dung:
Tiếp theo, hãy triển khai giao diện tìm kiếm.