DIV CSS 佈局教程網

用 PHP + jQuery 實作搜尋自動提示功能
編輯:關於JavaScript     

與往常一樣,demo 與原始碼的 zip 檔在文章最後,慢慢欣賞吧。

我覺得有必要寫這篇教學,因為曾見到的大部分自動完成應用都只給你一個程式碼包,然後告訴你怎麼用,卻不說它是如何運作、以及為什麼要這樣做。而理解這些,才能讓你進一步依自己的需求去客製化。

好,我們現在開始。

JavaScript 部分

<script src="jquery-1.2.1.pack.js" type="text/javascript"></script>
<script type="text/javascript">

function lookup(inputString) {
  if (inputString.length == 0) {
    // 隱藏建議框
    $('#suggestions').hide();
  } else {
    $.post("rpc.php", {queryString: ""+inputString+""}, function(data){
      if (data.length > 0) {
        $('#suggestions').show();
        $('#autoSuggestionsList').html(data);
      }
    });
  }
} // lookup

function fill(thisValue) {
  $('#inputString').val(thisValue);
  $('#suggestions').hide();
}

</script>

JavaScript 的解說

從上面的程式碼可以看到,我們需要連到一個名為 rpc.php 的檔案,所有處理都在那裡進行。

lookup 函式取得文字輸入框中的字串,再用 jQuery 的 Ajax 方法以 POST 傳給 rpc.php。

如果輸入字串長度為 0(也就是搜尋框裡沒東西),建議框就被隱藏。這很合理——什麼都沒輸入時,你並不希望跳出一個提示框。

如果有內容,我們就取得這個 inputString 並傳給 rpc.php,接著使用 jQuery 的 $.post():

$.post(url, [data], [callback])

callback 部分可以關聯一個函式,這比較有意思——只有在資料成功載入後才會執行。

如果傳回的資料不為空(也就是有東西要顯示),那就顯示建議框,並用傳回的資料取代其中的 HTML。就這麼簡單。

fill 函式則負責反方向的互動:使用者點了某個建議項,就把該值填回輸入框,並把建議框收起來。要讓這個流程完整,建議清單中的每一項目都要有一個 onclick 指向 fill:

<li onclick="fill('Brett')">Brett</li>

PHP 後端(rpc.php)

如你所知,我的 PHP 後端程式都叫做 rpc.php(RPC 指遠端程序呼叫),而沒有用它實際的功能來命名——但也還不錯了。

// PHP5 實作,使用 MySQLi
$db = new mysqli('localhost', 'root', '', 'autoComplete');

if (!$db) {
  // 無法連線時顯示錯誤
  echo 'ERROR: Could not connect to the database.';
} else {
  // 有沒有 POST 過來的查詢字串?
  if (isset($_POST['queryString'])) {
    $queryString = $db->real_escape_string($_POST['queryString']);

    if (strlen($queryString) > 0) {
      $query = $db->query("SELECT name FROM sample
                            WHERE name LIKE '%" . $queryString . "%'
                            LIMIT 10");
      if ($query) {
        while ($row = $query->fetch_assoc()) {
          echo '<li onclick="fill(\'' . $row['name'] . '\')">'
             . $row['name'] . '</li>';
        }
      }
    }
  }
}

實作時務必補上的三件事

用參數化查詢取代字串拼接。上面為了呼應原文風格保留了字串組句的方式,但這在真實環境中是 SQL Injection 的標準入口。正確寫法是用 prepared statement:

$stmt = $db->prepare("SELECT name FROM sample WHERE name LIKE ? LIMIT 10");
$like = '%' . $queryString . '%';
$stmt->bind_param('s', $like);
$stmt->execute();
$result = $stmt->get_result();

輸出時要轉義。把資料庫內容直接寫進 HTML 會造成 XSS。請用 htmlspecialchars($row['name'], ENT_QUOTES, 'UTF-8') 處理,尤其是要放進 onclick 屬性的值,因為它同時位於 HTML 與 JavaScript 兩個上下文中。

加上延遲與快取。使用者每敲一個字就發一次請求,會讓伺服器承受不必要的負擔。實務上會加 200~300 毫秒的 debounce,並對相同的查詢字串做前端快取。

今天該怎麼做

手刻自動完成的價值在於理解原理,但若要在專案中直接使用,成熟方案會更省事、也更完備:前端可用 jQuery UI 的 autocomplete 或 typeahead.js,它們已處理好鍵盤上下鍵操作、Esc 關閉、Enter 選取、ARIA 無障礙屬性等細節;後端則只需提供一個傳回 JSON 的端點,前端負責比對與高亮。

另外提醒,範例中的 jQuery 1.2.1 是 2008 年的版本,與現行版本 API 差異甚大,請下載最新版使用。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved