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ư thuộc tính và phân trang. Bạn cũng có thể tuỳ chỉnh các phần của giao diện bằng CSS và JavaScript.

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

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

Việc xây dựng giao diện tìm kiếm cần một số bước sau:

1. Định cấu hình ứng dụng tìm kiếm
2. Tạo mã ứng dụng khách 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 dành cho quản trị viên. Ứ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, thuộc tính và chất lượng tìm kiếm.

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

Tạo mã ứng dụng khách cho ứng dụng

Ngoài các bước trong Định cấu hình quyền truy cập vào Google Cloud Search API, bạn cũng phải tạo ID ứng dụng khách 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 Web browser (Trình duyệt web)
• Cung cấp URI gốc ứng dụng của bạn.
• Ghi chú về mã ứng dụng khách đã được tạo. Bạn sẽ cần mã ứng dụng khách để hoàn tất các bước tiếp theo. Không bắt buộc phải có mật khẩu ứng dụng khách cho tiện ích.

Để biết thêm thông tin, hãy xem 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 của hộp tìm kiếm.
• Một phần tử để neo cửa sổ đề xuất bật lên.
• 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 chế độ điều khiển thuộc tính.

Đoạn mã HTML sau hiển thị HTML cho một tiện ích tìm kiếm, nơi các phần tử cần liên kết được xác định bằng thuộc tính id của chúng:

<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 này được tải động thông qua một tập lệnh của trình tải. Để bao gồm trình tải, hãy dùng thẻ <script> như dưới đây:

<!-- 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, mô-đun Đăng nhập bằng Google và mô-đun Cloud Search.

/**
* 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 xong.

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() có mã ứng dụng khách đã tạo của bạn và phạm vi https://www.googleapis.com/auth/cloud_search.query. Tiếp theo, hãy sử dụng gapi.cloudsearch.widget.resultscontainer.Builder và gapi.cloudsearch.widget.searchbox.Builder lớp để định cấu hình tiện ích và liên kết nó với các phần tử HTML của bạn.

Ví dụ sau đây trình bày cách khởi chạy tiện ích:

/**
 * 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 hai biến cho cấu hình được xác định là:

/**
* 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 sẽ nhắc người dùng đăng nhập và cấp quyền cho ứ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.

Cấp phép 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ười dùng đăng nhập hoặc đăng xuất khi cần. Ví dụ: như sau Ví dụ: isSignedIn để giám sát các thay đổi về đăng nhập và sử dụng GoogleAuth.signIn() phương thức bắt đầu đăng nhập từ một nút nhấp vào:

// 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, 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á trải nghiệm đăng nhập hơn nữa bằng cách cho phép trước 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 sử dụng Proxy Cloud Identity Aware để bảo vệ ứng dụng.

Để biết thêm thông tin, hãy xem phần 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 bằng cách kết hợp kỹ thuật:

• Ghi đè kiểu bằng CSS
• Trang trí các phần tử bằng bộ chuyển đổi
• Tạo phần tử 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 phần đề xuất và phần tử kết quả cũng như các chế độ kiểm soát phân trang. Bạn có thể định kiểu lại các thành phần này nếu cần.

Trong khi tải, tiện ích tìm kiếm sẽ tự động tải biểu định kiểu mặc định. Điều này xảy ra sau khi biểu định kiểu của ứng dụng được tải, làm tăng mức độ ưu tiên 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, sử dụng bộ chọn đối tượng cấp trên để tăng mức độ 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 ở trạng thái tĩnh Thẻ link hoặc style trong tài liệu.

.cloudsearch_suggestion_container {
  font-size: 14px;
}

Thay vào đó, hãy đáp ứng điều kiện cho quy tắc này bằng mã hoặc lớp của vùng chứa đối tượng 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à HTML mẫu do tiện ích này tạo ra, hãy xem Tài liệu tham khảo về 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ý lại 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ụ: những bộ chuyển đổi sau đây thêm một lớp tuỳ chỉnh vào đề xuất và phần tử kết quả.

/**
 * 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 setAdapter() của lớp Builder tương ứng:

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

Trang trí có thể chỉnh sửa các thuộc tính của phần tử vùng chứa cũng như bất kỳ các 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 thay đổi cấu trúc cho các phần tử, hãy cân nhắc tạo thay vì trang trí.

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

Để tạo phần tử tùy chỉnh cho đề xuất, vùng chứa thuộc tính hoặc kết quả tìm kiếm, tạo và đăng ký bộ chuyển đổi giúp triển khai createSuggestionElement! createFacetResultElement! hoặc createSearchResultElement theo cách thể hiện.

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

/**
 * 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ý lại bộ chuyển đổi khi khởi chạy tiện ích, hãy sử dụng setAdapter() của lớp Builder tương ứng:

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

Tạo các phần tử thuộc tính tuỳ chỉnh bằng createFacetResultElement tuân theo một số hạn chế:

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

Ví dụ: đoạn mã sau đây hiển thị các thuộc tính bằng cách sử dụng đường liên kết hộp kiểm.

/**
 * 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 chế độ mặc định cho giao diện tìm kiếm và ở dạng tĩnh. Để triển khai động bộ lọc hoặc khía cạnh, chẳng hạn như cho phép người dùng bật/tắt nguồn dữ liệu, bạn có thể ghi đè các 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 bộ chuyển đổi.

Triển khai bộ chuyển đổi bằng 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 chặn các yêu cầu hạn chế truy vấn thành nguồn do người dùng chọn:

/**
 * 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 setAdapter() khi tạo ResultsContainer

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

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

<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>

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

// 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 ổn định mới nhất của API. Để cố gắng phiên bản cụ thể, hãy đặt thông số cấu hình cloudsearch.config/apiVersion vào phiên bản bạn muốn trước khi khởi chạy tiện ích.

gapi.config.update('cloudsearch.config/apiVersion', 'v1');

Phiên bản API sẽ được đặt thành 1.0 theo mặc định nếu không được đặ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 những thay đổi không mong muốn đối với giao diện tìm kiếm, hãy đặt Thông số cấu hình cloudsearch.config/clientVersion như dưới đây:

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

Phiên bản tiện ích sẽ mặc định là 1.0 nếu không được đặt hoặc đượ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ó mức độ nhạy cảm cao. Làm theo các phương pháp hay nhất để bảo mật các ứng dụng web, đặc biệt là 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 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;