DIV CSS 佈局教程網

用 Ajax 串接豆瓣 API 做分頁:Bootstrap 版完整實作
編輯:AJAX基礎知識     

本文示範如何直接串接豆瓣 API 取得分頁結果,效果等同於向自己的後端資料庫查詢,差別只在於「沒辦法事先知道總頁數」。

雖然理論上可以從 API 回應中算出總頁數,但 Ajax 是非同步的,對「一開始就要先把總頁數畫出來」這件事幫助有限。因此範例先寫死一個固定總頁數 65(正好是搜尋 javascript 書籍時的結果頁數)。換成其他關鍵字時頁數會多或少,這不是 bug,而是這個教學取捨的結果。

範例的特點

全程不必碰後端,純前端就能跑起來——這類完整可運行的範例其實不太好找。介面部分使用 Bootstrap 的 pagination 做頁碼、panel 做結果面板。

完整程式碼

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title></title>
<link rel="stylesheet" href="css/bootstrap.css" /><!-- 換成自己的目錄 -->
<meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=no" />
</head>
<style>
.pagination > li > a { cursor: pointer; }
.pagination > li > span {
    margin-left: 0; color: #ccc; background-color: transparent; cursor: default;
}
.pagination > li > span:hover {
    color: #ccc; background-color: transparent; cursor: default;
}
.m20 { margin: 20px 0; }
</style>
<body>
<div class="container-fluid">
<div class="col-md-12">

  <div class="panel panel-default">
    <div class="panel-heading">
      <form class="input-group">
        <input type="text" value="javascript" class="form-control" id="bookName"
               placeholder="請輸入書名" required="required"/>
        <span class="input-group-btn">
          <button class="btn" id="search">搜索</button>
        </span>
      </form>
    </div>
    <div class="panel-body">
      <table class="table table-bordered">
        <thead>
        <th>書名</th>
        <th>作者</th>
        <th>出版日期</th>
        <th>平均分</th>
        <th>價格</th>
        </thead>
        <tbody id="tbody"></tbody>
      </table>
    </div>
  </div>

  <div class="row">
    <div class="col-md-6">
      <div id="test"></div>
    </div>
    <div class="col-md-4">
      <div class="input-group m20"><!-- 保持與 #test 中的 .pagination 對齊 -->
        <input type="text" class="form-control" id="page"/>
        <span class="input-group-btn">
          <button class="btn btn-default" id="jumpToPage">GO</button>
        </span>
      </div>
    </div>
  </div>

  <div id="result" class="alert alert-info"></div>
</div>
</div>

