DIV CSS 佈局教程網

用 JavaScript 呼叫 Yahoo! Search API 打造自己的搜尋功能
編輯:關於JavaScript     

當年雅虎把搜尋能力開放成 Web 服務,做法是提供一個開發者網路(Yahoo! Search Developer Network),讓開發者在雅虎搜尋之上搭建自己的應用,涵蓋網頁、圖片、影片、新聞與地區搜尋等類型。使用方式很簡單:先到申請頁取得一組自己的 application ID,之後所有請求都帶著這個 ID 呼叫即可(當時每組 ID 每天有 5000 次的呼叫上限)。

把服務位址與參數集中管理

整支腳本用一個建構函數 Yahoo_Search 搭配多個靜態方法來組織,好處是端點、身分識別與參數組裝各自獨立,日後換 API 版本只改一處。

function Yahoo_Search() {}

Yahoo_Search.baseURL = function () {
  return "https://api.search.yahoo.com/WebSearchService/V1/";
}

Yahoo_Search.appid = function () {
  return "YOUR_APP_ID";   // 換成自己申請的 ID
}

Yahoo_Search.baseArgs = function () {
  return "appid=" + this.appid();
}

組出查詢字串並送出請求

Results 方法接受一個參數物件,從中取出關鍵字(Doc)、起始位置(First)與回傳筆數(Count),拼成查詢字串後以同步 XMLHttpRequest 送出,再把回應的 XML 交給 readXML 解析。

Yahoo_Search.Results = function (args) {
  var xmlUrl = this.baseURL() + "webSearch?"
             + this.baseArgs()
             + "&query="   + args["Doc"]
             + "&zip="
             + "&start="   + args["First"]
             + "&results=" + args["Count"];

  var xmlhttp = new XMLHttpRequest();
  xmlhttp.open("GET", xmlUrl, false);
  xmlhttp.send(null);
  return this.readXML(xmlhttp.responseXML);
}

解析回傳的 XML

回應結構以 <ResultSet> 為根節點,上面帶有三個重要屬性:可用結果總數、本次回傳筆數、以及起始位置。有了這三個值,就能算出分頁區間並渲染頁碼。

Yahoo_Search.readXML = function (xmlDoc) {
  try {
    var retVal = new Array();
    var resultSet = xmlDoc.getElementsByTagName("ResultSet")[0];

    var totalResultsAvailable = parseInt(resultSet.getAttribute("totalResultsAvailable"));
    var totalResultsReturned  = parseInt(resultSet.getAttribute("totalResultsReturned"));
    var firstResultPosition   = parseInt(resultSet.getAttribute("firstResultPosition"));

    var start = firstResultPosition;
    var end   = firstResultPosition + totalResultsReturned - 1;

    var results = xmlDoc.getElementsByTagName("Result");
    for (var i = 0; i < results.length; i++) {
      var result  = results[i];
      var title   = result.getElementsByTagName('Title')[0].firstChild.nodeValue;
      var summary = '';
      if (result.getElementsByTagName('Summary')[0].firstChild) {
        summary = result.getElementsByTagName('Summary')[0].firstChild.nodeValue;
      }
      var url = result.getElementsByTagName('ClickUrl')[0].firstChild.nodeValue;

      retVal[i] = { title: title, url: url, summary: summary };
    }
    return retVal;
  } catch (e) {
    return null;
  }
}

幾個實務上的提醒

第一,範例使用同步請求(open 的第三個參數為 false),它會凍結整個 UI 直到回應到來;實務上應改成非同步並搭配 onload 回呼。第二,用字串拼接查詢參數時,關鍵字必須先經過 encodeURIComponent 編碼,否則含 &、= 或中文的輸入會讓參數被拆錯。第三,AppID 這種憑證一旦寫在前端就是公開的,正式環境應該由自己的伺服器代理轉發,避免被盜用而爆掉配額。

最後要補一句背景:這套 V1 端點早已停止服務,雅虎後續把搜尋服務交給了 YQL 與其他合作方案。上面這份程式今日的價值,在於示範「用 Uncertainty 的 XML 回應 + 屬性-driven 分頁資訊」該怎麼組裝,同樣的思維套到任何回傳 XML 的搜尋 API 上都成立。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved