spa路由简单实现代码解析(梁王的代码解剖室)

前言

本文假设读者使用过或者了解什么是SPA

SPA路由简单实现

代码(被解析项目地址)

为了避免误会,代码不是我写的,我只是解析源码。
spa-routers
demo演示: demo

解析

解析分3个部分,hash路由,路由规则注册,路由同异步加载

hash路由

用过vue之类的框架应该都知道什么是hash,这里说的是url的hash不是数据结构里面的东西。
类似这种http://www.example.com/index.html#print

单页应用当hash变换的时候,切换不同的界面。而浏览器提供了一个事件hashchange

function changePart(event) {
    alert('your hash changed');
    console.log(event);
}
window.onhashchange = changePart;

读者可以自行在控制台试一下然后改变hash看看。

在项目代码中,在初始化spaRouters的时候会监听事件

spaRouters.prototype={
    init:function(){
        var self = this;
        //页面加载匹配路由
        window.addEventListener('load',function(){
            self.urlChange()
        })
        //路由切换
        window.addEventListener('hashchange',function(){
            self.urlChange()
        })
        ...
    },
    ...
}

现在我们来看看urlChange方法,方法在spaRouters的原型里面

    ...
    urlChange:function(){
        var currentHash = util.getParamsUrl();
        if(this.routers[currentHash.path]){
            this.refresh(currentHash)
        }else{
            //不存在的地址重定向到首页
            location.hash = '/index'
        }
    },
    refresh:function(currentHash){
        var self = this;
        // 提供导航钩子
        if(self.beforeFun){
            // 这里还可以像vue一样还提供from
            self.beforeFun({
                to:{
                    path:currentHash.path,
                    query:currentHash.query
                },
                // 关于next我明天会补充一下
                next:function(){
                    self.routers[currentHash.path].callback.call(self,currentHash)
                }
            })
        }else{
            self.routers[currentHash.path].callback.call(self,currentHash)
        }
    },
    ...

hash变更后,看routers里面有没有hash对应的路由规则(这里直接用的下标,其实想做得更好可以使用模板,还有用正则来匹配,像vue路由就有类似/users/:id这种)。

如果有匹配的话调用refresh,refresh这里还提供了导航钩子beforeFun(通过spaRouters原型提供的beforeEach还有afterEach的方法设置),其中的next我后面会再扩展一下。

路由规则注册

刚刚讲完了hash变化后程序的逻辑,现在我们来看看怎么注册路由规则。
同样是spaRouters的原型里面

    //单层路由注册
    ...
    map:function(path,callback){
        path = path.replace(/\s*/g,"");//过滤空格
        if(callback && Object.prototype.toString.call(callback) === '[object Function]' ){
            this.routers[path] ={
                callback:callback,//回调
                fn:null //存储异步文件状态
            }
        }else{
            console.trace('注册'+path+'地址需要提供正确的的注册回调')
        }
    },
    ...

原型中的map方法注册路由,并提供一个回调,这个回调也就是上面hashchange的时候会调用的内容,一般是进行同异步加载js。下面是项目内的测试调用

    ...
    spaRouters.map('/index',function(transition){
      spaRouters.asyncFun('js/index.js',transition)
    })
    spaRouters.map('/list',function(transition){
      spaRouters.asyncFun('js/list.js',transition)
    })
    spaRouters.map('/detail',function(transition){
      spaRouters.asyncFun('js/detail.js',transition)
    })
    spaRouters.map('/detail2',function(transition){
      spaRouters.syncFun(function(transition){
        document.getElementById("content").innerHTML = '<p>当前同步渲染详情页' + JSON.stringify(transition) +'</p>'
      },transition)
    })
    ...

其中的syncFun和asyncFun我在第三部分讲
之前也说了,这里可以优化一下使用模板正则匹配(当然使用正则之后又有注册顺序的问题)

同异步加载

同样是在spaRouters的原型中的两个方法

    ...
    //路由异步懒加载js文件
    asyncFun:function(file,transition){
       var self = this;
       if(self.routers[transition.path].fn){
            self.afterFun && self.afterFun(transition)
            self.routers[transition.path].fn(transition)
       }else{
           console.log("开始异步下载js文件"+file)
           var _body= document.getElementsByTagName('body')[0];
           var scriptEle= document.createElement('script');
           scriptEle.type= 'text/javascript';
           scriptEle.src= file;
           scriptEle.async = true;
           SPA_RESOLVE_INIT = null;
           scriptEle.onload= function(){
               console.log('下载'+file+'完成')
               self.afterFun && self.afterFun(transition)
               self.routers[transition.path].fn = SPA_RESOLVE_INIT;
               self.routers[transition.path].fn(transition)
           }
           _body.appendChild(scriptEle);
       }
    },
    //同步操作
    syncFun:function(callback,transition){
        // 路由切换后的回调
        this.afterFun && this.afterFun(transition)
        // 路由注册时设置的回调
        callback && callback(transition)
    }
    ...

同步简单一点我们先说同步吧,map注册路由的第二个参数是callback,在hash发发生变化的时候refresh里面调用的回调。基本上是直接调用回调就行了

然后我们来看看异步的部分。异步部分懒加载js文件。
这里注意一下一开始有个判断

    if(self.routers[transition.path].fn){
        self.afterFun && self.afterFun(transition)
        self.routers[transition.path].fn(transition)
    }else{
    ...

这个fn算是一个标示位,异步加载的js文件里面会设置一个叫SPA_RESOLVE_INIT的变量。

   SPA_RESOLVE_INIT = null;
   scriptEle.onload= function(){
       console.log('下载'+file+'完成')
       self.afterFun && self.afterFun(transition)
       self.routers[transition.path].fn = SPA_RESOLVE_INIT;
       self.routers[transition.path].fn(transition)
   }

而对应的js文件内容可能是

SPA_RESOLVE_INIT = function(transition) { 
    document.getElementById("content").innerHTML = '<p style="color:red;">当前异步渲染详情页'+ JSON.stringify(transition) +'</p>'
    console.log("首页回调" + JSON.stringify(transition))
}

所以可以通过fn判断当前路由js文件已经下载下来了就不需要再次下载了,直接调用。

后记

本文大致解析了一下简单SPA的路由部分,所解析代码也是比较简单的,也有很多可以改进的地方,读者有什么好的改进方案可以在评论区沟通交流一下。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,568评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 相信很多人都听过那个故事。王子向公主求婚,公主要求王子在城堡外为她守卫100天,王子只要守足一百天,就可以娶到公主...
    katykat阅读 2,120评论 0 0
  • (本文是笔者对《佐藤可士和的超整理术》和《断舍离》两本书的读后笔记。) 提纲 超整理术是什么? 断舍离是什么? 相...
    安静的猫咪先生阅读 945评论 4 11
  • 有很多因素可以决定我们成为怎样的人,但在这里,具体谈谈五个关键的因素。 第一点,遗传因素。我们都知道,环境对于一个...
    半夏_1854阅读 599评论 0 0