Vue Router入门--基础

我会带着你远行 2022-01-23 13:07 280阅读 0赞

**目录**

介绍

基础

动态路由匹配

嵌套路由

编程式的导航

命名路由

命名视图

重定向和别名

路由组件传参

HTML5 History 模式

--------------------

## 介绍 ##

Vue Router是Vue.js官方的路由管理器。它和Vue.js的核心深度集成，让构建单页面应用变得易如反掌。包含的功能有：

*  嵌套的路由/视图表
 *  模块化的、基于组件的路由配置
 *  路由参数、查询、通配符
 *  基于Vue.js过渡系统的视图过渡效果
 *  细粒度的导航控制
 *  带有自动激活的CSS class的链接
 *  HTML5历史模式或hash模式，在IE9中自动降级
 *  自定义的滚动条行为

## 基础 ##

**起步**

使用Vue.js，我们已经可以通过组合组件来组成应用程序，当你要把Vue Router添加进来，我们需要做的是，将组件(components)

映射到路由(routes),然后告诉Vue Router在哪里渲染它们。

### **动态路由匹配** ###

我们经常需要把某种模式匹配到的所有路由，全部映射到同个组件。例如，我们有一个User组件，对于所有ID各不相同的用户，都要使用这个组件来渲染。那么，我们可以在vue-router的路由路径中使用“动态路径参数”(dynamic segment)来达到这个效果：

const User = {
      template: '<div>User</div>'
    }
    
    const router = new VueRouter({
      routes: [
        // 动态路径参数 以冒号开头
        { path: '/user/:id', component: User }
      ]
    })

现在呢，像/user/foo和/user/bar都映射到相同的路由。

一个“路由参数”使用冒号：标记。当匹配到一个路由时，参数值会被设置到this.$route.params中，例如

<table style="width:500px;"> 
 <thead> 
  <tr> 
   <th>模式</th> 
   <th>匹配路径&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;</th> 
   <th>$route.params</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>/user/:username</td> 
   <td>/user/evan</td> 
   <td>{username: 'evan'}</td> 
  </tr> 
  <tr> 
   <td>/user/:username/post/:post_id</td> 
   <td>/user/evan/post/123</td> 
   <td>{username: 'evan',post_id: '123'}</td> 
  </tr> 
 </tbody> 
</table>

除了$route.params外，$route对象还提供了其他有用的信息，例如，$route.query（如果URL中查询参数）、$route.hash等等。

**响应路由参数的变化**

提醒一下，当使用路由参数时，例如从/user/foo导航到/user/bar,**原来的组件实例会被复用**。因为两个路由都渲染同个组件，比起销毁再创建，复用则显得更加高效。不过，**这也意味着组件的生命周期钩子不会再被调用。**

复用组件时，想对路由参数的变化作出响应的话，你可以简单地watch(监测变化)$route对象：

const User = {
      template: '...',
      watch: {
        '$route' (to, from) {
          // 对路由变化作出响应...
        }
      }
    }

或者使用2.2中引入的 beforeRouteUpdate 导航守卫：

const User = {
      template: '...',
      beforeRouteUpdate (to, from, next) {
        // react to route changes...
        // don't forget to call next()
      }
    }

**捕获所有路由或404 Not found路由**

常规参数只会匹配被 / 分隔的URL片段中的字符。如果想匹配任意路径，我们可以使用通配符(\*):

{
      // 会匹配所有路径
      path: '*'
    }
    {
      // 会匹配以 `/user-` 开头的任意路径
      path: '/user-*'
    }

当使用通配符时，请确保路由的顺序是正确的，也就是说含有通配符的路由应该放在最后。路由 \{ path: '\*'\}通常用于客户端404错误。如果你使用了History模式，请确保正确配置你的服务器。

当使用一个通配符时，$route.params内会自动添加一个名为 pathMatch 参数。它包含了 URL通过通配符被匹配的部分：

// 给出一个路由 { path: '/user-*' }
    this.$router.push('/user-admin')
    this.$route.params.pathMatch // 'admin'
    // 给出一个路由 { path: '*' }
    this.$router.push('/non-existing')
    this.$route.params.pathMatch // '/non-existing'

