JavaScript实现history路由变化监听及一个对应的应用场景

一、什么是hash路由

1、为地址栏中的 # 符号,比如这个 URL:http://www.abc.com/#/home,hash 的值为 #/home,请求的时候如果不特意加上,不会被带到服务器
2、hash刷新时,页面不会向服务器发送请求,因此改变 hash 不会重新加载页面。
3、每次hashchange的时候,利用window.onhashchange 监听,会在浏览器的访问历史中增加一个记录,所以可以通过浏览器的前进后退来管理页面。核心就是利用location.hash 和hashchange event去实现的前端路由跳转,同时链接上会有一个#号
具体的方法为:

// 在跳转后会得到跳转前和当前url
window.onhashchange = (e) => {
    console.log(e.oldUrl, e.newUrl);
}
// 这样就可以触发hashchange回调了
location.hash = '#test';

二、什么是history路由

1、是一个常规的链接,没有#符号
2、hisotry的请求在每次刷新都会向服务器去请求,除了pushState和replaceState
3、popState不能监听到pushState和replaceState的事件
history —— 利用了 HTML5 History Interface 中新增的 pushState() 和 replaceState() 方法。(需要特定浏览器支持)
4、刷新页面向服务器请求资源,资源不存在会404,服务器要兜底
5、pushState() 和 replaceState() 方法这两个方法应用于浏览器的历史记录栈,在当前已有的 back、forward、go 的基础之上,它们提供了对历史记录进行修改的功能。执行后,页面的地址会变化,页面还是原来的页面不会发生变化。

三、两者的区别

1、hash路由链接有hash(#),并且是一个纯客户端路由(路由文件不需要通过nginx配置),history链接一般没hash,需要服务端进行兜底操作,否则页面会404(一般的处理方法是,在路由文件里配置找不到对应的路由时,统一跳转到404页面,这个配置放在路由文件的最后)
2、api不同,hash路由监听hashchange,history监听popstate,并且history有提供比较多api进行页面跳转管理,hash需要自己去管理这些堆栈

//当hash和history模式进行混用时
https://127.0.0.1/#/login?a=hello
hash: "#/login?a=hello"
search: ""

https://127.0.0.1/?a=hello#/login
hash: "#/login"
search: "?a=hello"

3、hash路由对seo不友好

四、解决方法

  我们首先完成一个订阅-发布模式,然后重写history.pushState, history.replaceState,并添加消息通知,这样一来只要history的无法实现监听函数就被我们加上了事件通知,只不过这里用的不是浏览器原生事件,而是通过我们创建的event-bus 来实现通知,然后触发事件订阅函数的执行。
1、订阅-发布模式

class Dep { // 订阅池
      constructor(name) {
        this.subs = [] //该事件下被订阅对象的集合
      }
      defined(watch) {
        this.subs.push(watch)
      }
      notify() { //通知订阅者有变化
        console.log('this.subs',this.subs)
        this.subs.forEach((e, i) => {
          if (typeof e.update === 'function') {
            try {
              e.update.apply(e) //触发订阅者更新函数
            } catch (err) {
              console.error(err)
            }
          }
        })
      }
    }

    class Watch {
      constructor(name, fn) {
        this.name = name; //订阅消息的名称
        this.callBack = fn; //订阅消息发送改变时->订阅者执行的回调函数     
      }
      add(dep) { //将订阅者放入dep订阅池
        dep.subs.push(this);
      }
      update() { //将订阅者更新方法
        var cb = this.callBack; //赋值为了不改变函数内调用的this
        cb(this.name);
      }
    }

2、重写history方法,并添加window.addHistoryListener事件机制。添加event-bus即可,代码如下:

    function addMethod() {
      let historyDep = new Dep();
      return function (name) {
        if (name === 'historychange') {
          return function (name, fn) {
            let event = new Watch(name, fn)
            historyDep.defined(event);
          }
        } else if (name === 'pushState' ) {
          let method = history[name];
          return function () {
            console.log('pushState','arguments',arguments[2])
            method.apply(history, arguments);
            historyDep.notify();
          }
        }else if ( name === 'replaceState') {
          let method = history[name];
          return function () {
            console.log('replaceState','arguments',arguments[2])
            method.apply(history, arguments);
            historyDep.notify();
          }
        }

      }
    }
    let addHistoryMethod = new addMethod()
    window.addHistoryListener = addHistoryMethod('historychange');
    history.pushState = addHistoryMethod('pushState');
    history.replaceState = addHistoryMethod('replaceState');              

重写之后、在页面上

window.addHistoryListener('history',function(){
//注意这个方法只要路由发生变化就会被触发
    console.log('窗口的history改变了');
})
//如果想一进入页面,window.addHistoryListener就能监听到,加入这句话
window.pushState(null,null,window.location.href)

五、一个小的业务场景

  当用户进入一个页面按手机系统自带的返回按钮时,弹出一个挽留框,并阻止用户跳出这一行为。
解决方案
1、在进入当前页面时,通过pushState(null,null,window.location.href),在history栈中增加一条和当前路径相同的地址
2、当用户点击返回时,会触发window.onpopstate ,让pushState行为在用户要返回时被popState监听到,此时弹出挽留框,页面还是之前的页面没有变化。

window.onpopstate = function(){
    //一进入页面时并不会触发这个方法,只有页面地址要更改 
      后才可以触发,此时可以监听到pushState事件
      //显示挽留弹窗
}
window.history.pushState(null,null,window.location.href)

测试发现问题
  在安卓手机上,页面打开后,如果用户点击了页面,onpopstate事件监听就能正常触发。如果页面打开无任何操作(单纯滑动也不行),直接按android返回按钮。事件回调就没触发,直接退出了。ios没有问题。很多人遇到了这个问题,目前还没有解决,妥协的方案是诱导用户进行点击页面的操作。

六、参考文章

1、https://juejin.cn/post/6844903790508933133
2、https://juejin.cn/post/6890716016033628173

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