pushstate replacestate popstate

一. 概述

window.history属性指向 History 对象，它表示当前窗口的浏览历史。
History 对象保存了当前窗口访问过的所有页面网址。下面代码表示当前窗口一共访问过3个网址。

window.history.length // 3
1

由于安全原因，浏览器不允许脚本读取这些地址，但是允许在地址之间导航。

// 后退到前一个网址
history.back()

// 等同于
history.go(-1)

1
2
3
4
5
6

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

二. history 中两个重要属性

• History.length：当前窗口访问过的网址数量（包括当前网页）
• History.state：History 堆栈最上层的状态值（也就是后文中pushState，replaceState设置的state值。）

三. history.pushState(state, title, url)

将当前URL和history.state加入到history中，并用新的state和URL替换当前。不会造成页面刷新。

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

• state：一个与添加的记录相关联的状态对象，主要用于popstate事件。该事件触发时，该对象会传入回调函数。也就是说，浏览器会将这个对象序列化以后保留在本地，重新载入这个页面的时候，可以拿到这个对象。如果不需要这个对象，此处可以填null。

• title：新页面的标题。但是，现在所有浏览器都忽视这个参数，所以这里可以填空字符串。

• url：新的网址，必须与当前页面处在同一个域。浏览器的地址栏将显示这个网址。不能跨域。

四. history.replaceState(state, title, url)

代替当前url的所有信息，不会造成页面的刷新

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

(和上面pushState参数含义一样)

• state：一个与添加的记录相关联的状态对象，主要用于popstate事件。该事件触发时，该对象会传入回调函数。也就是说，浏览器会将这个对象序列化以后保留在本地，重新载入这个页面的时候，可以拿到这个对象。如果不需要这个对象，此处可以填null。

• title：新页面的标题。但是，现在所有浏览器都忽视这个参数，所以这里可以填空字符串。

• url：新的网址，必须与当前页面处在同一个域。浏览器的地址栏将显示这个网址。不能跨域。

五.pushState 和 replaceState对比

总结：

• pushState()方法是在历史记录中增加一条新的记录；
• replaceState()方法是将当前的历史记录给替换掉，传说中的夺舍重生！
• 两者都不会触发hashchange和popstate事件
• 两者都不会造成页面的刷新
• 两者都不能跨域，跨域后直接报错。（这样设计的目的是，防止恶意代码让用户以为他们是在另一个网站上，因为这个方法不会导致页面跳转。）
• url参数不同的地址的结果
  例如网页的地址为https://www.jianshu.com/2/1

六. popstate事件

每当同一个文档的浏览历史（即history对象）出现变化时，就会触发popstate事件。
注意，仅仅调用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));
});

1
2
3
4
5
6
7
8
9
10
11

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

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

var currentState = history.state;

1
2

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

7. vue-router 的基本实现

从pushState 和 replaceState 联想到，vue-router就是用这两个html5新增api实现的，这样history模式修改了url，但浏览器不会立即向后端发送请求。如果要做到改变url但又不刷新页面的效果，就需要前端用上这两个API。

8. 使用时遇到和它们相关的问题

8.1 micro-app - angular13 中使用 NG-ZORRO 的抽屉 Drawer组件

使用虚拟路由的时候，angular 13的drawer 组件监听 popstate 的变化，会清空drawer内容，造成的问题。