目前前端三杰 Angular,React,vue 都推介单页面应用 SPA 开发模式, 在路由切换时替换 DOM Tree 中最小修改的部分 DOM, 来减少原先因为多页应用的页面跳转带来的巨量性能损耗. 它们都有自己的典型路由解决方案,@angular/router,react-router,vue-router.
一般来说, 这些路由插件总是提供两种不同方式的路由方式: Hash 和 History, 有时也会提供非浏览器环境下的路由方式 Abstract, 在 vue-router 中是使用了外观模式 https://segmentfault.com/a/1190000012431621 将几种不同的路由方式提供了一个一致的高层接口, 让我们可以更解耦的在不同路由方式中切换.
值得一提的是, Hash 和 History 除了外观上的不同之外, 还一个区别是: Hash 方式的状态保存需要另行传递, 而 html5 History 原生提供了自定义状态传递的能力, 我们可以直接利用其来传递信息.
下面我们具体看看这两种方式都有哪些特点, 并提供简单的实现, 更复杂的功能比如懒加载, 动态路径匹配, 嵌套路由, 路由别名等等, 可以关注一下后面的 vue-router 源码解读方面的博客.
1. Hash
1.1 相关 API
Hash 方法是在路由中带有一个 #, 主要原理是通过监听 # 后的 URL 路径标识符的更改而触发的浏览器 hashchange 事件, 然后通过获取 location.hash 得到当前的路径标识符, 再进行一些路由跳转的操作, 参见 MDN
location.href: 返回完整的 URL
location.hash: 返回 URL 的锚部分
location.pathname: 返回 URL 路径名
hashchange 事件: 当 location.hash 发生改变时, 将触发这个事件
比如访问一个路径 http://sherlocked93.club/base/#/page1, 那么上面几个值分别为:
- # http://sherlocked93.club/base/#/page1
- {
- "href": "http://sherlocked93.club/base/#/page1",
- "pathname": "/base/",
- "hash": "#/page1"
- }
注意: 因为 Hash 方法是利用了相当于页面锚点的功能, 所以与原来的通过锚点定位来进行页面滚动定位的方式冲突, 导致定位到错误的路由路径, 所以需要采用别的办法, 之前在写 https://github.com/SHERlocked93/progress-catalog 这个插件碰到了这个情况.
1.2 实例
这里简单做一个实现, 原理是把目标路由和对应的回调记录下来, 点击跳转触发 hashchange 的时候获取当前路径并执行对应回调, 效果:
- class RouterClass {
- constructor() {
- this.routes = {} // 记录路径标识符对应的 cb
- this.currentUrl = '' // 记录 hash 只为方便执行 cb
- Windows.addEventListener('load', () => this.render())
- Windows.addEventListener('hashchange', () => this.render())
- }
- /* 初始化 */
- static init() {
- Windows.Router = new RouterClass()
- }
- /* 注册路由和回调 */
- route(path, cb) {
- this.routes[path] = cb || function() {}
- }
- /* 记录当前 hash, 执行 cb */
- render() {
- this.currentUrl = location.hash.slice(1) || '/'
- this.routes[this.currentUrl]()
- }
- }
具体实现参照 CodePen https://codepen.io/SHERlocked93/pen/GzZWYw
如果希望使用脚本来控制 Hash 路由的后退, 可以将经历的路由记录下来, 路由后退跳转的实现是对 location.hash 进行赋值. 但是这样会引发重新引发 hashchange 事件, 第二次进入 render . 所以我们需要增加一个标志位, 来标明进入 render 方法是因为回退进入的还是用户跳转
- class RouterClass {
- constructor() {
- this.isBack = false
- this.routes = {} // 记录路径标识符对应的 cb
- this.currentUrl = '' // 记录 hash 只为方便执行 cb
- this.historyStack = [] // hash 栈
- Windows.addEventListener('load', () => this.render())
- Windows.addEventListener('hashchange', () => this.render())
- }
- /* 初始化 */
- static init() {
- Windows.Router = new RouterClass()
- }
- /* 记录 path 对应 cb */
- route(path, cb) {
- this.routes[path] = cb || function() {}
- }
- /* 入栈当前 hash, 执行 cb */
- render() {
- if (this.isBack) { // 如果是由 backoff 进入, 则置 false 之后 return
- this.isBack = false // 其他操作在 backoff 方法中已经做了
- return
- }
- this.currentUrl = location.hash.slice(1) || '/'
- this.historyStack.push(this.currentUrl)
- this.routes[this.currentUrl]()
- }
- /* 路由后退 */
- back() {
- this.isBack = true
- this.historyStack.pop() // 移除当前 hash, 回退到上一个
- const { length } = this.historyStack
- if (!length) return
- let prev = this.historyStack[length - 1] // 拿到要回退到的目标 hash
- location.hash = `#${ prev }`
- this.currentUrl = prev
- this.routes[prev]() // 执行对应 cb
- }
- }
代码实现参考 CodePen https://codepen.io/SHERlocked93/pen/XOdaZj
2. HTML5 History API
2.1 相关 API
HTML5 提供了一些路由操作的 API, 关于使用可以参看 这篇 MDN 上的文章, 这里就列举一下常用 API 和他们的作用, 具体参数什么的就不介绍了, MDN 上都有
history.go(n): 路由跳转, 比如 n 为 2 是往前移动 2 个页面, n 为 -2 是向后移动 2 个页面, n 为 0 是刷新页面
history.back(): 路由后退, 相当于 history.go(-1)
history.forward(): 路由前进, 相当于 history.go(1)
history.pushState()
: 添加一条路由历史记录, 如果设置跨域网址则报错
history.replaceState()
: 替换当前页在路由历史记录的信息
popstate 事件: 当活动的历史记录发生变化, 就会触发 popstate 事件, 在点击浏览器的前进后退按钮或者调用上面前三个方法的时候也会触发, 参见 MDN
2.2 实例
将之前的例子改造一下, 在需要路由跳转的地方使用 history.pushState 来入栈并记录 cb, 前进后退的时候监听 popstate 事件拿到之前传给 pushState 的参数并执行对应 cb, 因为借用了浏览器自己的 API, 因此代码看起来整洁不少
- class RouterClass {
- constructor(path) {
- this.routes = {} // 记录路径标识符对应的 cb
- history.replaceState({ path }, null, path) // 进入状态
- this.routes[path] && this.routes[path]()
- Windows.addEventListener('popstate', e => {
- const path = e.state && e.state.path
- this.routes[path] && this.routes[path]()
- })
- }
- /* 初始化 */
- static init() {
- Windows.Router = new RouterClass(location.pathname)
- }
- /* 注册路由和回调 */
- route(path, cb) {
- this.routes[path] = cb || function() {}
- }
- /* 跳转路由, 并触发路由对应回调 */
- go(path) {
- history.pushState({ path }, null, path)
- this.routes[path] && this.routes[path]()
- }
- }
Hash 模式是使用 URL 的 Hash 来模拟一个完整的 URL, 因此当 URL 改变的时候页面并不会重载. History 模式则会直接改变 URL, 所以在路由跳转的时候会丢失一些地址信息, 在刷新或直接访问路由地址的时候会匹配不到静态资源. 因此需要在服务器上配置一些信息, 让服务器增加一个覆盖所有情况的候选资源, 比如跳转 index.HTML 什么的, 一般来说是你的 App 依赖的页面, 事实上 vue-router 等库也是这么推介的, 还提供了常见的服务器配置.
代码实现参考 CodePen https://codepen.io/SHERlocked93/pen/PVzoLJ
网上的帖子大多深浅不一, 甚至有些前后矛盾, 在下的文章都是学习过程中的总结, 如果发现错误, 欢迎留言指出~
参考:
- history | MDN
- hashchange | MDN
- Manipulating the browser history | MDN
前端路由的基本原理 - 大史不说话 https://www.cnblogs.com/dashnowords/p/9671213.html
History 对象 -- JavaScript 标准参考教程
来源: https://juejin.im/post/5c52da9ee51d45221f242804