Tạo giao diện tìm kiếm bằng tiện ích tìm kiếm

Tiện ích tìm kiếm cung cấp giao diện tìm kiếm có thể tuỳ chỉnh cho các ứng dụng web. Tiện ích này chỉ yêu cầu một lượng nhỏ HTML và JavaScript để triển khai và bật các tính năng tìm kiếm phổ biến như phương diện và phân trang. Bạn cũng có thể tuỳ chỉnh một số phần của giao diện bằng CSS và JavaScript.

Nếu bạn cần linh hoạt hơn so với tiện ích cung cấp, hãy cân nhắc sử dụng Query API. Để biết thông tin về cách tạo giao diện tìm kiếm bằng Query API, hãy tham khảo bài viết Tạo giao diện tìm kiếm bằng Query API.

Xây dựng giao diện tìm kiếm

Bạn cần thực hiện một số bước để tạo giao diện tìm kiếm:

  1. Định cấu hình ứng dụng tìm kiếm
  2. Tạo mã ứng dụng cho ứng dụng
  3. Thêm mã đánh dấu HTML cho hộp tìm kiếm và kết quả
  4. Tải tiện ích trên trang
  5. Khởi chạy tiện ích

Định cấu hình ứng dụng tìm kiếm

Mỗi giao diện tìm kiếm phải có một ứng dụng tìm kiếm được xác định trong bảng điều khiển quản trị. Ứng dụng tìm kiếm cung cấp thêm thông tin cho truy vấn, chẳng hạn như nguồn dữ liệu, phương diện và chế độ cài đặt chất lượng tìm kiếm.

Để tạo ứng dụng tìm kiếm, hãy tham khảo bài viết Tạo trải nghiệm tìm kiếm tuỳ chỉnh.

Tạo mã ứng dụng cho ứng dụng

Ngoài các bước trong phần Định cấu hình quyền truy cập vào API Google Cloud Search, bạn cũng phải tạo mã ứng dụng cho ứng dụng web.

Định cấu hình dự án

Khi bạn định cấu hình dự án:

  • Chọn loại ứng dụng khách Trình duyệt web
  • Cung cấp URI gốc của ứng dụng.
  • Ghi lại mã ứng dụng đã tạo. Bạn sẽ cần mã ứng dụng để hoàn tất các bước tiếp theo. Tiện ích này không bắt buộc phải có khoá ứng dụng.

Để biết thêm thông tin, hãy xem bài viết OAuth 2.0 cho ứng dụng web phía máy khách.

Thêm mã đánh dấu HTML

Tiện ích này cần một lượng nhỏ HTML để hoạt động. Bạn phải cung cấp:

  • Phần tử input cho hộp tìm kiếm.
  • Một phần tử để liên kết cửa sổ bật lên đề xuất.
  • Một phần tử chứa kết quả tìm kiếm.
  • (Không bắt buộc) Cung cấp một phần tử để chứa các thành phần điều khiển khía cạnh.

Đoạn mã HTML sau đây cho thấy HTML cho một tiện ích tìm kiếm, trong đó các phần tử cần liên kết được xác định bằng thuộc tính id:

serving/widget/public/with_css/index.html
<div id="search_bar">
  <div id="suggestions_anchor">
    <input type="text" id="search_input" placeholder="Search for...">
  </div>
</div>
<div id="facet_results"></div>
<div id="search_results"></div>

Tải tiện ích

Tiện ích được tải động qua tập lệnh trình tải. Để đưa trình tải vào, hãy sử dụng thẻ <script> như sau:

serving/widget/public/with_css/index.html
<!-- Google API loader -->
<script src="https://apis.google.com/js/api.js?mods=enable_cloud_search_widget&onload=onLoad" async defer></script>

Bạn phải cung cấp lệnh gọi lại onload trong thẻ tập lệnh. Hàm này được gọi khi trình tải sẵn sàng. Khi trình tải sẵn sàng, hãy tiếp tục tải tiện ích bằng cách gọi gapi.load() để tải ứng dụng API, Đăng nhập bằng Google và các mô-đun Tìm kiếm trên đám mây.