**高级匹配模式**

vue-router使用path-to-regexp作为路径匹配引擎，所以支持很多高级的匹配模式。例如：可选的动态路径参数、匹配零个或多个、一个或多个，甚至是自定义正则匹配

import Vue from 'vue'
    import VueRouter from 'vue-router'
    
    Vue.use(VueRouter)
    
    // The matching uses path-to-regexp, which is the matching engine used
    // by express as well, so the same matching rules apply.
    // For detailed rules, see https://github.com/pillarjs/path-to-regexp
    const router = new VueRouter({
      mode: 'history',
      base: __dirname,
      routes: [
        { path: '/' },
        // params are denoted with a colon ":"
        { path: '/params/:foo/:bar' },
        // a param can be made optional by adding "?"
        { path: '/optional-params/:foo?' },
        // a param can be followed by a regex pattern in parens
        // this route will only be matched if :id is all numbers
        { path: '/params-with-regex/:id(\\d+)' },
        // asterisk can match anything
        { path: '/asterisk/*' },
        // make part of the path optional by wrapping with parens and add "?"
        { path: '/optional-group/(foo/)?bar' }
      ]
    })
    
    new Vue({
      router,
      template: `
        <div id="app">
          <h1>Route Matching</h1>
          <ul>
            <li><router-link to="/">/</router-link></li>
            <li><router-link to="/params/foo/bar">/params/foo/bar</router-link></li>
            <li><router-link to="/optional-params">/optional-params</router-link></li>
            <li><router-link to="/optional-params/foo">/optional-params/foo</router-link></li>
            <li><router-link to="/params-with-regex/123">/params-with-regex/123</router-link></li>
            <li><router-link to="/params-with-regex/abc">/params-with-regex/abc</router-link></li>
            <li><router-link to="/asterisk/foo">/asterisk/foo</router-link></li>
            <li><router-link to="/asterisk/foo/bar">/asterisk/foo/bar</router-link></li>
            <li><router-link to="/optional-group/bar">/optional-group/bar</router-link></li>
            <li><router-link to="/optional-group/foo/bar">/optional-group/foo/bar</router-link></li>
          </ul>
          <p>Route context</p>
          <pre>{
       { JSON.stringify($route, null, 2) }}</pre>
        </div>
      `
    }).$mount('#app')

**匹配优先级**

有时候，同一个路径可以匹配多个路由，此时，匹配的优先级就按照路由的定义顺序：谁先定义的，谁的优先级就最高。

### 嵌套路由 ###

实际的应用界面，通常由多层嵌套的组件组合而成。同样地，URL中各段动态路径也按某种结构对应嵌套的各层组件，例如：

/user/foo/profile                     /user/foo/posts
    +------------------+                  +-----------------+
    | User             |                  | User            |
    | +--------------+ |                  | +-------------+ |
    | | Profile      | |  +------------>  | | Posts       | |
    | |              | |                  | |             | |
    | +--------------+ |                  | +-------------+ |
    +------------------+                  +-----------------+

借助vue-router ，使用嵌套路由配置，就可以很简单地表达这种关系。

接着上节创建地app：

const User = {
      template: '<div>User {
       { $route.params.id }}</div>'
    }
    
    const router = new VueRouter({
      routes: [
        { path: '/user/:id', component: User }
      ]
    })

这里的<router-view>是最顶层的出口，渲染最高级路由匹配到的组件。同样地，一个被渲染组件同样可以包含自己的嵌套 <router-view>。例如，在 User 组件的模板添加一个 <router-view>

const User = {
      template: `
        <div class="user">
          <h2>User {
       { $route.params.id }}</h2>
          <router-view></router-view>
        </div>
      `
    }

要在嵌套的出口中渲染组件，需要在VueRouter的参数中使用children配置：

