造轮子——前端路由

举报
大史不说话 发表于 2018/06/22 14:46:25 2018/06/22
【摘要】 【造轮子】是学习和理解一些较复杂的代码结构时的常用方法,它很慢,但是效果却胜过你读十几篇相关的文章。为已知的API方法自行编写实现,遇到自己无法复现的部分再有针对性地去查资料,最后当你再去学习官方代码的时候,就会明白这样做的价值,总有一天,你也将有能力写出大师级的代码。

随笔1.png

一.前端路由

现代前端开发中最流行的页面模型,莫过于SPA单页应用架构。单页面应用指的是应用只有一个主页面,通过动态替换DOM内容并同步修改url地址,来模拟多页应用的效果,切换页面的功能直接由前台脚本来完成,而不是由后端渲染完毕后前端只负责显示。前端三驾马车Angular,Vue,React均基于此模型来运行的。SPA能够以模拟多页面应用的效果,归功于其前端路由机制

前端路由,顾名思义就是一个前端不同页面的状态管理器,可以不向后台发送请求而直接通过前端技术实现多个页面的效果。angularjs中的ui-router,vue中的vue-router,以及react的react-router均是对这种功能的具体实现。

既然前端路由这么牛逼,那必须的好好研究一下。


二.两种实现方式及其原理

常见的路由插件中两种方式都是支持且可以切换的,例如angularjs1.x中就可以通过以下代码从Hash模式切换到H5模式:

$locationProvider.html5Mode(true);

切换到HTML5的路由模式,主要用于避免url地址中包含#而引发的问题。

1.HashChange

1.1 原理

HTML页面中通过锚点定位原理可进行无刷新跳转,触发后url地址中会多出# + 'XXX'的部分,同时在全局的window对象上触发hashChange事件,这样在页面锚点哈希改变为某个预设值的时候,通过代码触发对应的页面DOM改变,就可以实现基本的路由了,基于锚点哈希的路由比较直观,也是一般前端路由插件中最常用的方式。

1.2 应用

下面通过一个实例看一下,当点击angularjs的连接时,可以看到控制台打印出了相应的信息。

image.png

image.png

2.HTML5 HistoryAPI

2.1 原理

HTML5History API为浏览器的全局history对象增加的扩展方法。一般用来解决ajax请求无法通过回退按钮回到请求前状态的问题

在HTML4中,已经支持window.history对象来控制页面历史记录跳转,常用的方法包括:

  • history.forward(); //在历史记录中前进一步

  • history.back(); //在历史记录中后退一步

  • history.go(n): //在历史记录中跳转n步骤,n=0为刷新本页,n=-1为后退一页。

在HTML5中,window.history对象得到了扩展,新增的API包括:

  • history.pushState(data[,title][,url]);//向历史记录中追加一条记录

  • history.replaceState(data[,title][,url]);//替换当前页在历史记录中的信息。

  • history.state;//是一个属性,可以得到当前页的state信息。

  • window.onpopstate;//是一个事件,在点击浏览器后退按钮或js调用forward()、back()、go()时触发。回调函数中可传入一个event对象,event.state即为通过pushState()或replaceState()方法传入的data参数。


2.2 应用

浏览器访问一个页面时,当前地址的状态信息会被压入历史栈,当调用history.pushState()方法向历史栈中压入一个新的state后,历史栈顶部的指针是指向新的state的。可以将其作用简单理解为假装已经修改了url地址并进行了跳转 ,除非用户点击了浏览器的前进,回退,或是显式调用HTML4中的操作历史栈的方法,否则不会触发全局的popstate事件。

在下面的示例中,点击导航按钮,可以看到url地址栏发生了变化,且控制台打印出了响应的信息。

image.png

image.png

3.hash 和 history API对比

 对比 hash路由 History API 路由
url字符串丑 正常 
 命名限制 通常只能在同一个document下进行改变url地址可以自己来定义,只要是同一个域名下都可以,自由度更大
url地址变更 会改变 可以改变,也可以不改变 
 状态保存无内置方法,需要另行保存页面状态信息  将页面信息压入历史栈时可以附带自定义的信息|
 参数传递能力受到url总长度限制  可以附带自定义对象,传递更多参数信息 
 实用性 可直接使用通常服务端需要修改代码配合实现 
 兼容性IE8以上  IE10以上


