搜尋框打字打到一半,下方自動浮出候選清單——這個互動自 Google 之後幾乎成了標準配備。SuggestFramework 把整套邏輯封裝好了,前端只要掛上腳本、給幾個屬性設定就能用,而且完全沒有平台限制。
<script type="text/javascript" src="/path/to/SuggestFramework.js"></script>
<script type="text/javascript">window.onload = initializeSuggestFramework;</script>
有了這兩行之後,每個取了 name 的輸入框都會多出五個可設定的屬性。
其中 delay 的設計值得留意:它本質上就是一個 debounce,避免使用者每敲一個按鍵就送一次請求。預設 1 秒偏保守,實務上可依伺服器負載往下調到 200~300 毫秒。
前端只會送出兩個參數:
後台的輸出格式是一條 JavaScript 語句。一維陣列這樣寫:
new Array("val1", "val2", "val3");
二維陣列這樣寫:
new Array(
new Array("第1行第1列", "第1行第2列"),
new Array("第2行第1列", "第2行第2列"),
new Array("第3行第1列", "第3行第2列")
);
官方壓縮檔中已附 PHP 與 ColdFusion 的範例,但因為輸出只是一段陣列宣告,任何語言都能產生,換成 Java、Ruby、Python 都沒有障礙。
.SuggestFramework_List:提示內容所在的整體區域.SuggestFramework_Heading:第一條提示(標題列).SuggestFramework_Highlighted:目前被高亮(鍵盤選取)的那一條.SuggestFramework_Normal:其餘一般提示資料來源要有限制。建議清單通常從資料庫即時查詢,若直接把使用者輸入的字串拼進 SQL,等於開了 SQL Injection 的大門,務必改用參數化查詢。
記得做前綴比對與排序。使用者在搜尋框打的是開頭幾個字,用 like 'keyword%' 而非 like '%keyword%',除了結果更貼近期待,也能有效使用索引。若要撈的資料量很大,可考慮加上 limit 限制回傳筆數(例如最多 10 筆),並只在擊中一定長度以上才觸發查詢。
輸出內容要轉義。回傳的陣列值若含有引號或換行,會直接破壞那段 JavaScript 語句;顯示到畫面上時也應做 HTML 編碼,避免建議清單成為 XSS 的跳板。
別忘了鍵盤與無障礙操作。好的建議清單要能上下鍵移動、Enter 選取、Esc 關閉,並適度加上 ARIA 屬性(如 role="listbox"、aria-expanded),讓螢幕閱讀器也能理解這是什麼。
下載位置:https://xiazai.jb51.net/200903/yuanma/SuggestFramework-0.31.zip