<script type="text/javascript" src="js/jquery-1.11.2.min.js"></script><!-- 換成自己的目錄 -->
<script type="text/javascript" src="js/bootstrap.js"></script><!-- 換成自己的目錄 -->
<script type="text/javascript">
var partPageModule = (function ($) {
    var initPager = null,   // 初始化分頁
        setPagerHTML = null,// 產生分頁 HTML
        pageClick = null,   // 頁碼點擊事件
        ajax = null,        // 向後端請求資料
        renderButton = null,
        $content = $('');   // 動態產生的頁碼

    /* 初始化
     * @totalPages   總頁數
     * @currentPage  當前頁數
     */
    initPager = function (totalPages, currentPage) {
        $content = setPagerHTML({
            currentPage: currentPage,
            totalPages: totalPages,
            pageClick: PageClick
        });
        $('#test').empty().append($content);

        $('#jumpToPage').click(function (e) {
            e.preventDefault();
            PageClick(totalPages, $('#page').val() * 1);
        });

        $('#page').keyup(function (e) {
            if (e.keyCode === 13) {          // Enter 鍵等同按 GO
                $('#jumpToPage').trigger('click');
            }
        });

        $('#result').html('你點擊的是第' + currentPage + '頁');
    };

    /* 頁碼點擊:重新產生頁碼並抓資料 */
    PageClick = function (totalPages, currentPage) {
        initPager(totalPages, currentPage);
        ajax(currentPage);
    };

    ajax = function (currentPage) {
        var $input = $('#bookName'), bookName = '', $tbody = $('#tbody');
        bookName = $input.val();
        if (!bookName) {                 // 沒輸入就不請求
            $input.focus();
            return;
        }
        $.ajax({
            type: 'get',
            url: 'https://api.douban.com/v2/book/search',   // 豆瓣圖書 API
            dataType: 'jsonp',
            data: {
                q: bookName,
                start: (parseInt(currentPage) - 1) * 20 || 0
            },
            success: function (data) {
                var html = '', books = data.books;
                books.forEach(function (value, index) {
                    html += '<tr>'
                        + '<td><a href="' + value.alt + '">' + value.title + '</a></td>'
                        + '<td>' + value.author + '</td>'
                        + '<td>' + value.pubdate + '</td>'
                        + '<td>' + value.rating.average + '</td>'
                        + '<td>' + value.price + '</td>'
                        + '</tr>';
                });
                $tbody.html(html);
            }
        });
    };

    setPagerHTML = function (options) {
        var currentPage = options.currentPage,
            totalPages = options.totalPages,
            pageClick = options.pageClick,
            $content = $('<ul class="pagination"></ul>'),
            startPage = 1,
            nextPage = currentPage + 1,   // 後面有條件判斷,不必擔心超出
            prevPage = currentPage - 1;

        /* 上一頁 / 首頁 */
        if (currentPage == startPage) {
            $content.append('<li><span>首頁</span></li>');
            $content.append('<li><span>上一頁</span></li>');
        } else {
            $content.append(renderButton(totalPages, 1, pageClick, '首頁'));
            $content.append(renderButton(totalPages, prevPage, pageClick, '上一頁'));
        }

        /* 頁碼區:依「總頁數」與「當前位置」分四種情況處理 */
        if (totalPages <= 5 && currentPage <= 5) {
            // 總頁數少,全部列出
            for (var i = 1; i <= totalPages; i++) {
                if (i === currentPage) {
                    $content.append('<li class="active"><span>' + i + '</span></li>');
                } else {
                    $content.append(renderButton(totalPages, i, pageClick, i));
                }
            }
        } else if (totalPages > 5 && totalPages - currentPage <= 2) {
            // 接近尾頁:前面省略,後面列到最後
            $content.append('<li><span>...</span></li>');
            for (var i = totalPages - 4; i <= totalPages; i++) {
                if (i === currentPage) {
                    $content.append('<li class="active"><span>' + i + '</span></li>');
                } else {
                    $content.append(renderButton(totalPages, i, pageClick, i));
                }
            }
        } else if (totalPages > 5 && currentPage > 3) {
            // 位於中段:前後都顯示省略號
            $content.append('<li><span>...</span></li>');
            for (var i = currentPage - 2; i < currentPage + 2; i++) {
                if (i === currentPage) {
                    $content.append('<li class="active"><span>' + i + '</span></li>');
                } else {
                    $content.append(renderButton(totalPages, i, pageClick, i));
                }
            }
            $content.append('<li><span>...</span></li>');
        } else if (totalPages > 5 && currentPage <= 3) {
            // 接近首頁:前面列出,後面省略
            for (var i = 1; i <= 5; i++) {
                if (i === currentPage) {
                    $content.append('<li class="active"><span>' + i + '</span></li>');
                } else {
                    $content.append(renderButton(totalPages, i, pageClick, i));
                }
            }
            $content.append('<li><span>...</span></li>');
        }

        /* 下一頁 / 末頁 */
        if (currentPage == totalPages) {
            $content.append('<li><span>下一頁</span></li>');
            $content.append('<li><span>末頁</span></li>');
        } else {
            $content.append(renderButton(totalPages, nextPage, pageClick, '下一頁'));
            $content.append(renderButton(totalPages, totalPages, pageClick, '末頁'));
        }
        return $content;
    };

    renderButton = function (totalPages, goPageIndex, eventHander, text) {
        var $gotoPage = $('<li><a title="第' + goPageIndex + '頁">' + text + '</a></li>');
        $gotoPage.click(function () {
            eventHander(totalPages, goPageIndex);
        });
        return $gotoPage;
    };

    return { init: initPager, ajax: ajax };
}(jQuery));

$(function () {
    $('#search').click(function (e) {
        e.preventDefault();
        // 由於 Ajax 非同步,這裡拿不到真實總頁數,先給 65
        var totalPage = partPageModule.ajax(1) || 65;
        partPageModule.init(totalPage, 1);
    });

    $('#bookName').keyup(function (e) {
        if (e.keyCode === 13) {
            $('#search').trigger('click');
        }
    });

    $('#search').trigger('click');
});
</script>
</body>
</html>
<!-- https://api.douban.com/v2/book/search
     參數    意義              備註
     q      查詢關鍵字          q 和 tag 必傳其一
     tag    查詢的 tag         q 和 tag 必傳其一
     start  取結果的 offset     預設 0
     count  取結果的條數       預設 20,最大 100
-->

邏輯拆解

整個模組用 IIFE 封裝,對外只暴露 init 與 ajax 兩個方法,避免全域污染。setPagerHTML 依「總頁數」與「目前位置」分四種情況決定要畫哪些頁碼,renderButton 負責產生可點擊的按鈕並綁定事件。

頁碼的點擊流程是:PageClick → 重新呼叫 initPager 重畫整排頁碼 → 再呼叫 ajax 抓該頁資料。重畫而非局部更新的理由是:頁碼的樣式(哪些該變灰、哪些該顯示省略號)會隨目前位置改變,整排重畫最單純。

參考與觀看效果

頁碼的邏輯處理部分參考並修改自 這篇討論。

線上展示:檢視範例頁面

兩個實務提醒

關於 jsonp 與安全性。範例用 dataType: 'jsonp' 繞過跨域限制,這在跨來源情境下是常見做法,但要注意 JSONP 本質上是「執行對方回傳的 JavaScript」,因此前提是你能信任該來源。另外,範例把 API 回傳的 value.title 等欄位直接串進 HTML,若資料中含 HTML 特殊字元就會破壞結構,正式環境請改用 textContent 或先做轉义。

關於寫死 65 頁。這是教學上的妥協。真實專案應該由後端回傳總數,或者採取「無限捲動/載入更多」的模式,就不必預先知道總頁數了。若堅持用頁碼,也可以在第一次請求回來後才把真實總頁數補上重畫一次。

另外提醒,豆瓣的公開 API 後續有過變動與權限調整,實際串接前請先確認該端點目前是否仍開放使用。

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