前端路由

2019-07-18 本文已影响0人 oWSQo

什么是SPA

SPA是single page web application的简称，译为单页Web应用。
简单的说SPA就是一个WEB项目只有一个HTML页面，一旦页面加载完成，SPA不会因为用户的操作而进行页面的重新加载或跳转。
取而代之的是利用JS动态的变换HTML的内容，从而来模拟多个视图间跳转。

前端路由的由来

最开始的网页是多页面的，直到Ajax的出现，才慢慢有了SPA。
SPA的出现大大提高了WEB应用的交互体验。在与用户的交互过程中，不再需要重新刷新页面，获取数据也是通过Ajax异步获取，页面显示变的更加流畅。
但由于SPA中用户的交互是通过JS改变HTML内容来实现的，页面本身的URL并没有变化，这导致了两个问题：

SPA无法记住用户的操作记录，无论是刷新、前进还是后退，都无法展示用户真实的期望内容。
SPA中虽然由于业务的不同会有多种页面展示形式，但只有一个URL，对SEO不友好，不方便搜索引擎进行收录。

前端路由就是为了解决上述问题而出现的。

什么是前端路由

简单的说，就是在保证只有一个HTML页面，且与用户交互时不刷新和跳转页面的同时，为SPA中的每个视图展示形式匹配一个特殊的URL。在刷新、前进、后退和SEO时均通过这个特殊的URL来实现。
为实现这一目标，我们需要做到以下二点：

改变URL且不让浏览器像服务器发送请求。
可以监听到URL的变化

hash模式和history模式，就是实现了上面的功能。

hash 模式

这里的hash就是指url后的#号以及后面的字符。比如说www.baidu.com/#hashhash，其中"#hashhash"就是我们期望的hash值。

由于hash值的变化不会导致浏览器像服务器发送请求，而且hash的改变会触发hashchange事件，浏览器的前进后退也能对其进行控制，所以在H5的history模式出现之前，基本都是使用hash模式来实现前端路由。
使用到的API：

window.location.hash = 'hash字符串'; // 用于设置 hash 值

let hash = window.location.hash; // 获取当前 hash 值

// 监听hash变化，点击浏览器的前进后退会触发
window.addEventListener('hashchange', function(event){ 
    let newURL = event.newURL; // hash 改变后的新 url
    let oldURL = event.oldURL; // hash 改变前的旧 url
},false)

接下来我们来实现一个路由对象。
创建一个路由对象, 实现register方法用于注册每个hash值对应的回调函数。

class HashRouter{
    constructor(){
        //用于存储不同hash值对应的回调函数
        this.routers = {};
    }
    //用于注册每个视图
    register(hash,callback = function(){}){
        this.routers[hash] = callback;
    }
}

不存在hash值时，认为是首页，所以实现registerIndex方法用于注册首页时的回调函数。

class HashRouter{
    constructor(){
        //用于存储不同hash值对应的回调函数
        this.routers = {};
    }
    //用于注册每个视图
    register(hash,callback = function(){}){
        this.routers[hash] = callback;
    }
    //用于注册首页
    registerIndex(callback = function(){}){
        this.routers['index'] = callback;
    }
}

通过hashchange监听hash变化，并定义hash变化时的回调函数。

class HashRouter{
    constructor(){
        //用于存储不同hash值对应的回调函数
        this.routers = {};
        window.addEventListener('hashchange',this.load.bind(this),false)
    }
    //用于注册每个视图
    register(hash,callback = function(){}){
        this.routers[hash] = callback;
    }
    //用于注册首页
    registerIndex(callback = function(){}){
        this.routers['index'] = callback;
    }
    //用于调用不同视图的回调函数
    load(){
        let hash = location.hash.slice(1),
            handler;
        //没有hash 默认为首页
        if(!hash){
            handler = this.routers.index;
        }else{
            handler = this.routers[hash];
        }
        //执行注册的回调函数
        handler.call(this);
    }
}

我们做一个例子来演示一下我们刚刚完成的HashRouter。

<body>
    <div id="nav">
        <a href="#/page1">page1</a>
        <a href="#/page2">page2</a>
        <a href="#/page3">page3</a>
    </div>
    <div id="container"></div>
</body>

let router = new HashRouter();
let container = document.getElementById('container');

//注册首页回调函数
router.registerIndex(()=> container.innerHTML = '我是首页');

//注册其他视图回到函数
router.register('/page1',()=> container.innerHTML = '我是page1');
router.register('/page2',()=> container.innerHTML = '我是page2');
router.register('/page3',()=> container.innerHTML = '我是page3');

//加载视图
router.load();

image

基本的路由功能我们已经实现了，但依然有点小问题：

