1. 编程式导航

    1. 除了使用 <router-link> 创建 a 标签来定义导航链接,我们还可以借助 router 的实例方法,通过编写代码来实现。
    2. 导航到不同的位置
      1. 示例
      2. 该方法的参数可以是一个字符串路径,或者一个描述地址的对象。例如:
        // 字符串路径
        router.push('/users/eduardo')
        
        // 带有路径的对象
        router.push({ path: '/users/eduardo' })
        
        // 命名的路由,并加上参数,让路由建立 url
        router.push({ name: 'user', params: { username: 'eduardo' } })
        
        // 带查询参数,结果是 /register?plan=private
        router.push({ path: '/register', query: { plan: 'private' } })
        
        // 带 hash,结果是 /about#team
        router.push({ path: '/about', hash: '#team' })
      3. 注意:如果提供了 pathparams 会被忽略,上述例子中的 query 并不属于这种情况。取而代之的是下面例子的做法,你需要提供路由的 name 或手写完整的带有参数的 path :
        const username = 'eduardo'
        // 我们可以手动建立 url,但我们必须自己处理编码
        router.push(`/user/${username}`) // -> /user/eduardo
        // 同样
        router.push({ path: `/user/${username}` }) // -> /user/eduardo
        // 如果可能的话,使用 `name` 和 `params` 从自动 URL 编码中获益
        router.push({ name: 'user', params: { username } }) // -> /user/eduardo
        // `params` 不能与 `path` 一起使用
        router.push({ path: '/user', params: { username } }) // -> /user
      4. 当指定 params 时,可提供 string 或 number 参数(或者对于可重复的参数可提供一个数组)。任何其他类型(如对象、布尔等)都将被自动字符串化。对于可选参数,你可以提供一个空字符串("")或 null 来移除它。

        由于属性 to 与 router.push 接受的对象种类相同,所以两者的规则完全相同。

        此外,router.push 和所有其他导航方法都会返回一个 Promise,让我们可以等到导航完成后才知道是成功还是失败。

    3. 替换当前位置
      1. 它的作用类似于 router.push,唯一不同的是,它在导航时不会向 history 添加新记录,正如它的名字所暗示的那样——它取代了当前的条目。
      2. 也可以直接在传递给 router.push 的 to 参数中增加一个属性 replace: true :
        router.push({ path: '/home', replace: true })
        // 相当于
        router.replace({ path: '/home' })
    4. 横跨历史
      1. 该方法采用一个整数作为参数,表示在历史堆栈中前进或后退多少步,类似于 window.history.go(n)
        // 向前移动一条记录,与 router.forward() 相同
        router.go(1)
        
        // 返回一条记录,与 router.back() 相同
        router.go(-1)
        
        // 前进 3 条记录
        router.go(3)
        
        // 如果没有那么多记录,静默失败
        router.go(-100)
        router.go(100)

  2. 命名路由

    1. 除了 path 之外,你还可以为任何路由提供 name。这有以下优点
      1. 没有硬编码的 URL
      2. params 的自动编码/解码。
      3. 防止你在 url 中出现打字错误。
      4. 绕过路径排序(如显示一个)
        const routes = [
          {
            path: '/user/:username',
            name: 'user',
            component: User,
          },
        ]
    2. 要链接到一个命名的路由,可以向 router-link 组件的 to 属性传递一个对象:
      <router-link :to="{ name: 'user', params: { username: 'erina' }}">
        User
      </router-link>
    3. 这跟代码调用 router.push() 是一回事:
      router.push({ name: 'user', params: { username: 'erina' } })
    4. 在这两种情况下,路由将导航到路径 /user/erina。所有路由的命名都必须是唯一的。如果为多条路由添加相同的命名,路由器只会保留最后那一条。
  3. 重定向

    1. 入门
      1. 重定向也是通过 routes 配置来完成,下面例子是从 /home 重定向到 /:
        const routes = [{ path: '/home', redirect: '/' }]
      2. 重定向的目标也可以是一个命名的路由:
        const routes = [{ path: '/home', redirect: { name: 'homepage' } }]
      3. 甚至是一个方法,动态返回重定向目标:
        const routes = [
          {
            // /search/screens -> /search?q=screens
            path: '/search/:searchText',
            redirect: to => {
              // 方法接收目标路由作为参数
              // return 重定向的字符串路径/路径对象
              return { path: '/search', query: { q: to.params.searchText } }
            },
          },
          {
            path: '/search',
            // ...
          },
        ]
      4. 请注意,导航守卫并没有应用在跳转路由上,而仅仅应用在其目标上。在上面的例子中,在 /home 路由中添加 beforeEnter 守卫不会有任何效果。

        在写 redirect 的时候,可以省略 component 配置,因为它从来没有被直接访问过,所以没有组件要渲染。唯一的例外是嵌套路由:如果一个路由记录有 children 和 redirect 属性,它也应该有 component 属性。

    2. 相对重定向
      1. 也可以重定向到相对位置:
        const routes = [
          {
            // 将总是把/users/123/posts重定向到/users/123/profile。
            path: '/users/:id/posts',
            redirect: to => {
              // 该函数接收目标路由作为参数
              // 相对位置不以`/`开头
              // 或 { path: 'profile'}
              return 'profile'
            },
          },
        ]

  4. 不同的历史模式

    1. 在创建路由器实例时,history 配置允许我们在不同的历史模式中进行选择。
    2. Hash 模式
      1. hash 模式是用 createWebHashHistory() 创建的:
        import { createRouter, createWebHashHistory } from 'vue-router'
        
        const router = createRouter({
          history: createWebHashHistory(),
          routes: [
            //...
          ],
        })

        它在内部传递的实际 URL 之前使用了一个哈希字符(#)。由于这部分 URL 从未被发送到服务器,所以它不需要在服务器层面上进行任何特殊处理。不过,它在 SEO 中确实有不好的影响。如果你担心这个问题,可以使用 HTML5 模式。

    3. Memory 模式
      1. Memory 模式不会假定自己处于浏览器环境,因此不会与 URL 交互也不会自动触发初始导航。这使得它非常适合 Node 环境和 SSR。它是用 createMemoryHistory() 创建的,并且需要你在调用 app.use(router) 之后手动 push 到初始导航。
        import { createRouter, createMemoryHistory } from 'vue-router'
        const router = createRouter({
          history: createMemoryHistory(),
          routes: [
            //...
          ],
        })

        虽然不推荐,你仍可以在浏览器应用程序中使用此模式,但请注意它不会有历史记录,这意味着你无法后退前进

    4. HTML5 模式
      1. 用 createWebHistory() 创建 HTML5 模式,推荐使用这个模式:
        import { createRouter, createWebHistory } from 'vue-router'
        
        const router = createRouter({
          history: createWebHistory(),
          routes: [
            //...
          ],
        })

        当使用这种历史模式时,URL 会看起来很 "正常",例如 https://example.com/user/id。漂亮!

        不过,问题来了。由于我们的应用是一个单页的客户端应用,如果没有适当的服务器配置,用户在浏览器中直接访问 https://example.com/user/id,就会得到一个 404 错误。这就尴尬了。

        不用担心:要解决这个问题,你需要做的就是在你的服务器上添加一个简单的回退路由。如果 URL 不匹配任何静态资源,它应提供与你的应用程序中的 index.html 相同的页面。漂亮依旧!

  5. 导航守卫

    1. 正如其名,vue-router 提供的导航守卫主要用来通过跳转或取消的方式守卫导航。这里有很多方式植入路由导航中:全局的,单个路由独享的,或者组件级的。
    2. 全局前置守卫
      1. 可以使用 router.beforeEach 注册一个全局前置守卫:
        const router = createRouter({ ... })
        
        router.beforeEach((to, from) => {
          // ...
          // 返回 false 以取消导航
          return false
        })
      2. 当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫 resolve 完之前一直处于等待中。

        每个守卫方法接收三个参数:

        1. to: 即将要进入的目标 用一种标准化的方式

        2. from: 当前导航正要离开的路由 用一种标准化的方式

        3. next:在之前的 Vue Router 版本中,还可以使用 第三个参数 next 。这是一个常见的错误来源,我们经过 RFC 讨论将其移除。然而,它仍然是被支持的,这意味着你可以向任何导航守卫传递第三个参数。在这种情况下,确保 next 在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次,但是只能在所有的逻辑路径都不重叠的情况下,否则钩子永远都不会被解析或报错。这里有一个在用户未能验证身份时重定向到/login的错误用例:

          // BAD
          router.beforeEach((to, from, next) => {
            if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
            // 如果用户未能验证身份,则 `next` 会被调用两次
            next()
          })

          下面是正确的版本:

          // GOOD
          router.beforeEach((to, from, next) => {
            if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
            else next()
          })
        4. 可以返回的值如下:

          1. false: 取消当前的导航。如果浏览器的 URL 改变了(可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到 from 路由对应的地址。

          2. ​一个路由地址: 通过一个路由地址重定向到一个不同的地址,如同调用 router.push(),且可以传入诸如 replace: true 或 name: 'home' 之类的选项。它会中断当前的导航,同时用相同的 from 创建一个新导航。

             router.beforeEach(async (to, from) => {
               if (
                 // 检查用户是否已登录
                 !isAuthenticated &&
                 // ❗️ 避免无限重定向
                 to.name !== 'Login'
               ) {
                 // 将用户重定向到登录页面
                 return { name: 'Login' }
               }
             })

            如果遇到了意料之外的情况,可能会抛出一个 Error。这会取消导航并且调用 router.onError() 注册过的回调。

            如果什么都没有,undefined 或返回 true,则导航是有效的,并调用下一个导航守卫

            以上所有都同 async 函数 和 Promise 工作方式一样:

            router.beforeEach(async (to, from) => {
              // canUserAccess() 返回 `true` 或 `false`
              const canAccess = await canUserAccess(to)
              if (!canAccess) return '/login'
            })
    3. 全局解析守卫
      1. 你可以用 router.beforeResolve 注册一个全局守卫。这和 router.beforeEach 类似,因为它在每次导航时都会触发,不同的是,解析守卫刚好会在导航被确认之前、所有组件内守卫和异步路由组件被解析之后调用。这里有一个例子,确保用户可以访问自定义 meta 属性 requiresCamera 的路由:
        router.beforeResolve(async to => {
          if (to.meta.requiresCamera) {
            try {
              await askForCameraPermission()
            } catch (error) {
              if (error instanceof NotAllowedError) {
                // ... 处理错误,然后取消导航
                return false
              } else {
                // 意料之外的错误,取消导航并把错误传给全局处理器
                throw error
              }
            }
          }
        })

        router.beforeResolve 是获取数据或执行任何其他操作(如果用户无法进入页面时你希望避免执行的操作)的理想位置。

    4. 全局后置钩子
      1. 也可以注册全局后置钩子,然而和守卫不同的是,这些钩子不会接受 next 函数也不会改变导航本身:
        router.afterEach((to, from) => {
          sendToAnalytics(to.fullPath)
        })
      2. 它们对于分析、更改页面标题、声明页面等辅助功能以及许多其他事情都很有用。

        它们也反映了 navigation failures 作为第三个参数:

        router.afterEach((to, from, failure) => {
          if (!failure) sendToAnalytics(to.fullPath)
        })
  6. 路由元信息

    1. 有时,你可能希望将任意信息附加到路由上,如过渡名称、谁可以访问路由等。这些事情可以通过接收属性对象的meta属性来实现,并且它可以在路由地址和导航守卫上都被访问到。定义路由的时候你可以这样配置 meta 字段:
      const routes = [
        {
          path: '/posts',
          component: PostsLayout,
          children: [
            {
              path: 'new',
              component: PostsNew,
              // 只有经过身份验证的用户才能创建帖子
              meta: { requiresAuth: true },
            },
            {
              path: ':id',
              component: PostsDetail
              // 任何人都可以阅读文章
              meta: { requiresAuth: false },
            }
          ]
        }
      ]
    2. 那么如何访问这个 meta 字段呢?

      首先,我们称呼 routes 配置中的每个路由对象为 路由记录。路由记录可以是嵌套的,因此,当一个路由匹配成功后,它可能匹配多个路由记录。

      例如,根据上面的路由配置,/posts/new 这个 URL 将会匹配父路由记录 (path: '/posts') 以及子路由记录 (path: 'new')。

      一个路由匹配到的所有路由记录会暴露为 $route 对象(还有在导航守卫中的路由对象)的$route.matched 数组。我们需要遍历这个数组来检查路由记录中的 meta 字段,但是 Vue Router 还为你提供了一个 $route.meta 方法,它是一个非递归合并所有 meta 字段(从父字段到子字段)的方法。这意味着你可以简单地写

      router.beforeEach((to, from) => {
        // 而不是去检查每条路由记录
        // to.matched.some(record => record.meta.requiresAuth)
        if (to.meta.requiresAuth && !auth.isLoggedIn()) {
          // 此路由需要授权,请检查是否已登录
          // 如果没有,则重定向到登录页面
          return {
            path: '/login',
            // 保存我们所在的位置,以便以后再来
            query: { redirect: to.fullPath },
          }
        }
      })

GitHub 加速计划 / vu / vue
207.54 K
33.66 K
下载
vuejs/vue: 是一个用于构建用户界面的 JavaScript 框架,具有简洁的语法和丰富的组件库,可以用于开发单页面应用程序和多页面应用程序。
最近提交(Master分支:2 个月前 )
73486cb5 * chore: fix link broken Signed-off-by: snoppy <michaleli@foxmail.com> * Update packages/template-compiler/README.md [skip ci] --------- Signed-off-by: snoppy <michaleli@foxmail.com> Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com> 4 个月前
e428d891 Updated Browser Compatibility reference. The previous currently returns HTTP 404. 5 个月前
Logo

旨在为数千万中国开发者提供一个无缝且高效的云端环境,以支持学习、使用和贡献开源项目。

更多推荐