const router = new VueRouter({
      routes: [
        { path: '/user/:id', component: User,
          children: [
            {
              // 当 /user/:id/profile 匹配成功，
              // UserProfile 会被渲染在 User 的 <router-view> 中
              path: 'profile',
              component: UserProfile
            },
            {
              // 当 /user/:id/posts 匹配成功
              // UserPosts 会被渲染在 User 的 <router-view> 中
              path: 'posts',
              component: UserPosts
            }
          ]
        }
      ]
    })

**要注意，以 / 开头的嵌套路径会被当做根路径。这让你充分的使用嵌套组件而无须设置嵌套的路径**

你会发现，children配置就像是routes配置一样的路由配置数组，所有呢，你可以嵌套多层路由。

此时，基于上面的配置，当你访问 /user/foo 时，User的出口是不会渲染任何东西的，这是因为没有匹配到合适的子路由。如果你想要渲染点什么，可以提供一个空的子路由：

const router = new VueRouter({
      routes: [
        {
          path: '/user/:id', component: User,
          children: [
            // 当 /user/:id 匹配成功，
            // UserHome 会被渲染在 User 的 <router-view> 中
            { path: '', component: UserHome },
    
            // ...其他子路由
          ]
        }
      ]
    })

### 编程式的导航 ###

除了使用<router-link>创建a标签来定义导航链接，我们还可以借助router的实例，通过编写代码来实现。

router.push(location, onComplete?, onAbort?)

**注意：在Vue实例内部，你可以通过 $router访问路由实例。因此你可以调用 this.$router.push.**

想要导航到不同的URL，则使用 router.push 方法。这个方法会向history栈添加一个新纪录，所以，当用户点击浏览器后退按钮时，则回到之前的URL。

当点击 <router-link> 时，这个方法会在内部调用。所以说，点击 <router-link :to="...">等同于调用router.push(...).

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>声明式</td> 
   <td>编程式</td> 
  </tr> 
  <tr> 
   <td>&lt;router-link :to="..."&gt;</td> 
   <td>router.push(...)</td> 
  </tr> 
 </tbody> 
</table>

该方法的参数可以是一个字符串路径，或者一个描述地址的对象，例如：

// 字符串
    router.push('home')
    
    // 对象
    router.push({ path: 'home' })
    
    // 命名的路由
    router.push({ name: 'user', params: { userId: '123' }})
    
    // 带查询参数，变成 /register?plan=private
    router.push({ path: 'register', query: { plan: 'private' }})

**注意：如果提供了path，params会被忽略，上述例子中的query并不属于这种情况。取而代之的是下面例子的做法，你需要提供路由的name或手写完整的带有参数的path：**

const userId = '123'
    router.push({ name: 'user', params: { userId }}) // -> /user/123
    router.push({ path: `/user/${userId}` }) // -> /user/123
    // 这里的 params 不生效
    router.push({ path: '/user', params: { userId }}) // -> /user

path-query，name-params

同样的规则也适用于 router-link 组件的to属性

在 2.2.0+，可选的在 router.push 或 router.replace 中提供 onComplete 和 onAbort 回调作为第二个和第三个参数。这些回调将会在导航成功完成 (在所有的异步钩子被解析之后) 或终止 (导航到相同的路由、或在当前导航完成之前导航到另一个不同的路由) 的时候进行相应的调用。

**注意：**如果目的地和当前路由相同，只有参数发生了改变(比如从一个用户资料到另一个 /users/1 \-> /users/2),你需要使用beforeRouteUpdate来响应这个变化(比如抓取用户信息)

router.replace(location, onComplete?, onAbort?)

跟router.push很像，唯一的不同就是，它不会向history添加新纪录，而是跟它的方法名一样---替换掉当前的history记录。

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>声明式</td> 
   <td>编程式</td> 
  </tr> 
  <tr> 
   <td>&lt;router-link :to="..." replace&gt;</td> 
   <td>router.replace(...)</td> 
  </tr> 
 </tbody> 
</table>

**router.go(n)**

这个方法的参数是一个整数，意思是在history记录中向前或者后退多少步，类似于window.history.go(n).

例子：

