使用pjax處理ajax的前進後退歷史
什麼是pjax?
現在很多網站( facebook, twitter)都支援這樣的一種瀏覽方式, 當你點選一個站內的連結的時候, 不是做頁面跳轉, 而是隻是站內頁面重新整理。 這樣的使用者體驗, 比起整個頁面都閃一下來說, 好很多。 其中有一個很重要的組成部分, 這些網站的ajax重新整理是支援瀏覽器歷史的, 重新整理頁面的同時, 瀏覽器位址列位上面的地址也是會更改, 用瀏覽器的回退功能也能夠回退到上一個頁面。 那麼如果我們想要實現這樣的功能, 我們如何做呢? 我發現pjax提供了一個指令碼支援這樣的功能。 pjax專案地址在 https://github.com/defunkt/jquery-pjax
為什麼要用pjax?
pjax有好幾個好處:
-
使用者體驗提升。
頁面跳轉的時候人眼需要對整個頁面作重新識別, 重新整理部分頁面的時候, 只需要重新識別其中一塊區域。自從我在自己的網站 GuruDigger 上面採用了pjax技術後, 不由覺得訪問其他只有頁面跳轉的網站難受了許多。 同時, 由於重新整理部分頁面的時候提供了一個loading的提示, 以及在重新整理的時候舊頁面還是顯示在瀏覽器中, 使用者能夠容忍更長的頁面載入時間。
-
極大地減少頻寬消耗和伺服器消耗。
由於只是重新整理部分頁面, 大部分的請求(css/js)都不會重新獲取, 網站帶有使用者登入資訊的外框部分都不需要重新生成了。 雖然我沒有具體統計這部分的消耗, 我估計至少有40%以上的請求, 30%以上的伺服器消耗被節省了。
壞處我覺得也有:
-
IE6等歷史瀏覽器的支援
雖然我沒有實際測試, 但是由於pjax利用到了新的標準, 舊的瀏覽器相容會有問題。 不過pjax本身支援fallback, 當發現瀏覽器不支援該功能的時候, 會回到原始的頁面跳轉上面去。
-
複雜的伺服器端支援
伺服器端需要根據過來的請求, 判斷是作全頁面渲染還是部分頁面渲染, 相對來說系統複雜度增大了。 不過對於設計良好的伺服器程式碼, 支援這樣的功能不會有太大的問題。
如何使用pjax?
直接看 官方文件 就可以了。 我覺得做技術的人要養成看一手的技術資料的習慣。 有一個rails針對pjax的 gem外掛 可以直接使用。 也有 django的支援 。
pjax的原理
為了能夠處理問題, 我們需要能夠理解pjax的運作方式。 pjax的程式碼只有一個檔案: https://github.com/defunkt/jquery-pjax/blob/master/jquery.pjax.js 如果有能力, 可以自己去看一遍。 我這裡解釋一下原理。 首先, 我們在html裡面指定, 需要做pjax的連結內容是哪些, 以及點選之後需要更新的部分(放在data-pjax屬性裡面):
$('a[data-pjax]').pjax()
當載入了pjax指令碼之後, 它會攔截這些連結的事件, 然後包裝成一個ajax請求, 傳送給伺服器。
$.fn.pjax = function( container, options ) {
return this.live('click.pjax', function(event){
handleClick(event, container, options)
})
}
functionhandleClick(event, container, options) {
$.pjax($.extend({}, defaults, options))
...
event.preventDefault()
}
var pjax = $.pjax = function( options ) {
...
pjax.xhr = $.ajax(options)
}
這個請求帶有X-PJAX的HEADER標識, 伺服器在收到這樣的請求的時候, 就知道只需要渲染部分頁面返回就可以了。
xhr.setRequestHeader('X-PJAX', 'true')
xhr.setRequestHeader('X-PJAX-Container', context.selector)
pjax接受到返回的請求之後, 更新data-pjax指定的區域, 同時也會更新瀏覽器的地址。
options.success = function(data, status, xhr){
var container = extractContainer(data, xhr, options)
...
if (container.title) document.title = container.title
context.html(container.contents)
}
為了能夠支援瀏覽器的後退, 利用到了history的api, 記錄下來對應的資訊,
pjax.state = {
id: options.id || uniqueId(),
url: container.url,
container: context.selector,
fragment: options.fragment,
timeout: options.timeout
}
if (options.push || options.replace) {
window.history.replaceState(pjax.state, container.title, container.url)
}
當瀏覽器後退的時候, 攔截事件, 根據記錄的歷史資訊, 產生一個新的ajax請求。
$(window).bind('popstate', function(event){
var state = event.state
if (state && state.container) {
var container = $(state.container)
if (container.length) {
...
var options = {
id: state.id,
url: state.url,
container: container,
push: false,
fragment: state.fragment,
timeout: state.timeout,
scrollTo: false
}
if (contents) {
// pjax event is deprecated
$(document).trigger('pjax', [null, options])
container.trigger('pjax:start', [null, options])
// end.pjax event is deprecated
container.trigger('start.pjax', [null, options])
container.html(contents)
pjax.state = state
container.trigger('pjax:end', [null, options])
// end.pjax event is deprecated
container.trigger('end.pjax', [null, options])
} else {
$.pjax(options)
}
...
}
}
}
為了支援fallback, 一個是在載入的時候判斷瀏覽器是否支援history push state API:
// Is pjax supported by this browser?
$.support.pjax =
window.history && window.history.pushState && window.history.replaceState
// pushState isn't reliable on iOS until 5.
&& !navigator.userAgent.match(/((iPod|iPhone|iPad).+\bOS\s+[1-4]|WebApps\/.+CFNetwork)/)
另一個是當發現請求一段時間沒有回覆的時候(可以設定引數timeout), 直接做頁面跳轉。
options.beforeSend = function(xhr, settings){
if (settings.timeout > 0) {
timeoutTimer = setTimeout(function(){
if (fire('pjax:timeout', [xhr, options]))
xhr.abort('timeout')
}, settings.timeout)
// Clear timeout setting so jquerys internal timeout isn't invoked
settings.timeout = 0