一、概述
浏览器窗口有一个 history
对象,用来保存浏览历史。
如果当前窗口先后访问了三个网址,那么 history
对象就包括三项,history.length
属性等于3。
1 | history.length // 3 |
history
对象提供了一系列方法,允许在浏览历史之间移动。
back():移动到上一个访问页面,等同于浏览器的后退键。
forward():移动到下一个访问页面,等同于浏览器的前进键。
go():接受一个整数作为参数,移动到该整数指定的页面,比如go(1)相当于forward(),go(-1)相当于back()。
1 | history.back(); |
如果移动的位置超出了访问历史的边界,以上三个方法并不报错,而是默默的失败。history.go(0)
相当于刷新当前页面。1
history.go(0);
常见的“返回上一页”链接,代码如下。1
2
3document.getElementById('backLink').onclick = function () {
window.history.back();
}
注意,返回上一页时,页面通常是从浏览器缓存之中加载,而不是重新要求服务器发送新的网页。
二、history.pushState()
HTML5为 history
对象添加了两个新方法,history.pushState()
和history.replaceState()
,用来在浏览历史中添加和修改记录。
1 | if (!!(window.history && history.pushState)){ |
上面代码可以用来检查,当前浏览器是否支持History API。如果不支持的话,可以考虑使用Polyfill库 History.js。
history.pushState
方法接受三个参数,依次为:
state:一个与指定网址相关的状态对象,popstate事件触发时,该对象会传入回调函数。如果不需要这个对象,此处可以填null。
title:新页面的标题,但是所有浏览器目前都忽略这个值,因此这里可以填null。
url:新的网址,必须与当前页面处在同一个域。浏览器的地址栏将显示这个网址。
假定当前网址是 example.com/1.html
,我们使用 pushState
方法在浏览记录(history
对象)中添加一个新记录。
1 | var stateObj = { foo: 'bar' }; |
添加上面这个新记录后,浏览器地址栏立刻显示 example.com/2.html
,但并不会跳转到 2.html
,甚至也不会检查 2.html
是否存在,它只是成为浏览历史中的最新记录。假定这时你访问了 google.com
,然后点击了倒退按钮,页面的url将显示 2.html
,但是内容还是原来的 1.html
。你再点击一次倒退按钮,url将显示 1.html
,内容不变。
总之,pushState
方法不会触发页面刷新,只是导致 history
对象发生变化,地址栏会有反应。
如果 pushState
的url参数,设置了一个新的锚点值(即hash
),并不会触发 hashchange
事件。如果设置了一个跨域网址,则会报错。1
history.pushState(null, null, 'https://twitter.com/hello');
上面代码中,pushState
想要插入一个跨域的网址,导致报错。这样设计的目的是,防止恶意代码让用户以为他们是在另一个网站上。
三、history.replaceState()
history.replaceState
方法的参数与 pushState
方法一模一样,区别是它修改浏览历史中当前纪录。
假定当前网页是 example.com/example.html
。
1 | history.pushState({page: 1}, 'title 1', '?page=1'); |
四、history.state属性
history.state
属性返回当前页面的 state
对象。
1 | history.pushState({page: 1}, 'title 1', '?page=1'); |
五、popstate事件
每当同一个文档的浏览历史(即 history
对象)出现变化时,就会触发 popstate
事件。
需要注意的是,仅仅调用 pushState
方法或 replaceState
方法 ,并不会触发该事件,只有用户点击浏览器倒退按钮和前进按钮,或者使用JavaScript调用 back
、forward
、go
方法时才会触发。另外,该事件只针对同一个文档,如果浏览历史的切换,导致加载不同的文档,该事件也不会触发。
使用的时候,可以为 popstate
事件指定回调函数。这个回调函数的参数是一个 event
事件对象,它的 state
属性指向 pushState
和 replaceState
方法为当前URL所提供的状态对象(即这两个方法的第一个参数)。
1 | window.onpopstate = function (event) { |
上面代码中的 event.state
,就是通过 pushState
和 replaceState
方法,为当前URL绑定的 state
对象。
这个 state
对象也可以直接通过 history
对象读取。
1 | var currentState = history.state; |
注意,页面第一次加载的时候,在 load
事件发生后,Chrome和Safari浏览器(Webkit核心)会触发 popstate
事件,而Firefox和IE浏览器不会。
六、URLSearchParams API
URLSearchParams API用于处理URL之中的查询字符串,即问号之后的部分。没有部署这个API的浏览器,可以用 url-search-params 这个垫片库。
1 | var paramsString = 'q=URLUtils.searchParams&topic=api'; |
URLSearchParams有以下方法,用来操作某个参数。
has():返回一个布尔值,表示是否具有某个参数
get():返回指定参数的第一个值
getAll():返回一个数组,成员是指定参数的所有值
set():设置指定参数
delete():删除指定参数
append():在查询字符串之中,追加一个键值对
toString():返回整个查询字符串
1 | var paramsString = 'q=URLUtils.searchParams&topic=api'; |
URLSearchParams还有三个方法,用来遍历所有参数。
keys():遍历所有参数名
values():遍历所有参数值
entries():遍历所有参数的键值对
上面三个方法返回的都是 Iterator
对象。
1 | var searchParams = new URLSearchParams('key1=value1&key2=value2'); |
在Chrome浏览器之中,URLSearchParams
实例本身就是 Iterator
对象,与 entries
方法返回值相同。所以,可以写成下面的样子。
1 | for (var p of searchParams) { |
下面是一个替换当前URL的例子。
1 | // URL: https://example.com?version=1.0 |
URLSearchParams
实例可以当作POST数据发送,所有数据都会URL编码。
1 | let params = new URLSearchParams(); |
DOM的 a
元素节点的 searchParams
属性,就是一个 URLSearchParams
实例。
1 | var a = document.createElement('a'); |
URLSearchParams
还可以与 URL
接口结合使用。
1 | var url = new URL(location); |
参考资料:
history对象
操纵浏览器的历史记录
hashchange和popstate的用法区别
历史记录API中hashchange与popstate的比较