// 在浏览器记录中前进一步，等同于 history.forward()
    router.go(1)
    
    // 后退一步记录，等同于 history.back()
    router.go(-1)
    
    // 前进 3 步记录
    router.go(3)
    
    // 如果 history 记录不够用，那就默默地失败呗
    router.go(-100)
    router.go(100)

**操作History**

你也许注意到 router.push、 router.replace 和 router.go 跟 window.history.pushState、 window.history.replaceState 和 window.history.go好像， 实际上它们确实是效仿 window.history API 的。 因此，如果你已经熟悉 Browser History APIs，那么在 Vue Router 中操作 history 就是超级简单的。 还有值得提及的，Vue Router 的导航方法 (push、 replace、 go) 在各类路由模式 (history、 hash 和 abstract) 下表现一致。

### 命名路由 ###

有时候，通过一个名称来标识一个路由显得更方便一些，特别是在链接一个路由，或者是执行一些跳转的时候。你可以在创建Router实例的时候，在routes配置中给某个路由设置名称。

const router = new VueRouter({
      routes: [
        {
          path: '/user/:userId',
          name: 'user',
          component: User
        }
      ]
    })

要链接到一个命名路由，可以给 router-link 的 to 属性传一个对象：

<router-link :to="{ name: 'user', params: { userId: 123 }}">User</router-link>

这跟代码调用 router.push() 是一回事：

router.push({ name: 'user', params: { userId: 123 }})

这两种方式都会把路由导航到 /user/123 路径

### 命名视图 ###

有时候想同时 (同级) 展示多个视图，而不是嵌套展示，例如创建一个布局，有 sidebar (侧导航) 和 main (主内容) 两个视图，这个时候命名视图就派上用场了。你可以在界面中拥有多个单独命名的视图，而不是只有一个单独的出口。如果 router-view 没有设置名字，那么默认为 default。

<router-view class="view one"></router-view>
    <router-view class="view two" name="a"></router-view>
    <router-view class="view three" name="b"></router-view>

一个视图使用一个组件渲染，因此对于同个路由，多个视图就需要多个组件。确保正确使用 components配置(带上s)：

const router = new VueRouter({
      routes: [
        {
          path: '/',
          components: {
            default: Foo,
            a: Bar,
            b: Baz
          }
        }
      ]
    })

**嵌套命名视图**

我们也有可能使用命名视图创建嵌套视图的复杂布局。这时你也需要命名用到的嵌套 router-view 组件。我们以一个控制面板为例：

/settings/emails                                       /settings/profile
    +-----------------------------------+                  +------------------------------+
    | UserSettings                      |                  | UserSettings                 |
    | +-----+-------------------------+ |                  | +-----+--------------------+ |
    | | Nav | UserEmailsSubscriptions | |  +------------>  | | Nav | UserProfile        | |
    | |     +-------------------------+ |                  | |     +--------------------+ |
    | |     |                         | |                  | |     | UserProfilePreview | |
    | +-----+-------------------------+ |                  | +-----+--------------------+ |
    +-----------------------------------+

*  Nav 只是一个常规组件
 *  UserSettings 是一个视图组件
 *  UserEmailsSubscriptions、UserProfile、UserProfilePreview是嵌套的视图组件

**注意：**我们先忘记HTML/CSS具体的布局的样子，只专注在用到的组件上

UserSettings 组件的 <template> 部分应该是类似下面的这段代码：

<div>
      <h1>User Settings</h1>
      <NavBar/>
      <router-view/>
      <router-view name="helper"/>
    </div>

然后你可以用这个路由配置完成该布局：

{
      path: '/settings',
      // 你也可以在顶级路由就配置命名视图
      component: UserSettings,
      children: [{
        path: 'emails',
        component: UserEmailsSubscriptions
      }, {
        path: 'profile',
        components: {
          default: UserProfile,
          helper: UserProfilePreview
        }
      }]
    }

### 重定向和别名 ###

**重定向**

重定向也是通过 routes 配置来完成，下面例子是从 /a 重定向到 /b：

const router = new VueRouter({
      routes: [
        { path: '/a', redirect: '/b' }
      ]
    })

重定向的目标也可以是一个命名的路由：