serving/widget/public/with_css/app.js
/**
* Load the cloud search widget & auth libraries. Runs after
* the initial gapi bootstrap library is ready.
*/
function onLoad() {
  gapi.load('client:auth2:cloudsearch-widget', initializeApp)
}

Hàm initializeApp() được gọi sau khi tất cả các mô-đun được tải.

Khởi chạy tiện ích

Trước tiên, hãy khởi chạy thư viện ứng dụng bằng cách gọi gapi.client.init() hoặc gapi.auth2.init() bằng mã ứng dụng đã tạo và phạm vi https://www.googleapis.com/auth/cloud_search.query. Tiếp theo, hãy sử dụng các lớp gapi.cloudsearch.widget.resultscontainer.Builder và gapi.cloudsearch.widget.searchbox.Builder để định cấu hình tiện ích và liên kết tiện ích đó với các phần tử HTML.

Ví dụ sau đây cho thấy cách khởi chạy tiện ích:

serving/widget/public/with_css/app.js
/**
 * Initialize the app after loading the Google API client &
 * Cloud Search widget.
 */
function initializeApp() {
  // Load client ID & search app.
  loadConfiguration().then(function() {
    // Set API version to v1.
    gapi.config.update('cloudsearch.config/apiVersion', 'v1');

    // Build the result container and bind to DOM elements.
    var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setSearchResultsContainerElement(document.getElementById('search_results'))
      .setFacetResultsContainerElement(document.getElementById('facet_results'))
      .build();

    // Build the search box and bind to DOM elements.
    var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setInput(document.getElementById('search_input'))
      .setAnchor(document.getElementById('suggestions_anchor'))
      .setResultsContainer(resultsContainer)
      .build();
  }).then(function() {
    // Init API/oauth client w/client ID.
    return gapi.auth2.init({
        'clientId': clientId,
        'scope': 'https://www.googleapis.com/auth/cloud_search.query'
    });
  });
}

Ví dụ trên tham chiếu đến hai biến cấu hình được xác định là:

serving/widget/public/with_css/app.js
/**
* Client ID from OAuth credentials.
*/
var clientId = "...apps.googleusercontent.com";

/**
* Full resource name of the search application, such as
* "searchapplications/<your-id>".
*/
var searchApplicationName = "searchapplications/...";

Tuỳ chỉnh trải nghiệm đăng nhập

Theo mặc định, tiện ích này nhắc người dùng đăng nhập và cho phép ứng dụng vào thời điểm họ bắt đầu nhập truy vấn. Bạn có thể sử dụng tính năng Đăng nhập bằng Google cho trang web để mang đến trải nghiệm đăng nhập phù hợp hơn cho người dùng.

Uỷ quyền trực tiếp cho người dùng

Sử dụng tính năng Đăng nhập bằng Google để theo dõi trạng thái đăng nhập của người dùng và đăng nhập hoặc đăng xuất người dùng nếu cần. Ví dụ: ví dụ sau đây quan sát trạng thái isSignedIn để theo dõi các thay đổi về trạng thái đăng nhập và sử dụng phương thức GoogleAuth.signIn() để bắt đầu đăng nhập từ một lượt nhấp vào nút:

serving/widget/public/with_signin/app.js
// Handle sign-in/sign-out.
let auth = gapi.auth2.getAuthInstance();

// Watch for sign in status changes to update the UI appropriately.
let onSignInChanged = (isSignedIn) => {
  // Update UI to switch between signed in/out states
  // ...
}
auth.isSignedIn.listen(onSignInChanged);
onSignInChanged(auth.isSignedIn.get()); // Trigger with current status.

// Connect sign-in/sign-out buttons.
document.getElementById("sign-in").onclick = function(e) {
  auth.signIn();
};
document.getElementById("sign-out").onclick = function(e) {
  auth.signOut();
};

