搜尋框的「邊打字邊提示」是常見需求。本文自行實作一個 autocomplete 外掛,並針對瀏覽器相容性做了處理,實測可運作於 IE6+ 與 Firefox 3.5+。
;(function ($) {
var index = -1; // 目前高亮的提示項索引
var timeId; // setTimeout 的計時器識別碼
var cssOptions = {
"border": "1px solid black",
"background-color": "white",
"position": "absolute"
};
var defaults = {
width: "auto", // 提示框寬度
highlightColor: "#3399FE", // 高亮色
unhighlightColor: "#FFFFFF",// 非高亮色
css: cssOptions,
dataType: "xml", // 回傳資料型別
paramName: "word", // 送出參數的名稱
delay: 500, // 延遲多久發出請求
max: 20
};
var keys = {
UP: 38, DOWN: 40, DEL: 46, TAB: 9, ENTER: 13, ESC: 27,
PAGEUP: 33, PAGEDOWN: 34, BACKSPACE: 8, A: 65, Z: 90
};
$.fn.extend({
autocomplete: function (sUrl, settings) {
sUrl = (typeof sUrl === "string") ? sUrl : "";
// 若有 id 則以 id 作為參數名,否則用預設值
var param = !this.attr("id") ? defaults.paramName : this.attr("id");
settings = $.extend({}, defaults, {url: sUrl, paramName: param}, settings);
var autoTip = this.autoTipTemplate(this, settings);
$("body").append(autoTip);
var $this = this;
this.keyup(function (event) {
$this.keyOperator(event, autoTip, settings);
});
return this.each(function () { $this.val(); });
},
// 建立提示框並依輸入框位置定位
autoTipTemplate: function (input, settings) {
var inputOffset = input.offset();
var autoTip = $("<div/>").css(settings.css).hide()
.css("top", inputOffset.top + input.height() + 5 + "px")
.css("left", inputOffset.left + "px");
var space = $.browser.mozilla ? 2 : 6; // 瀏覽器間邊距差異補償
var tipWidth = (typeof settings.width === "string" && "auto") ? input.width() : settings.width;
autoTip.width(tipWidth + space + "px");
return autoTip;
},
select: function (target, index, settings, flag) {
var color = flag ? settings.highlightColor : settings.unhighlightColor;
target.children("div").eq(index).css("background-color", color);
},
// 核心:處理所有鍵盤操作
keyOperator: function (event, autoTip, settings) {
var evt = event || window.event;
var autoNodes = autoTip.children("div");
var kc = evt.keyCode;
var $this = this;
// 按下字母、Delete 或 Backspace:發出請求
if (kc >= keys.A && kc <= keys.Z || kc == keys.BACKSPACE || kc == keys.DEL) {
var wordText = this.val();
if (wordText.length != 0) {
var param = {};
param[settings.paramName] = wordText;
clearTimeout(timeId);
timeId = setTimeout(function () {
$.post(settings.url, param, function (data) {
var wordObj = $(data);
if (settings.dataType == "xml") {
var wordNodes = wordObj.find("word");
autoTip.html("");
wordNodes.each(function (i) {
var divNode = $("<div>").attr("id", i);
divNode.html($(this).text()).appendTo(autoTip);
divNode.mousemove(function () {
if (index != -1) {
autoTip.children("div").eq(index)
.css("background-color", settings.unhighlightColor);
}
index = $(this).attr("id");
$(this).css("background-color", settings.highlightColor);
});
divNode.mouseout(function () {
$(this).css("background-color", settings.unhighlightColor);
});
divNode.click(function () {
$this.val($(this).text());
index = -1;
autoTip.hide();
});
});
wordNodes.length > 0 ? autoTip.show() : (autoTip.hide(), index = -1);
}
});
}, settings.delay);
} else {
autoTip.hide();
index = -1;
}
}
// 上下鍵:切換高亮項
else if (kc == keys.UP || kc == keys.DOWN) {
if (kc == keys.UP) {
if (index != -1) autoNodes.eq(index).css("background-color", settings.unhighlightColor);
index--;
if (index == -1) index = autoNodes.length - 1; // 循環到最後一項
autoNodes.eq(index).css("background-color", settings.highlightColor);
} else {
if (index != -1) autoNodes.eq(index).css("background-color", settings.unhighlightColor);
index++;
if (index == autoNodes.length) index = 0; // 循環回第一項
autoNodes.eq(index).css("background-color", settings.highlightColor);
}
}
// PageUp / PageDown:跳到首尾
else if (kc == keys.PAGEUP || kc == keys.PAGEDOWN) {
event.preventDefault();
if (index != -1) autoNodes.eq(index).css("background-color", settings.unhighlightColor);
if (kc == keys.PAGEUP) {
if (autoNodes.length > 0) { index = 0; autoNodes.eq(0).css("background-color", settings.highlightColor); }
} else {
index = autoNodes.length - 1;
autoNodes.eq(index).css("background-color", settings.highlightColor);
}
}
// Enter:有高亮項就帶入,否則視為送出
else if (kc == keys.ENTER) {
if (index != -1) {
$this.val(autoNodes.eq(index).text());
} else {
$("body").append($("<div/>").text("文本框中的【" + $this.val() + "】被提交了!"));
$this.get(0).blur();
}
autoTip.hide();
index = -1;
}
// Esc:直接關閉
else if (kc == keys.ESC) {
autoTip.hide();
}
}
});
})(jQuery);
index:目前高亮提示項的索引,-1 代表無。timeId:使用者連續輸入時,用 setTimeout 延後發出 AJAX 請求的計時器,這其實就是 debounce 的雛形。cssOptions:提示框的預設樣式。width:設為 "auto" 時會對齊輸入框寬度。highlightColor/unhighlightColor:高亮與一般狀態的背景色。dataType:AJAX 回傳的資料型別,預設 xml。paramName:送出請求時的參數名稱;若有設定輸入框 id,會改用 id 作為參數名。delay:輸入停止多久後才發出請求,預設 500 毫秒。autocomplete:對外的主要入口,可傳入請求的 URL 與上述設定,回傳輸入框的值。autoTipTemplate:建立提示框並定位,回傳一個 jQuery 物件。keyOperator:核心函式,所有鍵盤操作與自動補全都靠它。
<script type="text/javascript" src="jslib/jquery-1.3.2.min.js"></script>
<script type="text/javascript" src="jslib/jquery.autocomplete-1.2.js"></script>
<script type="text/javascript">
$(function () {
$(":text").autocomplete("AutocomplataWordServlet", { dataType: "xml", width: "auto" });
});
</script>
請輸入:<input type="text" />
<input type="button" value="Go" />
也可以傳入更多設定:
$(":text").autocomplete("AutocomplataWordServlet", {
width: "auto",
highlightColor: "#3355FE",
unhighlightColor: "#FFFFcc",
css: { border: "2px solid red" },
dataType: "xml",
paramName: "keyWord",
delay: 300
});
package com.hoo.servlet;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@SuppressWarnings("serial")
public class AutocomplataWordServlet extends HttpServlet {
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String word = request.getParameter("word");
request.setAttribute("word", word);
request.getRequestDispatcher("word.jsp").forward(request, response);
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doGet(request, response);
}
}
Servlet 本身沒什麼玄機,就是取出輸入框送來的關鍵字,轉交給 JSP 進行比對。而 word.jsp 負責輸出 XML:
<%@ page language="java" contentType="text/xml; charset=UTF-8" %>
<%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>
<%@ taglib prefix="fn" uri="https://java.sun.com/jsp/jstl/functions" %>
<words>
<c:if test="${fn:startsWith('abstruct', word)}"><word>abstruct</word></c:if>
<c:if test="${fn:startsWith('appeared', word)}"><word>appeared</word></c:if>
<c:if test="${fn:startsWith('apple', word)}"><word>apple</word></c:if>
<c:if test="${fn:startsWith('boolean', word)}"><word>boolean</word></c:if>
<c:if test="${fn:startsWith('break', word)}"><word>break</word></c:if>
<c:if test="${fn:startsWith('class', word)}"><word>class</word></c:if>
......
</words>
這裡有個非常關鍵、卻很容易漏掉的細節:contentType="text/xml; charset=UTF-8"。如果少了 text/xml 這個 Content-Type,部分瀏覽器根本不會把回應當成 XML 來解析,前端拿到的就是一串無法 traverse 的文字。
這個外掛寫於 jQuery 1.3 時代,有幾處若要在今日重新實作會需要調整:
$.browser.mozilla 在新版 jQuery 已移除,那個 space 補償值應改用 feature detection 或直接交由 CSS 處理。div 堆疊,無障礙上不友善。建議改用 ul/li 並加上 role="listbox"、role="option" 與 aria-activedescendant,讓螢幕閱讀器能讀出目前高亮項。fn:startsWith 逐一比對寫死的單字,示範可以,實務上應改為查詢資料庫或索引服務。作者:hoojo,blog:https://blog.csdn.net/IBM_hoojo