const router = new VueRouter({
      routes: [
        { path: '/a', redirect: { name: 'foo' }}
      ]
    })

甚至是一个方法，动态返回重定向目标：

const router = new VueRouter({
      routes: [
        { path: '/a', redirect: to => {
          // 方法接收 目标路由 作为参数
          // return 重定向的 字符串路径/路径对象
        }}
      ]
    })

注意导航守卫并没有应用在跳转路由上，而仅仅应用在其目标上。在下面这个例子中，为 /a 路由添加一个beforeEach 或boforeLeave守卫并不会由任何效果。

**别名**

“重定向”的意思是，当用户访问 /a 时，URL将会被替换成 /b ，然后匹配路由为 /b ，那么 "别名"又是什么呢？

**`/a` 的别名是 `/b`，意味着，当用户访问 `/b` 时，URL 会保持为 `/b`，但是路由匹配则为 `/a`，就像用户访问 `/a`一样。**

上面对应的路由配置为：

const router = new VueRouter({
      routes: [
        { path: '/a', component: A, alias: '/b' }
      ]
    })

“别名”的功能让你可以自由地将 UI 结构映射到任意的 URL，而不是受限于配置的嵌套路由结构。

### 路由组件传参 ###

在组件中使用 $route 会使之与其对应路由形成高度耦合，从而使组件只能在某些特定的URL上使用，限制了其灵活性。

使用props 将组件和路由解耦：

**取代与** $route **的耦合**

const User = {
      template: '<div>User {
       { $route.params.id }}</div>'
    }
    const router = new VueRouter({
      routes: [
        { path: '/user/:id', component: User }
      ]
    })

**通过** props **解耦**

const User = {
      props: ['id'],
      template: '<div>User {
       { id }}</div>'
    }
    const router = new VueRouter({
      routes: [
        { path: '/user/:id', component: User, props: true },
    
        // 对于包含命名视图的路由，你必须分别为每个命名视图添加 `props` 选项：
        {
          path: '/user/:id',
          components: { default: User, sidebar: Sidebar },
          props: { default: true, sidebar: false }
        }
      ]
    })

这样你便可以在任何地方使用该组件，使得该组件更易于重用和测试。

**布尔模式**

如果 `props` 被设置为 `true`，`route.params` 将会被设置为组件属性。

**对象模式**

如果 `props` 是一个对象，它会被按原样设置为组件属性。当 `props` 是静态的时候有用。

const router = new VueRouter({
      routes: [
        { path: '/promotion/from-newsletter', component: Promotion, props: { newsletterPopup: false } }
      ]
    })

**函数模式**

你可以创建一个函数返回 `props`。这样你便可以将参数转换成另一种类型，将静态值与基于路由的值结合等等。

const router = new VueRouter({
      routes: [
        { path: '/search', component: SearchUser, props: (route) => ({ query: route.query.q }) }
      ]
    })

URL `/search?q=vue` 会将 `{query: 'vue'}` 作为属性传递给 `SearchUser` 组件。

请尽可能保持 `props` 函数为无状态的，因为它只会在路由发生变化时起作用。如果你需要状态来定义 `props`，请使用包装组件，这样 Vue 才可以对状态变化做出反应。

### HTML5 History 模式 ###

vue-router默认hash模式---使用URL的hash来模拟一个完整的URL，于是当URL改变时，页面不会重新加载

如果不想要很丑的hash，我们可以用路由的history**模式，**这种模式充分利用 history.pushState API来完成URL跳转而无须重新加载页面。

const router = new VueRouter({
      mode: 'history',
      routes: [...]
    })

当你使用history模式时，URL就像正常的url，例如 http://yoursite.com/user/id，也好看！

不过这种模式要玩好，还需要后台配置支持。因为我们的应用是个单页客户端应用，如果后台没有正确的配置，当用户在浏览器直接访问 http://oursite.com/user/id 就会返回 404，这就不好看了。 所以呢，你要在服务端增加一个覆盖所有情况的候选资源：如果 URL 匹配不到任何静态资源，则应该返回同一个 index.html 页面，这个页面就是你 app 依赖的页面。