JavaScript history對(duì)象

2021-09-15 15:16 更新

概述

瀏覽器窗口有一個(gè)history對(duì)象,用來保存瀏覽歷史。比如,該窗口先后訪問了三個(gè)地址,那么history對(duì)象就包括三項(xiàng),length屬性等于3。

history.length // 3

history對(duì)象提供了一系列方法,允許在瀏覽歷史之間移動(dòng)。

  • back():移動(dòng)到上一個(gè)訪問頁面,等同于瀏覽器的后退鍵。
  • forward():移動(dòng)到下一個(gè)訪問頁面,等同于瀏覽器的前進(jìn)鍵。
  • go():接受一個(gè)整數(shù)作為參數(shù),移動(dòng)到該整數(shù)指定的頁面,比如go(1)相當(dāng)于forward(),go(-1)相當(dāng)于back()。
history.back();
history.forward();
history.go(-2);

如果移動(dòng)的位置超出了訪問歷史的邊界,以上三個(gè)方法并不報(bào)錯(cuò),而是默默的失敗。

以下命令相當(dāng)于刷新當(dāng)前頁面。

history.go(0);

history.pushState(),history.replaceState()

HTML5為history對(duì)象添加了兩個(gè)新方法,history.pushState() 和 history.replaceState(),用來在瀏覽歷史中添加和修改記錄。所有主流瀏覽器都支持該方法(包括IE10)。

if (!!(window.history && history.pushState)){
  // 支持History API
} else {
  // 不支持
}

上面代碼可以用來檢查,當(dāng)前瀏覽器是否支持History API。如果不支持的話,可以考慮使用Polyfill庫History.js

history.pushState方法接受三個(gè)參數(shù),依次為:

  • state:一個(gè)與指定網(wǎng)址相關(guān)的狀態(tài)對(duì)象,popstate事件觸發(fā)時(shí),該對(duì)象會(huì)傳入回調(diào)函數(shù)。如果不需要這個(gè)對(duì)象,此處可以填null。
  • title:新頁面的標(biāo)題,但是所有瀏覽器目前都忽略這個(gè)值,因此這里可以填null。
  • url:新的網(wǎng)址,必須與當(dāng)前頁面處在同一個(gè)域。瀏覽器的地址欄將顯示這個(gè)網(wǎng)址。

假定當(dāng)前網(wǎng)址是example.com/1.html,我們使用pushState方法在瀏覽記錄(history對(duì)象)中添加一個(gè)新記錄。

var stateObj = { foo: "bar" };

history.pushState(stateObj, "page 2", "2.html");

添加上面這個(gè)新記錄后,瀏覽器地址欄立刻顯示example.com/2.html,但并不會(huì)跳轉(zhuǎn)到2.html,甚至也不會(huì)檢查2.html是否存在,它只是成為瀏覽歷史中的最新記錄。假定這時(shí)你訪問了google.com,然后點(diǎn)擊了倒退按鈕,頁面的url將顯示2.html,但是內(nèi)容還是原來的1.html。你再點(diǎn)擊一次倒退按鈕,url將顯示1.html,內(nèi)容不變。

注意,pushState方法不會(huì)觸發(fā)頁面刷新。

如果 pushState 的url參數(shù),設(shè)置了一個(gè)當(dāng)前網(wǎng)頁的#號(hào)值(即hash),并不會(huì)觸發(fā)hashchange事件。如果設(shè)置了一個(gè)非同域的網(wǎng)址,則會(huì)報(bào)錯(cuò)。

// 報(bào)錯(cuò)
history.pushState(null, null, 'https://twitter.com/hello');

上面代碼中,pushState想要插入一個(gè)非同域的網(wǎng)址,導(dǎo)致報(bào)錯(cuò)。這樣設(shè)計(jì)的目的是,防止惡意代碼讓用戶以為他們是在另一個(gè)網(wǎng)站上。

history.replaceState方法的參數(shù)與pushState方法一模一樣,區(qū)別是它修改瀏覽歷史中當(dāng)前頁面的值。假定當(dāng)前網(wǎng)頁是example.com/example.html。

history.pushState({page: 1}, "title 1", "?page=1");
history.pushState({page: 2}, "title 2", "?page=2");
history.replaceState({page: 3}, "title 3", "?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

history.state屬性

history.state屬性保存當(dāng)前頁面的state對(duì)象。

history.pushState({page: 1}, "title 1", "?page=1");

history.state
// { page: 1 }

popstate事件

每當(dāng)同一個(gè)文檔的瀏覽歷史(即history對(duì)象)出現(xiàn)變化時(shí),就會(huì)觸發(fā)popstate事件。需要注意的是,僅僅調(diào)用pushState方法或replaceState方法 ,并不會(huì)觸發(fā)該事件,只有用戶點(diǎn)擊瀏覽器倒退按鈕和前進(jìn)按鈕,或者使用JavaScript調(diào)用back、forward、go方法時(shí)才會(huì)觸發(fā)。另外,該事件只針對(duì)同一個(gè)文檔,如果瀏覽歷史的切換,導(dǎo)致加載不同的文檔,該事件也不會(huì)觸發(fā)。

使用的時(shí)候,可以為popstate事件指定回調(diào)函數(shù)。這個(gè)回調(diào)函數(shù)的參數(shù)是一個(gè)event事件對(duì)象,它的state屬性指向pushState和replaceState方法為當(dāng)前url所提供的狀態(tài)對(duì)象(即這兩個(gè)方法的第一個(gè)參數(shù))。

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方法,為當(dāng)前url綁定的state對(duì)象。

這個(gè)state對(duì)象也可以直接通過history對(duì)象讀取。

var currentState = history.state;

另外,需要注意的是,當(dāng)頁面第一次加載的時(shí)候,在onload事件發(fā)生后,Chrome和Safari瀏覽器(Webkit核心)會(huì)觸發(fā)popstate事件,而Firefox和IE瀏覽器不會(huì)。

參考鏈接

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)