视图切换后，新的hash值没有在路由中注册
hash值对应的回调函数在执行过程中抛出异常

对应的解决办法如下：

我们追加registerNotFound方法，用于注册hash值为找到时的默认回调函数；
修改load方法，追加try/catch用于捕获异常，追加registerError方法，用于处理异常

代码修改后：

class HashRouter{
    constructor(){
        //用于存储不同hash值对应的回调函数
        this.routers = {};
        window.addEventListener('hashchange',this.load.bind(this),false)
    }
    //用于注册每个视图
    register(hash,callback = function(){}){
        this.routers[hash] = callback;
    }
    //用于注册首页
    registerIndex(callback = function(){}){
        this.routers['index'] = callback;
    }
    //用于处理视图未找到的情况
    registerNotFound(callback = function(){}){
        this.routers['404'] = callback;
    }
    //用于处理异常情况
    registerError(callback = function(){}){
        this.routers['error'] = callback;
    }
    //用于调用不同视图的回调函数
    load(){
        let hash = location.hash.slice(1),
            handler;
        //没有hash 默认为首页
        if(!hash){
            handler = this.routers.index;
        }
        //未找到对应hash值
        else if(!this.routers.hasOwnProperty(hash)){
            handler = this.routers['404'] || function(){};
        }
        else{
            handler = this.routers[hash]
        }
        //执行注册的回调函数
        try{
            handler.apply(this);
        }catch(e){
            console.error(e);
            (this.routers['error'] || function(){}).call(this,e);
        }
    }
}

再来一个例子，演示一下：

<body>
    <div id="nav">
        <a href="#/page1">page1</a>
        <a href="#/page2">page2</a>
        <a href="#/page3">page3</a>
        <a href="#/page4">page4</a>
        <a href="#/page5">page5</a>
    </div>
    <div id="container"></div>
</body>

let router = new HashRouter();
let container = document.getElementById('container');

//注册首页回调函数
router.registerIndex(()=> container.innerHTML = '我是首页');

//注册其他视图回到函数
router.register('/page1',()=> container.innerHTML = '我是page1');
router.register('/page2',()=> container.innerHTML = '我是page2');
router.register('/page3',()=> container.innerHTML = '我是page3');
router.register('/page4',()=> {throw new Error('抛出一个异常')});

//加载视图
router.load();
//注册未找到对应hash值时的回调
router.registerNotFound(()=>container.innerHTML = '页面未找到');
//注册出现异常时的回调
router.registerError((e)=>container.innerHTML = '页面异常，错误消息：<br>' + e.message);

来看一下效果：

至此，基于hash方式实现的前端路由，我们已经将基本雏形实现完成了。

history 模式

在H5之前，浏览器就已经有了history对象。但在早期的history中只能用于多页面的跳转：

history.go(-1);       // 后退一页
history.go(2);        // 前进两页
history.forward();     // 前进一页
history.back();      // 后退一页

在H5的规范中，history新增了以下几个API：

history.pushState();         // 添加新的状态到历史状态栈
history.replaceState();      // 用新的状态代替当前状态
history.state                // 返回当前状态对象

这些方法通常与window.onpopstate配合使用。
history.pushState()和history.replaceState()均接收三个参数（state, title, url）
参数说明如下：

state：合法的Javascript对象，可以用在popstate事件中
title：现在大多浏览器忽略这个参数，可以直接用null代替
url：任意有效的URL，用于更新浏览器的地址栏

history.pushState()和history.replaceState()的区别在于：

history.pushState()在保留现有历史记录的同时，将url加入到历史记录中。
history.replaceState()会将历史记录中的当前页面历史替换为url。

由于history.pushState()和history.replaceState()可以改变url同时，不会刷新页面，所以在 HTML5中的histroy具备了实现前端路由的能力。
回想我们之前完成的hash模式，当hash变化时，可以通过hashchange进行监听。
而history的改变并不会触发任何事件，所以我们无法直接监听history的改变而做出相应的改变。
所以，我们需要换个思路，我们可以罗列出所有可能触发history改变的情况，并且将这些方式一一进行拦截，变相地监听history的改变。
对于单页应用的history模式而言，url的改变只能由下面四种方式引起：

点击浏览器的前进或后退按钮
点击a标签
在JS代码中触发history.pushState函数
在JS代码中触发history.replaceState函数

思路已经有了，接下来我们来实现一个路由对象。