Để biết thêm thông tin chi tiết, hãy xem bài viết Đăng nhập bằng Google.

Tự động đăng nhập người dùng

Bạn có thể đơn giản hoá thêm trải nghiệm đăng nhập bằng cách uỷ quyền trước cho ứng dụng thay mặt cho người dùng trong tổ chức của bạn. Kỹ thuật này cũng hữu ích nếu bạn sử dụng Cloud Identity-Aware Proxy để bảo vệ ứng dụng.

Để biết thêm thông tin, hãy xem bài viết Sử dụng tính năng Đăng nhập bằng Google với các ứng dụng CNTT.

Tuỳ chỉnh giao diện

Bạn có thể thay đổi giao diện của giao diện tìm kiếm thông qua việc kết hợp các kỹ thuật:

  • Ghi đè kiểu bằng CSS
  • Trang trí các phần tử bằng bộ chuyển đổi
  • Tạo thành phần tuỳ chỉnh bằng bộ chuyển đổi

Ghi đè kiểu bằng CSS

Tiện ích tìm kiếm đi kèm với CSS riêng để tạo kiểu cho các phần tử đề xuất và kết quả cũng như các chế độ điều khiển phân trang. Bạn có thể định kiểu lại các phần tử này nếu cần.

Trong quá trình tải, tiện ích tìm kiếm sẽ tự động tải tệp kiểu mặc định. Điều này xảy ra sau khi tải các tệp định kiểu ứng dụng, làm tăng mức độ ưu tiên của các quy tắc. Để đảm bảo kiểu của riêng bạn được ưu tiên hơn kiểu mặc định, hãy sử dụng bộ chọn thành phần cấp trên để tăng độ cụ thể của các quy tắc mặc định.

Ví dụ: quy tắc sau đây không có hiệu lực nếu được tải trong thẻ link hoặc style tĩnh trong tài liệu.

.cloudsearch_suggestion_container {
  font-size: 14px;
}

Thay vào đó, hãy xác định quy tắc bằng mã nhận dạng hoặc lớp của vùng chứa cấp trên được khai báo trong trang.

#suggestions_anchor .cloudsearch_suggestion_container {
  font-size: 14px;
}

Để biết danh sách các lớp hỗ trợ và ví dụ về HTML do tiện ích tạo, hãy xem tài liệu tham khảo Các lớp CSS được hỗ trợ.

Trang trí các phần tử bằng bộ chuyển đổi

Để trang trí một phần tử trước khi kết xuất, hãy tạo và đăng ký một bộ chuyển đổi triển khai một trong các phương thức trang trí như decorateSuggestionElement hoặc decorateSearchResultElement.

Ví dụ: các trình chuyển đổi sau đây sẽ thêm một lớp tuỳ chỉnh vào phần tử đề xuất và kết quả.

