一文带你了解Pjax

pjax介绍

现在很多网站(facebook, twitter)都支持这样的一种浏览方式，当你点击一个站内的链接的时候，不是做页面跳转，而是只是站内页面刷新。这样的用户体验，比起整个页面都闪一下来说好很多。

其中有一个很重要的组成部分，这些网站的ajax刷新是支持浏览器历史的，刷新页面的同时，浏览器地址栏位上面的地址也是会更改，用浏览器的回退功能也能够回退到上一个页面

那么如果我们想要实现这样的功能，我们如何做呢？

简单来说，pushState + ajax = pjax

ajax 在 2005 年被 Jesse James Garrett 提出，如今已不是一个新鲜技术了。

AJAX = Asynchronous JavaScript and XML（异步的JavaScript 和XML）。 AJAX 不是新的编程语言，而是一种使用现有标准的新方法。 AJAX 最大的优点是在不重新加载整个页面的情况下，可以与服务器交换数据并更新部分网页内容。

传统的 ajax 也可以异步无刷新动态加载内容，但在页面 URL 切换上不能自然处理，通过 URL hash 的处理方式则不能很好的适配浏览器的前进、后退，实现效果并不理想。

pjax使用了pushState来改变地址栏的url，这是html5中history的新特性。

在 HTML 文档中，history.pushState() 方法向当前浏览器会话的历史堆栈中添加一个状态（state）。

使用语法 history.pushState(state, title[, url])，详见MDN Web Docs。

pjax原理介绍

pjax的基本思路是，在用户点击一个链接后，通过ajax从服务器获取其HTML，然后用得到的HTML替换页面上指定的部分容器元素的内容，避免了全局刷新。然后，它使用pushState更新浏览器的URL。

pjax的优点

• 减轻服务端压力

每次只需动态加载页面的部分内容，减少了资源文件的传输，也避免了固定页面结构的重复渲染，由此减轻对服务器的带宽压力，有利于页面加载速度的提升。

由于只是刷新部分页面，大部分的请求（css/js）都不会重新获取，网站带有用户登录信息的外框部分都不需要重新生成了。

• 优化页面跳转体验

使用pjax后，只需要动态刷新部分页面，避免了传统的页面跳转方式，切换效果更加流畅自然，同时也减轻了浏览器的渲染压力，有利于提升等待时的用户体验。

页面跳转的时候人眼需要对整个页面作重新识别，刷新部分页面的时候，只需要重新识别其中一块区域。同时，由于刷新部分页面的时候提供了一个loading的提示，以及在刷新的时候旧页面还是显示在浏览器中，用户能够容忍更长的页面加载时间。

pjax的缺点

由于pjax利用到了新的标准，旧的浏览器兼容会有问题。不过pjax本身支持fallback，当发现浏览器不支持该功能的时候，会回到原始的页面跳转上面去。

复杂的服务器端支持，服务器端需要根据过来的请求，判断是作全页面渲染还是部分页面渲染，相对来说系统复杂度增大了。不过对于设计良好的服务器代码，支持这样的功能不会有太大的问题。

pjax现有实现方案

推荐以下两个pjax的实现 (目前均停止更新)，第二个是jQuery插件，依赖于jQuery。

https://github.com/MoOx/pjax （https://github.com/PaperStrike/Pjax 为其重构版本）
https://github.com/defunkt/jquery-pjax

jquery-pjax 实现原理

首先，我们在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)
  })
}

function handleClick(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 pushstate 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