Skip to main content

History 路由

window.history 表示当前窗口的浏览历史。

属性​

history.length​

当前窗口访问过的网址数量（包括当前网页）

// 当前窗口访问过多少个网页
window.history.length; // 1

history.state​

history 堆栈最上层的状态值。

// history 对象的当前状态
// 通常是 undefined，即未设置
window.history.state; // undefined

方法​

history.back()、history.forward()、history.go()​

由于安全原因，浏览器不允许脚本读取这些地址，但是允许在地址之间导航。这三个方法用于在历史之中移动。

  • history.back()：移动到上一个网址，等同于点击浏览器的后退键。对于第一个访问的网址，该方法无效果。
  • history.forward()：移动到下一个网址，等同于点击浏览器的前进键。对于最后一个访问的网址，该方法无效果。
  • history.go()：接受一个整数作为参数，以当前网址为基准，移动到参数指定的网址，比如go(1)相当于forward()，go(-1)相当于back()。如果参数超过实际存在的网址范围，该方法无效果；如果不指定参数，默认参数为0，相当于刷新当前页面。

浏览器工具栏的“前进”和“后退”按钮，其实就是对 history 对象进行操作。

history.back();
history.forward();
history.go(-2);

history.go(0)相当于刷新当前页面。

history.go(0); // 刷新当前页面

注意，移动到以前访问过的页面时，页面通常是从浏览器缓存之中加载，而不是重新要求服务器发送新的网页。

history.pushState()​

history.pushState()方法用于在历史中添加一条记录。

window.history.pushState(state, title, url);

该方法接受三个参数，依次为：

  • state：一个与添加的记录相关联的状态对象，主要用于popstate事件。该事件触发时，该对象会传入回调函数。也就是说，浏览器会将这个对象序列化以后保留在本地，重新载入这个页面的时候，可以拿到这个对象。如果不需要这个对象，此处可以填null。
  • title：新页面的标题。但是，现在所有浏览器都忽视这个参数，所以这里可以填空字符串。
  • url：新的网址，必须与当前页面处在同一个域。浏览器的地址栏将显示这个网址。

假定当前网址是example.com/1.html，使用pushState()方法在浏览记录（history 对象）中添加一个新记录。

var stateObj = {foo: 'bar'};
history.pushState(stateObj, 'page 2', '2.html');

添加新记录后，浏览器地址栏立刻显示example.com/2.html，但并不会跳转到2.html，甚至也不会检查2.html是否存在，它只是成为浏览历史中的最新记录。这时，在地址栏输入一个新的地址(比如访问google.com)，然后点击了倒退按钮，页面的 URL 将显示2.html；你再点击一次倒退按钮，URL 将显示1.html。

总之，pushState()方法不会触发页面刷新，只是导致 history 对象发生变化，地址栏会有反应。

使用该方法之后，就可以用history.state属性读出状态对象。

var stateObj = {foo: 'bar'};
history.pushState(stateObj, 'page 2', '2.html');
history.state; // {foo: "bar"}

如果pushState的 URL 参数设置了一个新的锚点值（即hash），并不会触发hashchange事件。反过来，如果 URL 的锚点值变了，则会在 history 对象创建一条浏览记录。

如果pushState()方法设置了一个跨域网址，则会报错。

// 报错
// 当前网址为 http://example.com
history.pushState(null, '', 'https://twitter.com/hello');

上面代码中，pushState想要插入一个跨域的网址，导致报错。这样设计的目的是，防止恶意代码让用户以为他们是在另一个网站上，因为这个方法不会导致页面跳转。

history.replaceState()​

history.replaceState()方法用来修改 history 对象的当前记录，其他都与pushState()方法一模一样。

假定当前网页是example.com/example.html。

history.pushState({page: 1}, 'title 1', '?page=1');
// URL 显示为 http://example.com/example.html?page=1

history.pushState({page: 2}, 'title 2', '?page=2');
// URL 显示为 http://example.com/example.html?page=2

history.replaceState({page: 3}, 'title 3', '?page=3');
// URL 显示为 http://example.com/example.html?page=3

history.back();
// URL 显示为 http://example.com/example.html?page=1

history.back();
// URL 显示为 http://example.com/example.html

history.go(2);
// URL 显示为 http://example.com/example.html?page=3

popstate 事件​

每当同一个文档的浏览历史（即history对象）出现变化时，就会触发popstate事件。

caution

仅仅调用pushState()方法或replaceState()方法 ，并不会触发该事件，只有用户点击浏览器倒退按钮和前进按钮，或者使用 JavaScript 调用history.back()、history.forward()、history.go()方法时才会触发。

另外，该事件只针对同一个文档，如果浏览历史的切换，导致加载不同的文档，该事件也不会触发。

使用的时候，可以为popstate事件指定回调函数。

window.onpopstate = function (event) {
  console.log('location: ' + document.location);
  console.log('state: ' + JSON.stringify(event.state));
};

// 或者
window.addEventListener('popstate', function (event) {
  console.log('location: ' + document.location);
  console.log('state: ' + JSON.stringify(event.state));
});

回调函数的参数是一个event事件对象，它的state属性指向pushState和replaceState方法为当前 URL 所提供的状态对象（即这两个方法的第一个参数）。上面代码中的event.state，就是通过pushState和replaceState方法，为当前 URL 绑定的state对象。

这个state对象也可以直接通过history对象读取。

var currentState = history.state;
caution

页面第一次加载的时候，浏览器不会触发popstate事件。

原理​

  • history 提供了 pushState 和 replaceState 方法，这两个方法改变 URL 的 path 部分不会引起页面刷新。
  • history 提供类似 hashchange 事件的 popstate 事件。

但和 popstate 事件有些不同：通过浏览器前进后退改变 URL 时会触发 popstate 事件，通过 pushState / replaceState 或 <a> 标签改变 URL 不会触发 popstate 事件。

好在我们可以拦截 pushState / replaceState 的调用和 <a> 标签的点击事件来检测 URL 变化，所以监听 URL 变化可以实现，只是没有 hashchange 那么方便。

实现​

<body>
  <ul>
    <li><a href="/home">home</a></li>
    <li><a href="/about">about</a></li>

    <div id="routeView"></div>
  </ul>
</body>
// 页面加载完不会触发 hashchange，这里主动触发一次 hashchange 事件
window.addEventListener('DOMContentLoaded', onLoad);
// 监听路由变化
window.addEventListener('popstate', onPopState);

// 路由视图
var routerView = null;

function onLoad() {
  routerView = document.querySelector('#routeView');
  onPopState();

  // 拦截 <a> 标签点击事件默认行为， 点击时使用 pushState 修改 URL并更新手动 UI，从而实现点击链接更新 URL 和 UI 的效果。
  var linkList = document.querySelectorAll('a[href]');
  linkList.forEach(el =>
    el.addEventListener('click', function (e) {
      e.preventDefault();
      history.pushState(null, '', el.getAttribute('href'));
      onPopState();
    })
  );
}

// 路由变化时，根据路由渲染对应 UI
function onPopState() {
  switch (window.location.pathname) {
    case '/home':
      routerView.innerHTML = 'Home';
      return;
    case '/about':
      routerView.innerHTML = 'About';
      return;
    default:
      return;
  }
}

演示：https://codepen.io/ustc-han/pen/ZgOaNj

结合 React 框架的路由实现：https://github.com/whinc/web-router-principle/tree/master/react

参考资料​

  1. JavaScript 教程: History 对象，作者：阮一峰
  2. 面试官: 你了解前端路由吗?，作者：寻找海蓝 96