用 jQuery Autocomplete 搭配 ASP.NET 的 WebService 或一般處理常式(.ashx)做自動完成,看似簡單,實作時卻常卡在幾個不上不下的細節。以下把實戰中遇到的問題與解法整理出來。
從 WebService 或 .ashx 取回 JSON 字串時,Autocomplete 無法自動識別,會把它當成單一字串處理,導致下拉清單一片空白。解法是自行覆寫 parse 方法,手動 eval 並組出插件需要的資料結構:
$("#txt").autocomplete("/Asmx/ExecutePlan.ashx", {
extraParams:{hosid:HosID,profid:ProfID},
minChars: 0,
max: 700,
mustMatch: true,
autoFill: true,
selectFirst: true,
scrollHeight: 220,
width:640,
scroll:true,
parse: function(data){
var obj=eval("("+data+")");
var row = [];
for(var i = 0; i<obj.length; i++){
row[i] = {data:obj[i], //json
value: obj[i].instName, //列表中中的值
result: obj[i].instName}; //顯示到下拉列表中的
}
if(obj.length == 1)
{
// $("#hfInstID").val(obj[0].executeID);
// $("#Button1").click();
}
return row;
} ,
formatItem: function(row, i, total) {
},
formatMatch: function(row, i, max) {
},
formatResult: function(row, i, max) {
}
});
這裡要注意三個欄位各自的意義:value 是輸入框裡實際填入的文字,result 是顯示於下拉列表中的內容,data 則是完整保留的原始資料,方便後續取用其他欄位(例如把 executeID 塞進隐藏欄位)。
覆寫 parse 之後,formatItem 與 formatMatch 這兩個格式化事件就不會被觸發了。這是自訂 parse 時常見的副作用,因為格式化流程已經被你的程式碼接手。
如果只是想在使用者選取值之後做一些處理,可以改用 result 事件。注意這段要另外寫,放在上面那段綁定程式碼之後即可:
$("#txt").result(function(event, data, formatted) {
});
其中 data 是原始資料物件、formatted 是最終顯示的文字,具體參數含義可對照官方開發文件。
$("#txt").flushCache();
這個方法用來清空 Autocomplete 的內部快取。實務上很常被忽略:當查詢條件改變(例如使用者切換了上方的院所或科別下拉選單),若不清快取,就會看到上一次查詢殘留的建議清單。合理的做法是在條件變化的 callback 裡呼叫它。
這套寫法有明顯的時代痕跡,如果今天重做,有幾個地方值得調整:
JSON.parse(),並讓後端明確設定 Content-Type: application/json;若資料來自不可信來源,eval 等於把執行權交給對方。source 提供資料來源,內建 _renderItem 覆寫點,不必再手寫 parse。delay 與最小字元數限制。