DIV CSS 佈局教程網

用 jQuery + JSONP 實作搜尋框即時提示:從同源策略到跨域的完整記錄
編輯:JQuery入門技巧     

原本只是想模仿 Bing 做一個搜尋首頁,順手加上「打字就有建議關鍵字」的效果。結果卡在跨域這個老問題上折騰了好幾天,也正好把 JSONP 這件事徹底弄明白了。本文就把整個過程完整記錄下來。

先做出畫面

HTML 結構:

<div class="bg-div">
  <div class="search-box">
    <div class="logo"></div>
    <form id="search-form">
      <input type="text" class="search-input-text" autocomplete="off" name="q" id="search_input" />
      <input type="submit" class="search-input-button" value="" id="search_submit">
    </form>
  </div>
</div>

<div class="suggest" id="search-suggest">
  <ul id="search-result">
    <li>搜尋結果1</li>
    <li>搜尋結果2</li>
  </ul>
</div>

CSS 部分要注意的是:.search-box 用絕對定位擺在畫面中央偏上的位置,而 #search-suggest 預設 display: none,需要時才由 JS 顯示。

* { padding: 0; margin: 0; }

.bg-div{
  background-image: url('images/river.jpg');
  width: 1228px; height: 690px; margin: 0 auto; position: relative;
}
.logo {
  background-image: url('images/logo.png');
  width: 107px; height: 53px; float: left; margin: -4px 18px 0 0;
}
form { float: left; background-color: #fff; padding: 5px; }
.search-input-text {
  border: 0; float: left; height: 25px; line-height: 25px;
  outline: none; width: 350px; font-size: 16px;
}
.search-input-button {
  border: 0; background-image: url('images/search-button.png');
  width: 29px; height: 29px; float: left;
}
.search-box { position: absolute; top: 200px; left: 300px; }

#search-suggest {
  width: 388px; background-color: #fff;
  border: 1px solid #999; display: none;
}
.suggest ul { list-style: none; }
.suggest ul li {
  padding: 3px; font-size: 14px; line-height: 25px;
  cursor: pointer;   /* 滑鼠移上去變手型 */
}
.suggest ul li:hover { text-decoration: underline; background-color: #e5e5e5; }

這時畫面已經有了,但在搜尋框打字不會有任何反應。接下來才是我們真正想解決的問題。

思考一:如何讓打字時就顯示提示

思路是監聽鍵盤事件,然後動態計算提示層的位置並顯示出來。

$(function () {
    $("#search_input").bind("keyup", function () {
        $("#search-suggest").show().css({
            top:  $("#search-form").offset().top + $("#search-form").height() + 10,
            left: $("#search-form").offset().left,
            position: "absolute"
        });
    });
});

位置用 offset() 動態算,這樣搜尋框放在哪裡都不怕。

思考二:點擊某個提示要能跳轉

提示項目是動態產生的,所以要用事件委派:

$(document).delegate("li", "click", function () {
    var keyword = $(this).text();
    location.href = "https://cn.bing.com/search?q=" + keyword;
});

思考三:資料從哪來?撞上了同源策略

最直覺的寫法是用 $.get() 去抓搜尋建議 API:

var searchText = $("#search_input").val();
$.get("https://api.bing.com/qsonhs.aspx?q=" + searchText, function (data) {
    var d = data.AS.Results[0].Suggests;
    var html = "";
    for (var i = 0; i < d.length; i++) {
        html += "<li>" + d[i].Txt + "</li>";
    }
    $("#search-result").html(html);
}, "json");

結果完全沒反應。找了半天,才意識到問題根本不在語法——而是同源策略。

關於 JSONP

瀏覽器基於安全考量,預設不允許 A 網域的頁面去讀取 B 網域回傳的資料。但這條規則有一個著名的例外:<script> 標籤。無論 src 指向哪個網域,script 標籤都會老實把內容載入並執行。

JSONP(JSON with Padding)就是利用這個漏洞的優雅用法:請求的 bukan 純 JSON,而是一段包裹在你指定函式名稱裡的 JavaScript。伺服器回傳 myCallback({...}),瀏覽器執行它,你的函式就拿到了資料。它不是被 JSON 解析器處理,而是被 JS 引擎直接執行。

jQuery 把它包得很好:

$.ajax({
    type: "get",
    async: false,
    url: "https://flightQuery.com/jsonp/flightResult.aspx?code=CA1998",
    dataType: "jsonp",
    jsonp: "callback",        // 告訴伺服器回呼參數名叫什麼
    jsonpCallback: "flightHandler",  // 自訂回呼函式名稱;寫 "?" 則由 jQuery 自動產生
    success: function (json) {
        alert(json.price + json.tickets + ' 張。');
    },
    error: function () { alert('fail'); }
});

改寫我們自己的程式

$.ajax({
    type: "GET",
    url: "https://api.bing.com/qsonhs.aspx?type=cb&q=" + searchText,
    dataType: "jsonp",
    jsonp: 'cb',
    success: function (data) {
        var d = data.AS.Results[0].Suggests;
        var html = "";
        for (var i = 0; i < d.length; i++) {
            html += "<li>" + d[i].Txt + "</li>";
        }
        $("#search-result").html(html);
        $("#search-suggest").show().css({
            top:  $("#search-form").offset().top + $("#search-form").height() + 10,
            left: $("#search-form").offset().left,
            position: "absolute"
        });
    }
});

這次就通了。關鍵只在 dataType: "jsonp" 加上正確的 jsonp 參數名。

把防禦寫好:資料可能不存在

使用者亂打字時,API 回傳的結構可能不完整,直接取 data.AS.Results[0] 會丟出 TypeError。逐層檢查雖然囉嗦,但很有效:

if (data == null)                        { $("#search-suggest").hide(); return false; }
if (data.AS == null)                     { $("#search-suggest").hide(); return false; }
if (data.AS.Results == null)             { $("#search-suggest").hide(); return false; }
if (data.AS.Results[0] == null)          { $("#search-suggest").hide(); return false; }
if (data.AS.Results[0].Suggests == null) { $("#search-suggest").hide(); return false; }

如果不想寫五次,可以用「取值失敗就回傳空陣列」的技巧:

var list = (((data || {}).AS || {}).Results || [{}])[0].Suggests || [];
if (list.length === 0) { $("#search-suggest").hide(); return; }

最後補上表單提交

$("#search-form").submit(function () {
    var keyword = $("#search_input").val();
    location.href = "https://cn.bing.com/search?q=" + keyword;
});

原始碼已放在線上執行環境:https://sandbox.runjs.cn/show/gfdpkysk,點開即可看到實際跑起來的樣子。

幾點回頭看才懂的提醒

JSONP 本質上是 <script> 載入,只能發 GET。需要 POST 的場景它無能為力,這時候只能回到後端做代理轉發。

JSONP 有一定的安全風險。因為執目的是對方回傳的任意 JavaScript,等於你把執行權交給了那個網域。只對可信的來源使用。

現在的首選是 CORS。如果後端可以設定 Access-Control-Allow-Origin 標頭,直接用 fetch() 或 $.ajax() 就能跨域,比 JSONP 乾淨安全得多。JSONP 只在「對方不給你 CORS、但願意提供 callback 參數」時才是唯一解。

折騰幾天最大的收穫,其實不是做出了一個搜尋框,而是終於把「瀏覽器為什麼不讓我這樣抓資料」這件事背後的原因想清楚了。

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