開放搜尋框給網友用之後,就會看到人類的創意極限:有人故意輸入空格,有人試 or 1=1,有人丟 alert,还有人塞 HTML 進來。與其防不勝防,不如把輸入當成一律不可信——所有回顯的內容都必須轉義,所有往後端的參數都必須參數化查詢。

輸入框自動補全是搜尋功能的標配:使用者敲幾個字,後端回傳相關條目即時顯示在下方,省去完整輸入與翻頁。這個專案用於站內搜尋,量級不大,但體驗提升明顯。
常見的補全插件有兩個:jQuery UI Autocomplete 與 bootstrap-3-typeahead。本站選用後者。

source:function(query, process){}。query 是當前輸入框的字串,在此可發 ajax 請求後端(陣列形式的 JSON),再把結果傳給 process。
formatItem:function(item){}。把單個資料項目轉為顯示在提示清單中的字串,回傳字串。
setValue:function(item) {}。選中某項時決定輸入框顯示什麼、以及實際要取用的值。回傳格式為 {'data-value':item["顯示用屬性"], 'real-value':item["實際用屬性"]},後續可透過 real-value 屬性取得。
items:提示的最大結果數,預設 8。
minLength:輸入達到此長度才觸發比對,預設 1。
delay:延遲幾毫秒才真正請求後端,用來避免輸入過快造成頻繁請求,預設 500。
<script src="~/Scripts/jquery-1.9.0.js"></script> <script src="~/Scripts/bootstrap.js"></script> <script src="~/Content/js/bootstrap3-typeahead.js"></script>
<form id="searchform" class="navbar-form navbar-right" role="search" target="_blank" method="get" action="/Search/Index"> <div class="form-group"> <input type="text" id="searchWords" name="searchWords" class="form-control" data-provide="typeahead" autocomplete="off" placeholder="請輸入要搜索關鍵詞"> </div> <button type="submit" class="btn" id="searchbtn"> 搜索 </button> </form>
注意 autocomplete="off":少了它,瀏覽器自己的歷史紀錄下拉會和補全清單疊在一起,畫面很亂。
//搜索自動補全;給搜索框注冊自動聯想完成事件 autoComplete: function () { jQuery('#searchWords').typeahead({ source: function (query, process) { //query是輸入值 jQuery.getJSON('/Search/GetHotSearchItems', { "query": query }, function (data) { process(data); }); }, updater: function (item) { return item.replace(/<a(.+?)<\/a>/, ""); //這裡一定要return,否則選中不顯示 }, afterSelect: function (item) { //選擇項之後的時間,item是當前選中的項 alert(item); }, items: 8, //顯示8條 delay: 500 //延遲時間 }); },
updater 決定選中後填回輸入框的內容。這裡用正則把 <a> 標籤剝掉,因為後端回傳的項目帶有可點擊的 HTML;但這個做法有問題——用正則處理 HTML 向來不可靠,巢狀或屬性含 > 時就會失效。更好的方式是由後端同時回傳純文字欄位供輸入框使用,HTML 只用於清單渲染。
#region 2.0 jquery typeahead插件異步獲取搜索熱詞、自動補全搜索框; ActionResult GetHotSearchItems() /// <summary> /// 2.0 jquery typeahead插件異步獲取搜索熱詞、自動補全搜索框> /// 每搜索一次就將此次用戶搜索的詳情入庫> /// 定時任務每隔10分鐘統計一次各搜索詞的次數、將統計信息更新到SearchRank表 /// </summary> /// <returns>JSON</returns> public ActionResult GetHotSearchItems() { //2.1 先獲取當前搜索詞"query" string query = Request["query"]; //2.2 從數據庫中查詢此字段的熱詞集合 IBLL.ISearchRankService hotService = OperateHelper.Current.serviceSession.SearchRankService; //2.3 從數據庫中檢索出包含此搜索詞的熱詞集合,並按搜索次數排序,將數據返回給typeahead.js List<SearchRank> hotList = hotService.GetDataListBy(s => s.KeyWord.Contains(query), s => s.SearchTimes); if (hotList != null) { var list1 = hotList.Select(h => new { name = h.KeyWord, times = h.SearchTimes }).ToList(); ArrayList list2 = new ArrayList(); int i = 1; foreach (var item in list1) { list2.Add(string.Format("<a class=\"cat\" href=\"#\">{0}</a>{1}", i, item.name)); i++; } return Json(list2, JsonRequestBehavior.AllowGet); } else { return Json("", JsonRequestBehavior.AllowGet); } } #endregion
沒有對 query 做任何驗證。直接丟進 Contains() 雖然由 ORM 參數化,不會有 SQL 注入,但使用者輸入空白字元時會回傳全表;輸入極長字串則可能造成昂貴的查詢。建議加上長度上限與去空白,並在過短時直接回空陣列。
把 HTML 組裝放在後端。string.Format("<a class=\"cat\"...") 讓資料層與視圖層耦合在一起,而且 item.name 未經 HtmlEncode 就插入標籤——若熱詞表中存有任何含 < 的內容,這裡就是一個 XSS 漏洞。後端應該只回傳純資料,HTML 渲染交給前端樣板。
回傳型別不一致。有資料時回傳陣列,沒資料時回傳空字串 ""。前端 process(data) 收到字串時行為未定義。應該統一回傳陣列,空結果就是空陣列。
public ActionResult GetHotSearchItems() { var query = (Request["query"] ?? string.Empty).Trim(); if (query.Length < 1 || query.Length > 50) { return Json(Enumerable.Empty<object>(), JsonRequestBehavior.AllowGet); } var hotService = OperateHelper.Current.serviceSession.SearchRankService; var hotList = hotService.GetDataListBy(s => s.KeyWord.Contains(query), s => s.SearchTimes); var result = hotList.Select(h => new { value = h.KeyWord, times = h.SearchTimes }); return Json(result, JsonRequestBehavior.AllowGet); }
這裡回傳 value 屬性直接對應 typeahead 的預設 displayKey,前端不必再剝標籤;型別固定為陣列;query 做了 trim 與長度限制。若使用了 JsonRequestBehavior.AllowGet,代表這是 GET 端點,別忘了 GET 請求不應有改動資料的副作用——註解提到「每搜索一次就將詳情入庫」,這部分建議移到 POST 端點或改用其他統計機制。
最後提醒:熱詞統計若顯示未經 moderation 的使用者輸入,等於讓使用者內容直接曝光在搜尋建議中,需要搭配敏感詞過濾與 HTML 編碼。