相比同類自動完成插件,這個實作有三個設計取向:
測試環境為 E6500、2G 記憶體,30 秒內共發生 4469 次呼叫,耗時 94.65 毫秒;對照組(百度)為 2432 次呼叫、80.24 毫秒。呼叫次數接近兩倍,這部分應與 jQuery 本身的處理開銷有關,具體原因仍有待釐清,若有人知道歡迎指教。
jQuery("#kw").suggest({
url: siteConfig.suggestionUrl,
params: {
kw: function(){ return jQuery("#kw").val() },
n: 10
}
});
https://www.target.com/search.php。https://www.target.com/search.php?kw=xxx&n=10&callback=?(callback 預設自動加入)。參數值可為 function,讓插件在每次請求前即時取值。(function($){
$.tools = $.tools || {version: '1.0'};
$.tools.suggest = {};
$.tools.suggest.defaults = {
url : null,
params : null,
delay : 100,
cache : true,
formId : '#search_form',
focus : null,
callback : true
}
$.tools.suggest.borderKey = {
UP: 38, DOWN: 40, TAB: 9, ESC: 27, ENTER: 13
}
$.fn.suggest = function(options, fn){
var options, key = $.tools.suggest.borderKey;
if($.isFunction(options)){
fn = options;
options = $.extend({}, $.tools.suggest.defaults, key);
}else{
options = $.extend({}, $.tools.suggest.defaults, key, options);
}
return this.each(function(){
var
self = $(this),
url = options.url,
params = options.params,
searchUrl = null,
searchtimer = 0,
delay = options.delay,
cache = options.cache,
callback = options.callback,
formobj = $(options.formId),
focus = options.focus,
rebox = $('<ul/>').attr("id", "suggest"),
htmlLi = null, litop = null, lileft = null, liwth = null,
tip = false, val = null, rlen = null,
UP = options.UP, DOWN = options.DOWN, TAB = options.TAB,
ESC = options.ESC, ENTER = options.ENTER,
index = -1, choseKey = null, backval = null,
hidden = false, locksuggest = false
// ---- 初始化 ----
if(focus){
self.focus();
searchtimer = setInterval(getKey, delay);
}
self.bind("focus", function(){
searchtimer = setInterval(getKey, delay);
// 觸發焦點時初始化 backval
backval = (backval = $.trim(self.val())) == '' ? null : backval;
})
.bind("blur", function(){
clearInterval(searchtimer);
searchtimer = 0;
hideResult();
})
.bind("keydown", function(e){
// 少於 10 項時不使用 switch 判斷
if(e.keyCode == UP){
clearInterval(searchtimer); searchtimer = 0;
if($('#suggest').css('display') == 'none'){ reSet(); return false; }
index--;
if(index < 0){ index = Math.abs(rlen) - 1; }
changeSelect(index);
e.preventDefault();
return false;
}else if(e.keyCode == DOWN){
clearInterval(searchtimer); searchtimer = 0;
if($('#suggest').css('display') == 'none'){ reSet(); return false; }
index++;
if(index >= rlen){ index = 0; }
changeSelect(index);
e.preventDefault();
return false;
}else if(e.keyCode == TAB){
clearInterval(searchtimer); searchtimer = 0;
hideResult();
}else if(e.keyCode == ESC){
clearInterval(searchtimer); searchtimer = 0;
hideResult();
return false;
}else if(e.keyCode == ENTER){
clearInterval(searchtimer); searchtimer = 0;
}else if(searchtimer == 0){
searchtimer = setInterval(getKey, delay);
}
});
// 取得關鍵詞
function getKey(){
val = $.trim(self.val());
// 關鍵詞不為空且不重複
if(!!val && val != backval){
backval = val;
// 若啟用快取且已有結果,直接取用
if(cache && !!$.tools.suggest[val]){
index = -1;
rlen = $.tools.suggest[val][1];
appendSuggest($.tools.suggest[val][0]);
}else{
searchurl = url + '?' + $.param(params);
getResult(searchurl, function(htmltemp, htmllen){
index = -1;
rlen = htmllen;
appendSuggest(htmltemp);
});
}
}
// 關鍵詞為空則收起提示
if(!!!val && !hidden){
hideResult();
}
}
// 取得提示資料
function getResult(searchurl, fn){
if(callback){ searchurl = searchurl + '&callback=?'; }
$.getJSON(searchurl, function(data){
var htmltemp = '', htmllen = 0, inputWord = self.val()
$.each(data.list, function(i, n){
if(n.word != inputWord){ // 過濾掉與輸入完全相同的項
htmltemp += '<li>' + n.word + '</li>';
htmllen++;
}
});
if(cache && !!!$.tools.suggest[val]){
$.tools.suggest[val] = [htmltemp, htmllen]; // 寫入快取
}
fn.call(document, htmltemp, htmllen)
});
}
// 插入提示資料
function appendSuggest(result){
locksuggest = hidden = false;
if(!!result){
if(!tip){
litop = self.offset().top + self.outerHeight() - 1;
lileft = self.offset().left;
liwth = self.outerWidth() - 2;
rebox.css({'position':'absolute','top':litop,'left':lileft,'width':liwth})
.html(result).appendTo('body').show();
tip = true;
}else{
rebox.html(result).show();
}
rebox.find('li').bind('mouseover', function(){
// 鎖定提示層,避免因事件冒泡而關閉
locksuggest = true;
index = $(this).index();
changeSelect(index, false);
})
.bind('click', function(){
changeSelect(index);
searchSubmit();
});
rebox.bind('mouseout', function(){ locksuggest = false; })
}else{
// 檢索結果為空則隱藏提示層
rebox.hide();
}
}
function changeSelect(index, v){
v = v == false ? false : true;
var obj = rebox.find('li').eq(index);
rebox.find('li.mo').removeClass('mo');
obj.addClass("mo");
if(v){
choseKey = backval = obj.html();
self.val(choseKey);
}
}
function reSet(){
if(!!self.val()){
index = -1;
$('#suggest').css('display','block');
rebox.find('li.mo').removeClass('mo');
// 依 html 結構重新計算提示結果長度
rlen = rebox.find('li').size();
}
}
function hideResult(){
if(!locksuggest){
choseKey = backval = null;
hidden = true;
rebox.hide();
}
}
function searchSubmit(){
self.val(choseKey);
hideResult();
clearInterval(searchtimer);
formobj.submit();
}
});
}
})(jQuery);
輪詢取代 keyup。用 setInterval 定時比對輸入值是否變化,避開了 keydown/keyup 在部分輸入法或系統環境下不觸發的問題,代價是多了定時器的開銷。
locksuggest 旗標。滑鼠從輸入框移到提示清單時,若沒有這個旗標,hideResult() 會在 mouseout 時先把清單收起來,導致 click 永遠點不到。這類「事件冒泡順序」的坑,幾乎每個自製下拉元件都會踩一次。
keyDown 期間暫停輪詢。按方向鍵時先 clearInterval,避免輪詢與鍵盤操作互相搶資源造成選項跳動。
程式碼打包下載可參考原文章頁面。