vue中通过history api拦截浏览器的前进后退按钮事件

现在vueRouter的模式基本都是history模式,它的实现是基于原生事件popstate来实现的。
先看看MDN文档对这个api的解释:

当活动历史记录条目更改时,将触发popstate事件。如果被激活的历史记录条目是通过对history.pushState() 的调用创建的,或者受到对history.replaceState()的调用的影响,popstate事件的state属性包含历史条目的状态对象的副本。
需要注意的是调用history.pushState()history.replaceState()不会触发popstate事件。只有在做出浏览器动作时,才会触发该事件,如用户点击浏览器的回退按钮(或者在Javascript代码中调用history.back()或者history.forward()方法)

也就是说我们点击浏览器的前进、后退按钮或者在js中执行history.back()history.forward()就会触发popstate事件。

那这个apivueRouterhistory模式有什么关系呢?
我们知道vue项目其实是个单页应用,大致结构如下:

<html>
  <body>
    <div id="app">
      <router-view />
    </div>
  </body>
</html>

所以我们在项目中各种跳转切换页面,都不会去请求html资源,都是在一个html中完成dom切换,也就是更换route-view标签里面的内容,但是我们却可以通过浏览器的前进后退按钮进行页面切换,实现的关键就是去监听popstate事件,根据相关信息去更换route-view标签里面的内容。

到这里需要再介绍一个apihistory.pushstate
同样看一下MDN文档的介绍:

HTML 文档中,history.pushState() 方法向当前浏览器会话的历史堆栈中添加一个状态(state)。
语法:history.pushState(state, title[, url])

这个api会往浏览器的历史栈添加一个状态,举个不太切当的例子:
比如现在在A页面,然后从A页面跳转到B页面,然后在B页面执行history.pushState(),此时点击浏览器的后退按钮不会返回A页面,而还是在B页面。

两个apiMDN文档,推荐看一遍哦:
popstate
history.pushState

所以vueRouterhistory模式简单来说就是监听popstate事件,去执行切换显示dom的事件;然后当路由切换时,执行了history.pushState(),然后手动触发一遍切换显示dom的事件。

现在回到标题,在vue中如何拦截浏览器的前进后退按钮呢?最近刚好遇到一个需求,需要此功能来实现:
有一个列表组件list

<template>
  <div class="list">
    <Item />
    <Item />
    <Item />
    ...
  </div> 
<template/>

列表页有很多数据,每条数据只展示基础信息,然后点击每条item,要展示每条item的详情,跳转到详情页。
这种需求非常常见,也有很多种办法实现,比如动态路由,但是如果是动态路由,那么返回列表页的时候,列表页就会刷新,在没有keep-alive的情况。交互不太友好,我一般都是通过组件切换去实现:

<template>
  <div class="list" v-show="!showDetail">
    <Item />
    <Item />
    <Item />
    ...
  </div>
  <Deatil v-if="showDetail" />
<template/>

列表通过v-show显示隐藏,详情组件通过v-if来触发初始化。但这样写又有一个问题,当显示详情页的时候,通过浏览器的后退按钮是回不到列表页的,因为他们在同个组件同个路由中,只能通用自己写的返回按钮来实现,为了考虑用户习惯的行为,就要实现在详情组件中点击后退按钮时能返回到列表页。

结合上面所说,在进入详情组件的时候,把这个行为当成进入一个新页面,所以就要往浏览器会话的历史堆栈中添加一个状态:

// 显示详情组件的事件
// id是每一条数据的id,或者是一个标识
const goDetail = (id) => {
  showDetail = true
  history.pushState({ ...history.state, id }, '')
}

history.state储存了当前浏览器会话的信息,包括前进是什么状态,后退是什么状态,上面例子中我往里面添加了一个idhistory.pushState有三个参数,第一个参数就是state,第二个参数可以忽略,第三个参数url可选,vueRouter的切换就是通过第三个参数来指定,如果不传第三个参数,当前url就不会改变。

当执行了上面的goDetail方法后,就会显示详情组件。假如列表页的路由的 /list,从 /home路由跳转过来的,那当显示详情页的时候,点击浏览器的后退按钮,因为已经执行了history.pushState,所以不会返回到/home路由,还是在/list路由。
那么怎么实现当在详情组件的时候,点击后退按钮隐藏详情组件,显示列表呢?
这时候就需要监听popstate事件了,我在history.pushState的时候,往state中添加了一个标识,keyid,通过判断是否有这个标识来切换组件:

  onMounted(() => {
    window.addEventListener('popstate', toggleDetailShow)
  })

  const toggleDetailShow = () => {
    if (history.state.id) {
      showDetail = true
    } else {
      showDetail = false
    }
  }

当显示详情组件的时候,点击后退按钮,触发了popstate事件,history.state回到未执行history.pushState的状态,也就是history.state没有id这个标识,所以会隐藏掉详情组件;此时,再点击浏览器的前进按钮,history.state就会返回到执行了history.pushState的状态,有id这个标识,就会显示详情组件。
这样就显示了通过浏览器的前进后退来控制同个路由下组件的切换。

本文基于在一个组件中切换列表与某条数据的详情需求来说,对于涉及到的两个history api还有很多理解不足的地方,如果你有更好的见解,请指教。

我是鸭子,祝你幸福。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容