DIV CSS 佈局教程網

Bing API 入門:用 jQuery 打造簡易搜尋引擎
編輯:關於JavaScript     

微軟於六月正式發表了 Live 搜尋的繼承者 Bing,同時也提供了一套相當完整的 API。如同 Google API,透過 Bing API,Web 開發者可以把 Bing 搜尋的各項服務整合進自己的網站,從而豐富網站功能並帶來流量。本文將透過一個完整的實作範例,示範如何用 jQuery 調用 Bing API,實現一個簡單的 Web 搜尋引擎,並對 Bing API 建立基本認識。

Bing API 提供三種檢索結果資料類型:SOAP、XML、JSON。範例中透過 jQuery ajax 調用 JSON 資料類型的接口來展示資料。以下逐步說明實現過程。

準備工作

微軟透過 Bing API 站點提供了詳盡的開發文件:

  1. 訪問 Bing 開發者站點(bing.com/developers),在這裡也能找到 Bing API 在 MSDN 上的入口;
  2. 使用微軟帳戶登入(若尚未註冊,需先註冊一個);
  3. 填寫表格,取得「App ID」(調用 API 時用來驗證開發者身份)。

HTML 部分

頁面元素相當簡單,主要包含檢索入口、結果顯示區、結果描述、錯誤資訊顯示以及翻頁導航五部分:

<div class="line search-content">
    <div class="column col-threefifths">
        <h3 id="results-header"></h3>
        <p id="results-summary"></p>
        <!-- 結果顯示區域 -->
        <div id="search-result">
            <h3>搜索結果</h3>
            <!-- 結果描述,例如總共多少條、當前顯示哪些 -->
            <div id="result-aggregates" class="results"></div>
            <ul id="result-list" class="results"></ul>
            <!-- 翻頁導航 -->
            <ul id="result-navigation" class="result-navigation">
                <li id="prev">&laquo;</li>
                <li id="next">&raquo;</li>
            </ul>
        </div>
        <!-- 錯誤資訊顯示 -->
        <p id="error-list"></p>
    </div>
    <!-- 搜索入口 -->
    <div class="column last-col">
        <h3>輸入搜索詞:</h3>
        <p>
            <input id="txtQuery" type="text" title="Search Terms" />
            <button id="btnSearch" type="button" title="搜索">搜索</button>
        </p>
    </div>
</div>

定義 Bing API 參數

// 申請的 App ID,此處換成你自己的
var AppId = "AppId=YOUR_APP_ID";
// 透過使用者輸入的搜索詞獲得檢索串
var Query = "Query=";
// 指定檢索來源類型(Bing 提供網頁、影片、圖片等類型),此處為網頁
var Sources = "Sources=Web";
// 指定 API 版本
var Version = "Version=2.0";
// 指定所在地區,各地區結果不同,此處指定中國
var Market = "Market=zh-cn";
// 選項設置,此處開啟搜索結果中的搜索詞高亮
var Options = "Options=EnableHighlighting";
var WebCount = 10;  // 每頁返回條數
var WebOffset = 0;  // 當前頁碼,從 0 開始

為搜索按鈕綁定事件

$(function() {
    $('#btnSearch').click(function() {
        Search(); // 調用最關鍵的 Search 方法取資料
    });
});

核心的 Search 方法:調用 API 取得結果

$(function() {
    function Search() {
        // 獲取使用者輸入的搜索詞,並將空格替換為 "+"
        var searchTerms = $('#txtQuery').val().replace(" ", "+");
        // 將接口需要的所有參數封裝為陣列
        var arr = [AppId, Query + searchTerms, Sources, Version, Market, Options,
                   "Web.Count=" + WebCount, "Web.Offset=" + WebOffset,
                   "JsonType=callback", "JsonCallback=?"];
        // 拼裝成 URL 串,得到 Bing URL Service 的請求 URL
        var requestStr = "https://api.search.live.net/json.aspx?" + arr.join("&");
        // 透過 jQuery ajax 調用 Bing JSON 資料接口
        $.ajax({
            type: "GET",
            url: requestStr,
            dataType: "jsonp", // 指定資料類型為 jsonp
            success: function(msg) {
                SearchCompleted(msg);
            },
            error: function(msg) {
                alert("Something hasn't worked\n" + msg.d);
            }
        });
    }
});

可以看到,使用 jQuery ajax 時把資料類型指定為 jsonp。jsonp 是一種可跨域訪問的協議,透過它能繞開同源策略的限制。

結果的 UI 處理

取得資料後的介面處理主要分為顯示結果與顯示錯誤資訊兩部分:

function SearchCompleted(response) {
    // 檢查結果中的 Errors 物件,判斷是否發生錯誤
    var errors = response.SearchResponse.Errors;
    if (errors != null) {
        DisplayErrors(errors); // 發生錯誤則顯示錯誤資訊
    } else {
        DisplayResults(response); // 無錯誤則顯示結果
    }
}

顯示結果的方法因為要更新 UI,程式碼稍多,但也能從中體會 jQuery 操作 DOM 的靈活:

function DisplayResults(response) {
    // 清空結果列表、翻頁導航與結果描述
    $("#result-list").html("");
    $("#result-navigation li").filter(".nav-page").remove();
    $("#result-aggregates").children().remove();

    // 獲取結果資料
    var results = response.SearchResponse.Web.Results;

    // 描述資訊:檢索詞、當前範圍、總數
    $('#result-aggregates').prepend("<p>檢索詞:" + response.SearchResponse.Query.SearchTerms + "</p>");
    $('#result-aggregates').prepend('<p id="result-count">當前顯示 ' + StartOffset(results)
        + ' 至 ' + EndOffset(results)
        + '&nbsp;&nbsp;總共:' + parseInt(response.SearchResponse.Web.Total) + '</p>');

    // 建立結果列表
    var link = [];
    // 因開啟了高亮選項,需進行高亮匹配
    var regexBegin = new RegExp("\uE000", "g");
    var regexEnd = new RegExp("\uE001", "g");
    for (var i = 0; i < results.length; ++i) {
        link[i] = '<li><a href="' + results[i].Url + '" title="' + results[i].Title + '">'
            + results[i].Title + '</a>'
            + '<p>' + results[i].Description + '</p>'
            + '<p class="result-url">' + results[i].Url + '</p></li>';
        // 搜索詞加粗顯示
        link[i] = link[i].replace(regexBegin, "<strong>").replace(regexEnd, "</strong>");
    }
    // 在結果區顯示列表
    $("#result-list").html(link.join(''));

    // 處理導航區
    CreateNavigation(response.SearchResponse.Web.Total, results.length);
}

導航部分程式碼較為簡單,此處不再逐行貼出。此外,MSDN 的 Bing API 部分為開發者提供了非常豐富的程式碼範例,有興趣的讀者可以前往參考。

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