一、緣起
搜尋是 Web 上最普遍的功能之一。隨著技術演進,搜尋引擎開始嘗試更貼近閱讀情境的做法。Yahoo! 的 Y!Q 是一例:它能針對任意網頁執行搜尋,前提是該頁作者在自己的頁面中嵌入對應元素;搜尋結果以浮動層的形式疊在讀者眼前,讓人不必離開當前頁面就能看到更多資訊。
想法很好,批評也不少。首先,它要求使用者載入 Yahoo! 的 JavaScript 並加上 <form> 元素,對許多網站作者來說門檻偏高;而所有條件都滿足之後,搜尋結果會以 Yahoo! 的樣式呈現,直接破壞了原網站的視覺一致性。
幸好 Yahoo! 不是唯一的選擇。MSN Search 也提供類似服務,而且把外觀的控制權交還給開發者——關鍵在於它同時提供搜尋結果的 RSS 版本,於是你可以訂閱某個搜尋結果,或用 AJAX 把結果嵌進自己的頁面。Google 也走了類似路線,BlogSearch Beta 當時同樣能以 RSS 或 Atom 格式回傳結果。
二、伺服器端:把 RSS 抓回來
在 MSN Search 執行搜尋後,結果頁底部會出現一個橘紅色的 XML 圖示,點擊即可取得該搜尋的訂閱網址。有了它,就能寫伺服器端程式去抓取這份 feed。請求的 URL 形如:
websearch.php?search=[SEARCHTERM]
查詢字串只有一個變數 search。伺服器端的實作如下:
<?php
header("Content-Type: text/xml");
header("Cache-Control: no-cache");
if (isset($_GET["search"])) {
$searchTerm = urlencode(stripslashes($_GET["search"]));
$url = "https://search.msn.com/results.aspx?q=$searchTerm&format=rss";
$xml = file_get_contents($url);
echo $xml;
}
?>
前兩行設定必要的標頭:回應型別為 XML,且不快取結果。接著用 isset() 判斷搜尋詞是否存在。
為了送出合適的請求,搜尋詞需要經過兩道過濾。stripslashes() 負責移除斜線——若 PHP 啟用了 magic quotes(舊版預設開啟),抵達 PHP 的引號會被自動加上反斜線,這個函式把它還原;接著 urlencode() 把空格、引號、& 等字元編碼成可在查詢字串中安全傳遞的形式。若省略這道手續,MSN 伺服器會直接回傳 400 Bad Request。
處理完畢後,搜尋詞被組進 URL 存入 $url,再由 file_get_contents() 開啟遠端檔案、讀回內容並印到頁面上。
安全提醒:這個寫法直接將使用者輸入轉為對外請求的目標,等同開放 SSRF。正式環境務必驗證 allow_url_fopen 的風險、限制可請求的網域,並加上抓取逾時與回應大小上限。
三、客戶端物件骨架
客戶端以一個靜態物件 msnWebSearch 為核心:
var msnWebSearch = {};
它掛在任一元素的 onclick 上觸發搜尋:
<a href="#" onclick='msnWebSearch.search(event, "Professional Ajax"); return false;'> Professional Ajax</a>
這個物件提供數個方法,負責取得結果並在頁面上繪製、定位承載結果的 HTML。它產生的結構如下:
<div class="ajaxWebSearchBox">
<div class="ajaxWebSearchHeading">MSN Search Results
<a class="ajaxWebSearchCloseLink" href="#">X</a>
</div>
<div class="ajaxWebSearchResults">
<a class="ajaxWebSearchLink" target="_new" />
<a class="ajaxWebSearchLink" target="_new" />
</div>
</div>
結果框分兩部分:標頭告知使用者這些結果來自 MSN 搜尋,右側的「X」用於關閉;結果欄則是一列列的區塊式連結,點擊會開啟新視窗。
圖 1. 結果框分為標頭與結果欄兩部分
四、用 DOM 繪製介面
由於所有元素都以 DOM 方法建立,這段程式碼看起來偏長:
msnWebSearch.drawResultBox = function(e) {
var divSearchBox = document.createElement("div");
var divHeading = document.createElement("div");
var divResultsPane = document.createElement("div");
var aCloseLink = document.createElement("a");
aCloseLink.href = "#";
aCloseLink.className = "ajaxWebSearchCloseLink";
aCloseLink.onclick = this.close;
aCloseLink.appendChild(document.createTextNode("X"));
divHeading.className = "ajaxWebSearchHeading";
divHeading.appendChild(document.createTextNode("MSN Search Results"));
divHeading.appendChild(aCloseLink);
var divLoading = document.createElement("div");
divLoading.appendChild(document.createTextNode("Loading Search Feed"));
divResultsPane.className = "ajaxWebSearchResults";
divResultsPane.appendChild(divLoading);
divSearchBox.className = "ajaxWebSearchBox";
divSearchBox.appendChild(divHeading);
divSearchBox.appendChild(divResultsPane);
document.body.appendChild(divSearchBox);
this.position(e, divSearchBox);
return divSearchBox;
};
前四行建立元素,接著設定屬性。前幾行完成關閉連結(其 onclick 指向 close()),其後幾行用文字與關閉連結填充標頭。
值得注意的是,當結果框被繪製到頁面上時,伺服器的回應通常還沒回來。為了讓使用者知道發生了什麼,這裡先塞進一個「Loading Search Feed」的提示元素,比一片空白友善得多。
圖 2. 提示資料正在載入
最後一步是定位。位置計算需要兩種資訊:
msnWebSearch.position = function(e, divSearchBox) {
var x = e.clientX + document.documentElement.scrollLeft;
var y = e.clientY + document.documentElement.scrollTop;
divSearchBox.style.left = x + "px";
divSearchBox.style.top = y + "px";
};
光是 clientX/clientY 並不足夠——它們回傳的是相對於瀏覽器視窗客戶區的座標,而非頁面中的實際位置。加上文件元素的 scrollLeft/scrollTop 之後,才能在使用者點擊的位置準確放下結果框。
五、填入搜尋結果
populateResults() 負責用實際結果取代載入提示。它接受結果容器與一個 XParser 物件(一個以 JavaScript 撰寫的 RSS 讀取器):
msnWebSearch.populateResults = function(divResultsPane, oParser) {
var oFragment = document.createDocumentFragment();
divResultsPane.removeChild(divResultsPane.firstChild);
for (var i = 0; i < oParser.items.length; i++) {
var oItem = oParser.items[i];
var aResultLink = document.createElement("a");
aResultLink.href = oItem.link.value;
aResultLink.className = "ajaxWebSearchLink";
aResultLink.target = "_new";
aResultLink.appendChild(document.createTextNode(oItem.title.value));
oFragment.appendChild(aResultLink);
}
divResultsPane.appendChild(oFragment);
};
這裡有個值得學的細節:連結先加進 documentFragment,迴圈結束後才一次掛上文件。相對於在迴圈中直接操作 DOM,這能避免每插入一個節點就觸發一次版面重排。第二行則移除先前放入的載入提示。
六、關閉結果框
msnWebSearch.close = function() {
var divSearchBox = this.parentNode.parentNode;
document.body.removeChild(divSearchBox);
return false;
};
所謂「關閉」其實是把它從文件中移除。第一行透過父節點的父節點取得整個結果框——因為 close() 是掛在連結的 onclick 上,this 指向該連結。最後回傳 false,阻止瀏覽器執行連結的預設行為。
七、搜尋介面
msnWebSearch.search = function(e, sSearchTerm) {
var divSearchBox = this.drawResultBox(e);
var url = encodeURI("websearch.php?search=" + sSearchTerm);
var oParser = new XParser(url);
oParser.onload = function() {
msnWebSearch.populateResults(divSearchBox.childNodes[1], oParser);
};
};
第一行繪製結果框並傳入事件物件,第二行編碼 URL,接著交給 XParser 建構子建立解析器。當 feed 載入完成,onload 事件處理器呼叫 populateResults() 填入結果。這麼做的動機之一,正是為了讓這個搜尋框的外觀能融入你自己的網站。
八、用 CSS 自訂外觀
有了完整的 class 結構,樣式化就只是寫 CSS 的事,日後改版也不必動 JavaScript。
.ajaxWebSearchBox {
position: absolute; /* 唯一必要的屬性,因為要定位 */
background-color: #0d1e4a;
width: 500px;
padding: 1px; /* 形成 1px 的外框 */
}
.ajaxWebSearchHeading {
position: relative; /* 供關閉連結以絕對定位對齊 */
background-color: #1162cc;
font: bold 14px tahoma;
height: 21px;
color: white;
padding: 3px 0 0 2px;
}
a.ajaxWebSearchCloseLink {
position: absolute;
right: 5px;
top: 3px;
text-decoration: none;
color: white;
}
a:hover.ajaxWebSearchCloseLink { color: red; }
.ajaxWebSearchResults {
background-color: #d3e5fa;
padding: 5px;
}
.ajaxWebSearchResults div {
text-align: center;
font: bold 14px tahoma;
color: #0a246a;
}
a.ajaxWebSearchLink {
font: 12px tahoma;
padding: 2px;
display: block; /* 讓每個連結各佔一行 */
color: #0a246a;
}
a:hover.ajaxWebSearchLink { color: white; background-color: #316ac5; }
a:visited.ajaxWebSearchLink { color: purple; }
幾個設計說明:搜尋框必須是 position: absolute,標頭必須是 relative(才能成為關閉連結的定位基準);關閉連結用絕對定位釘在右上角,滑過時變紅;結果連結用 display: block 讓每筆結果各佔一行,並靠 2px 內距彼此分開;最後刻意設定 :visited 的紫色,讓使用者看得出哪些結果已經點過——這是低成本的可用性改善。
九、組裝與使用
部署步驟:把 websearch.php 放到已安裝 PHP 的伺服器上,然後準備一個 HTML 檔,依序載入 CSS 與三支 JavaScript(zXML.js 提供跨瀏覽器的 XML 物件、xparser.js 負責解析 RSS、websearch.js 是我們的搜尋物件):
<link rel="stylesheet" type="text/css" href="css/websearch.css" /> <script type="text/javascript" src="js/zxml.js"></script> <script type="text/javascript" src="js/xparser.js"></script> <script type="text/javascript" src="js/websearch.js"></script>
要觸發搜尋,把 msnWebSearch.search() 設為元素的 onclick 即可:
<a href="#" onclick='msnWebSearch.search(event, "\"Professional Ajax\""); return false;'>Search for "Professional Ajax"</a> <a href="#" onclick='msnWebSearch.search(event, "Professional Ajax"); return false;'>Search for Professional Ajax</a>
第一個連結搜尋精確詞組,第二個則搜尋其中的各個單字。onclick 中的 return false 迫使瀏覽器忽略 href 屬性。點擊後,搜尋框會在游標位置展開,結果就顯示在原處。
十、這套設計的取捨
把搜尋結果留在原頁面,好處是使用者不中斷閱讀;代價則是三件必須正視的事。第一,MSN 的 RSS 搜尋端點早已停止服務,本文的價值在於「以伺服器端腳本代理第三方 feed,再用 DOM 即時渲染」這個模式——把它替換成任何有 RSS/JSON 端點的服務即可沿用。第二,舊寫法大量使用 innerHTML 與字串拼接,在搜尋結果標題含特殊字元時會破壞結構,請改用 textContent 或建立元素的方式。第三,第三方結果直接渲染在使用者頁面上等於信任對方不會注入程式碼,正式環境應過濾或轉義所有外部內容,並為請求加上逾時與錯誤處理。