创建一个路由对象, 实现register方法用于注册每个location.pathname值对应的回调函数
当location.pathname === '/'时，认为是首页，所以实现registerIndex方法用于注册首页时的回调函数
解决location.path没有对应的匹配，增加方法registerNotFound用于注册默认回调函数
解决注册的回到函数执行时出现异常，增加方法registerError用于处理异常情况
定义assign方法，用于通过JS触发history.pushState函数
定义replace方法，用于通过JS触发history.replaceState函数
监听popstate用于处理前进后退时调用对应的回调函数
全局阻止a链接的默认事件，获取a链接的href属性，并调用history.pushState方法
定义load方法，用于首次进入页面时根据location.pathname调用对应的回调函数

代码如下：

class HistoryRouter{
    constructor(){
        //用于存储不同path值对应的回调函数
        this.routers = {};
        this.listenPopState();
        this.listenLink();
    }
    //监听popstate
    listenPopState(){
        window.addEventListener('popstate',(e)=>{
            let state = e.state || {},
                path = state.path || '';
            this.dealPathHandler(path)
        },false)
    }
    //全局监听A链接
    listenLink(){
        window.addEventListener('click',(e)=>{
            let dom = e.target;
            if(dom.tagName.toUpperCase() === 'A' && dom.getAttribute('href')){
                e.preventDefault()
                this.assign(dom.getAttribute('href'));
            }
        },false)
    }
    //用于首次进入页面时调用
    load(){
        let path = location.pathname;
        this.dealPathHandler(path)
    }
    //用于注册每个视图
    register(path,callback = function(){}){
        this.routers[path] = callback;
    }
    //用于注册首页
    registerIndex(callback = function(){}){
        this.routers['/'] = callback;
    }
    //用于处理视图未找到的情况
    registerNotFound(callback = function(){}){
        this.routers['404'] = callback;
    }
    //用于处理异常情况
    registerError(callback = function(){}){
        this.routers['error'] = callback;
    }
    //跳转到path
    assign(path){
        history.pushState({path},null,path);
        this.dealPathHandler(path)
    }
    //替换为path
    replace(path){
        history.replaceState({path},null,path);
        this.dealPathHandler(path)
    }
    //通用处理 path 调用回调函数
    dealPathHandler(path){
        let handler;
        //没有对应path
        if(!this.routers.hasOwnProperty(path)){
            handler = this.routers['404'] || function(){};
        }
        //有对应path
        else{
            handler = this.routers[path];
        }
        try{
            handler.call(this)
        }catch(e){
            console.error(e);
            (this.routers['error'] || function(){}).call(this,e);
        }
    }
}

再做一个例子来演示一下我们刚刚完成的HistoryRouter。

<body>
    <div id="nav">
        <a href="/page1">page1</a>
        <a href="/page2">page2</a>
        <a href="/page3">page3</a>
        <a href="/page4">page4</a>
        <a href="/page5">page5</a>
        <button id="btn">page2</button>
    </div>
    <div id="container">

    </div>
</body>

let router = new HistoryRouter();
let container = document.getElementById('container');

//注册首页回调函数
router.registerIndex(() => container.innerHTML = '我是首页');

//注册其他视图回到函数
router.register('/page1', () => container.innerHTML = '我是page1');
router.register('/page2', () => container.innerHTML = '我是page2');
router.register('/page3', () => container.innerHTML = '我是page3');
router.register('/page4', () => {
    throw new Error('抛出一个异常')
});

document.getElementById('btn').onclick = () => router.assign('/page2')

//注册未找到对应path值时的回调
router.registerNotFound(() => container.innerHTML = '页面未找到');
//注册出现异常时的回调
router.registerError((e) => container.innerHTML = '页面异常，错误消息：<br>' + e.message);
//加载页面
router.load();

来看一下效果：

至此，基于history方式实现的前端路由，我们已经将基本雏形实现完成了。
但需要注意的是，history在修改url后，虽然页面并不会刷新，但我们在手动刷新，或通过url直接进入应用的时候，服务端是无法识别这个url的。因为我们是单页应用，只有一个HTML文件，服务端在处理其他路径的url的时候，就会出现404的情况。

所以，如果要应用history模式，需要在服务端增加一个覆盖所有情况的候选资源：如果URL匹配不到任何静态资源，则应该返回单页应用的HTML文件。
接下来，我们来探究一下，何时使用hash模式，何时使用history模式。

hash、history 如何抉择

hash模式相比于history模式的优点：

兼容性更好，可以兼容到IE8
无需服务端配合处理非单页的url地址

hash模式相比于history模式的缺点：

看起来更丑
会导致锚点功能失效
相同hash值不会触发动作将记录加入到历史栈中，而pushState则可以

综上所述，当我们不需要兼容老版本IE浏览器，并且可以控制服务端覆盖所有情况的候选资源时，我们可以愉快的使用history模式了。