serving/widget/public/with_decorated_element/app.js
/**
 * Search box adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.decorateSuggestionElement = function(element) {
  element.classList.add('my-suggestion');
}

/**
 * Results container adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.decorateSearchResultElement = function(element) {
  element.classList.add('my-result');
}

Để đăng ký bộ chuyển đổi khi khởi chạy tiện ích, hãy sử dụng phương thức setAdapter() của lớp Builder tương ứng:

serving/widget/public/with_decorated_element/app.js
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

Các trình trang trí có thể sửa đổi các thuộc tính của phần tử vùng chứa cũng như mọi phần tử con. Bạn có thể thêm hoặc xoá các phần tử con trong quá trình trang trí. Tuy nhiên, nếu thực hiện thay đổi cấu trúc cho các phần tử, hãy cân nhắc việc tạo trực tiếp các phần tử thay vì trang trí.

Tạo thành phần tuỳ chỉnh bằng bộ chuyển đổi

Để tạo một phần tử tuỳ chỉnh cho nội dung đề xuất, vùng chứa phương diện hoặc kết quả tìm kiếm, hãy tạo và đăng ký một trình chuyển đổi triển khai createSuggestionElement, createFacetResultElement hoặc createSearchResultElement tương ứng.

Các trình chuyển đổi sau đây minh hoạ cách tạo các phần tử đề xuất và kết quả tìm kiếm tuỳ chỉnh bằng cách sử dụng thẻ <template> HTML.

serving/widget/public/with_custom_element/app.js
/**
 * Search box adapter that overrides creation of suggestion elements.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.createSuggestionElement = function(suggestion) {
  let template = document.querySelector('#suggestion_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.suggested_query').textContent = suggestion.suggestedQuery;
  return fragment.firstElementChild;
}

/**
 * Results container adapter that overrides creation of result elements.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.createSearchResultElement = function(result) {
  let template = document.querySelector('#result_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.title').textContent = result.title;
  fragment.querySelector('.title').href = result.url;
  let snippetText = result.snippet != null ?
    result.snippet.snippet : '';
  fragment.querySelector('.query_snippet').innerHTML = snippetText;
  return fragment.firstElementChild;
}

Để đăng ký bộ chuyển đổi khi khởi chạy tiện ích, hãy sử dụng phương thức setAdapter() của lớp Builder tương ứng:

serving/widget/public/with_custom_element/app.js
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

Việc tạo phần tử khía cạnh tuỳ chỉnh bằng createFacetResultElement phải tuân theo một số quy định hạn chế:

  • Bạn phải đính kèm lớp CSS cloudsearch_facet_bucket_clickable vào phần tử mà người dùng nhấp vào để bật/tắt một bộ chứa.
  • Bạn phải gói từng bộ chứa trong một phần tử chứa có lớp CSS cloudsearch_facet_bucket_container.
  • Bạn không thể hiển thị các bộ chứa theo thứ tự khác với thứ tự xuất hiện trong phản hồi.

Ví dụ: đoạn mã sau đây hiển thị các phương diện bằng cách sử dụng đường liên kết thay vì hộp đánh dấu.

serving/widget/public/with_custom_facet/app.js
/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}

ResultsContainerAdapter.prototype.createFacetResultElement = function(result) {
  // container for the facet
  var container = document.createElement('div');

  // Add a label describing the facet (operator/property)
  var label = document.createElement('div')
  label.classList.add('facet_label');
  label.textContent = result.operatorName;
  container.appendChild(label);

  // Add each bucket
  for(var i in result.buckets) {
    var bucket = document.createElement('div');
    bucket.classList.add('cloudsearch_facet_bucket_container');

    // Extract & render value from structured value
    // Note: implementation of renderValue() not shown
    var bucketValue = this.renderValue(result.buckets[i].value)
    var link = document.createElement('a');
    link.classList.add('cloudsearch_facet_bucket_clickable');
    link.textContent = bucketValue;
    bucket.appendChild(link);
    container.appendChild(bucket);
  }
  return container;
}

// Renders a value for user display
ResultsContainerAdapter.prototype.renderValue = function(value) {
  // ...
}

Tuỳ chỉnh hành vi tìm kiếm

Chế độ cài đặt Ứng dụng tìm kiếm thể hiện cấu hình mặc định cho giao diện tìm kiếm và ở trạng thái tĩnh. Để triển khai các bộ lọc hoặc phương diện động, chẳng hạn như cho phép người dùng bật/tắt các nguồn dữ liệu, bạn có thể ghi đè chế độ cài đặt ứng dụng tìm kiếm bằng cách chặn yêu cầu tìm kiếm bằng một bộ chuyển đổi.

Triển khai một bộ chuyển đổi bằng phương thức interceptSearchRequest để sửa đổi các yêu cầu được gửi đến API tìm kiếm trước khi thực thi.

Ví dụ: bộ chuyển đổi sau đây sẽ chặn các yêu cầu để hạn chế truy vấn đến một nguồn do người dùng chọn:

serving/widget/public/with_request_interceptor/app.js
/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}
ResultsContainerAdapter.prototype.interceptSearchRequest = function(request) {
  if (!this.selectedSource || this.selectedSource == 'ALL') {
    // Everything selected, fall back to sources defined in the search
    // application.
    request.dataSourceRestrictions = null;
  } else {
    // Restrict to a single selected source.
    request.dataSourceRestrictions = [
      {
        source: {
          predefinedSource: this.selectedSource
        }
      }
    ];
  }
  return request;
}

Để đăng ký bộ chuyển đổi khi khởi chạy tiện ích, hãy sử dụng phương thức setAdapter() khi tạo ResultsContainer

serving/widget/public/with_request_interceptor/app.js
var resultsContainerAdapter = new ResultsContainerAdapter();
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(resultsContainerAdapter)
  // ...
  .build();

Mã HTML sau đây được dùng để hiển thị hộp chọn lọc theo nguồn:

serving/widget/public/with_request_interceptor/index.html
<div>
  <span>Source</span>
  <select id="sources">
    <option value="ALL">All</option>
    <option value="GOOGLE_GMAIL">Gmail</option>
    <option value="GOOGLE_DRIVE">Drive</option>
    <option value="GOOGLE_SITES">Sites</option>
    <option value="GOOGLE_GROUPS">Groups</option>
    <option value="GOOGLE_CALENDAR">Calendar</option>
    <option value="GOOGLE_KEEP">Keep</option>
  </select>
</div>

Mã sau đây sẽ theo dõi thay đổi, thiết lập lựa chọn và thực thi lại truy vấn nếu cần.

serving/widget/public/with_request_interceptor/app.js
// Handle source selection
document.getElementById('sources').onchange = (e) => {
  resultsContainerAdapter.selectedSource = e.target.value;
  let request = resultsContainer.getCurrentRequest();
  if (request.query) {
    // Re-execute if there's a valid query. The source selection
    // will be applied in the interceptor.
    resultsContainer.resetState();
    resultsContainer.executeRequest(request);
  }
}

Bạn cũng có thể chặn phản hồi tìm kiếm bằng cách triển khai interceptSearchResponse trong bộ chuyển đổi.

Ghim phiên bản API

Theo mặc định, tiện ích này sử dụng phiên bản API ổn định mới nhất. Để khoá một phiên bản cụ thể, hãy đặt tham số cấu hình cloudsearch.config/apiVersion thành phiên bản ưu tiên trước khi khởi chạy tiện ích.

serving/widget/public/basic/app.js
gapi.config.update('cloudsearch.config/apiVersion', 'v1');

Phiên bản API sẽ mặc định là 1.0 nếu bạn không đặt hoặc đặt thành một giá trị không hợp lệ.

Ghim phiên bản tiện ích

Để tránh các thay đổi không mong muốn đối với giao diện tìm kiếm, hãy đặt tham số cấu hình cloudsearch.config/clientVersion như sau:

gapi.config.update('cloudsearch.config/clientVersion', 1.1);

Phiên bản tiện ích sẽ mặc định là 1.0 nếu bạn không đặt hoặc đặt thành một giá trị không hợp lệ.

Bảo mật giao diện tìm kiếm

Kết quả tìm kiếm chứa thông tin cực kỳ nhạy cảm. Làm theo các phương pháp hay nhất để bảo mật ứng dụng web, đặc biệt là chống lại các cuộc tấn công clickjacking.

Để biết thêm thông tin, hãy xem Dự án hướng dẫn OWASP

Bật tính năng gỡ lỗi

Sử dụng interceptSearchRequest để bật tính năng gỡ lỗi cho tiện ích tìm kiếm. Ví dụ:

  if (!request.requestOptions) {
  // Make sure requestOptions is populated
  request.requestOptions = {};
  }
  // Enable debugging
  request.requestOptions.debugOptions = {enableDebugging: true}

  return request;