三.亲手造一个简单的前端路由插件

造轮子,不是为了把它装在你的车上,而是当你在荒郊野外开车而轮子出了问题时多一种选择。

接下来就自己动手实现一个前端路由的插件吧~


3.1基于Hash的前端路由插件myHashRouter.js

我们希望实现的功能是:

  • 1.引入MyHashRouter.js

  • 2.通过when()方法来定义若干不同的路由状态

  • 3.通过init()方法启动路由功能

  • 4.通过点击导航实现前端路由切换


首先编写js骨架,如下所示: 

-Javascript 代码


01;(function() {
02    function Router() {
03        //记录路由的跳转历史
04        this.historyStack = [];
05        //记录已注册的路由信息
06        this.registeredRouter = [];
07        //路由匹配失败时跳转项
08        this.otherwiseRouter = {
09            path: '/',
10            content: 'home page'
11        }
12    }
13
14    /*
15     * 启用路由功能
16     */
17    Router.prototype.init = function() {
18
19    
20
21    /*
22     * 绑定window.onhashchange事件的回调函数
23     */
24    Router.prototype._bindEvents = function() {
25
26    }
27
28
29
30    /**
31     * 路由注册方法
32     */
33    Router.prototype.when = function(path, content) {
34
35    }
36
37    /**
38     * 判断新添加的路由是否已存在
39     */
40    Router.prototype._hasThisRouter = function(path) {
41
42    }
43
44    /**
45     * 路由不存在时的指定地址
46     */
47    Router.prototype.otherwise = function(path, content) {
48
49    }
50
51    /**
52     * 路由跳转方法,主动调用时可用于跳转路由
53     */
54    Router.prototype.go = function(topath) {
55
56    }
57
58    /**
59     * 用于将对应路由信息渲染至页面,实现路由切换
60     */
61    Router.prototype.render = function (content) {
62
63    }
64
65    var router = new Router();
66
67    //将接口 暴露至全局
68    window.$router = router;
69})();

完成了路由插件的编写后,我们在demo中引入该库,然后使用when()方法注册几个路由地址,再使用init()方法启动路由,脚本部分代码如下:

image.png

效果: 运行附件中的router-demo-hash.html,点击导航按钮,即可看到url地址栏以及内容区域同步更改。

image.png

3.2基于History API的前端路由插件myHistoryRouter.js

由于History API不支持低于IE10以下版本的浏览器(其他大多数现代浏览器基本都支持),所以我们在init()方法启动时先进行可用性判断,基本代码框架与基于Hash的路由插件一致。每个方法的实现并不难写,这里不再赘述,笔者自己的代码实现放在附件myHistoryRouter.js中,水平有限,仅供参考。

 效果:

image.png

3.3集成说明

为方便理解,本例中将两种模式分开编写,如果是插件库的开发,可以模仿ui-router增加一个html5mode()的方法,在init()方法启动路由时,根据所传的参数生成不同的路由插件的单例,也就是我们常说的工厂模式来实现即可。


四.后记

  • 造车轮是一个很好的学习方式,虽然自己造的车轮很简陋,但是对于理解工具的底层原理却很有帮助。

  • 本例只是编写了一个路由工具的基本骨架,真正的路由工具还需要做很多功能扩展,个别功能的复杂度也会很高,例如路径的正则匹配,懒加载,组合视图,嵌套视图,路由动画等等,有兴趣的小伙伴可以在本例提供的框架上进行学习扩展。

  • 附件说明:

    • index_h5history.html —— history API基本用法演示demo

    • index_hashchange.html —— hashchange基本用法演示demo

    • router-demo-hash.html —— 引用了myHashRouter.js的demo

    • myHashRouter.js —— 自己开发的基于hash简易路由插件

    • router-demo-hash.html —— 引用了myHashRouter.js的demo

    • myHistoryRouter.js —— 自己开发的基于historyAPI的简易路由插件

    • router-demo-history.html —— 引用了myHistoryRouter.js的demo


附件


【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。