1. 创建项目
创建项目现在分为两种途径，Vite 或者 Vue CLI
- Vite
vue 新建项目主推 Vite。
npm init vue@3
- Vue CLI
Vue CLI 是官方提供的基于 Webpack 的 Vue 工具链，它现在处于维护模式。我们建议使用 Vite 开始新的项目，除非你依赖特定的 Webpack 的特性。在大多数情况下，Vite 将提供更优秀的开发体验。
npm install -g @vue/cli
vue create 项目名
cd 项目名
npm run serve
1.1 router-link 和 router-view
通常使用 router-link 代替 <a> 标签进行跳转。
使用 router-view 承载对应路由的组件。
2. 基础
2.1 配置 vue-router
vite.config.js 里，配置了 @ 的路径别名
import { fileURLToPath, URL } from 'node:url'
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [vue()],
resolve: {
alias: {
'@': fileURLToPath(new URL('./src', import.meta.url))
}
}
})
新建 jsconfig.json
{
"include": [
"./src/**/*"
],
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["./src/*"]
}
}
}
新建 router/index.js，键入以下代码
import { createRouter, createWebHistory } from 'vue-router'
import Home from '@/views/Home.vue'
import About from '@/views/About.vue'
const routes = [
{ path: '/', name: 'Home', component: Home },
{ path: '/about', name: 'About', component: About },
]
const router = createRouter({
history: createWebHistory(),
routes
})
export default router
main.js
import router from '@/router'
createApp(App)
.use(router)
.mount('#app')
2.2 HTML 模式 vs Hash 模式
最直观的是 Hash 模式的路由带 “#” 号（hashtag）。
router/index.js - Hash 模式
const router = createRouter({
history: createHashWebHistory(),
routes
})
2.3 懒加载路由
- Vite 写法
router/index.js
import { createRouter, createWebHistory } from 'vue-router'
import Home from '@/views/Home.vue'
const routes = [
{ path: '/', name: 'Home', component: Home },
{ path: '/about', name: 'About', component: () => import('@/views/About.vue')},
]
const router = createRouter({
history: createWebHistory(),
routes
})
export default router
2.4 动态路由 (dynamic routes)
const routes = [
{ path: '/', component: Home },
{ path: '/destination/:id/:slug', component: () => import('@/components/DestinationView.vue')},
]
然后在 DestinationView.vue内，就可以用
this.$route.params.id
获取到动态路由参数。
2.5 具名路由 (named routes)
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/components/DestinationView.vue')
},
]
那么，router-link 可以这样写：
<router-link
:to="{ name: 'destination.show', params: { id: dest.id, slug: dest.slug } }">
</router-link>
2.6 响应路由参数变化
async created() {
const response = await fetch('xxx')
this.destination = await response.json()
this.$watch(
() => this.$route.params,
async () => {
const response = await fetch('xxx')
this.destination = await response.json()
}
)
}
简化一下：
methods: {
async initData() {
const response = await fetch('xxx')
this.destination = await response.json()
}
},
async created() {
this.initData()
this.$watch(
() => this.$route.params, this.initData
)
}
2.7 路由属性 (route props)
主要目的为了解决不同路由在使用相同组件时高耦合，使用router中的props将路由和组件进行耦。
- props 为布尔值
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/components/DestinationView.vue'),
props: true
},
]
DestinationShow.vue
export default {
props: {
id: { type: String, required: true }
}
}
- props 为对象
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/components/DestinationView.vue'),
props: {
newsletterPopup: false,
}
},
]
DestinationShow.vue
export default {
props: {
id: { type: String, required: true },
newsletterPopup: { type: Boolean, required: true }
}
}
- props 为返回对象的函数
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/components/DestinationView.vue'),
props: route => ({ newsletterPopup: someExpression ? true : false })
},
]
DestinationShow.vue
export default {
props: {
id: { type: String, required: true },
newsletterPopup: { type: Boolean, required: true }
}
}
2.8 嵌套路由 (Nested routes)
嵌套路由允许 router-view 嵌套 router-view。
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/components/DestinationView.vue'),
props: route => ({ ...route.params, id: parseInt(route.params.id) }),
children: [
{
path: '/destination/:id/:slug/:experienceSlug',
name: 'experience.show',
components: () => import('@/views/ExperienceShow.vue'),
props: route => ({ ...route.params, id: parseInt(route.params.id) })
}
]
},
]
然后在对应的组件 DestinationView.vue 中嵌入<router-view /> 即可。
3. Vue Router 修饰
3.1 Go Back
<button @click="$router.back()">go back</button>
3.2 Transition 动画
Vue：
<router-view v-slot="{ Component }">
<transition name="fade" mode="out-in">
<component :is="Component" :key="$route.path"></component>
</transition>
</router-view>
CSS：
.fade-enter-active,
.fade-leave-active {
transition: opacity 0.5s ease-out;
}
.fade-enter,
.fade-leave-to {
opacity: 0;
}
具体可参考Vue官方 Transition 页面。
3.3 - 404 Not Found 页面
views/NotFound.vue
<template>
<div>
<h1>Not Found</h1>
<p>
Oops, we couldn't find that page. Try going
<router-link to="/">home</router-link>
</p>
</div>
</template>
router/index.js
const routes = [
...,
{
path: '/:pathMatch(.*)*',
name: 'NotFound',
component: () => import('@/views/NotFound.vue')
}
]
但是，对于/destination/33/somewhat这种路由虽然符合规则，但是不存在 id=33 的这种情况，上面的 404 是不会匹配到的，这时需要导航守卫（Router Guards）。
3.4 导航守卫
vue-router 提供的导航守卫主要用来通过跳转或取消的方式守卫导航。这里有很多方式植入路由导航中：全局的，单个路由独享的，或者组件级的。
router/index.js
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/destination/:id/:slug',
name: 'destination.show',
component: () => import('@/views/DestinationShow.vue'),
props: route => ({ ...route.params, id: parseInt(route.params.id) }),
beforeEnter (to, from) {
const exists = sourceData.destinations.find(
destination => destination.id === parseInt(to.params.id)
)
if (!exists) return {
name: 'NotFound',
params: { pathMatch: to.path.split('/').slice(1) },
query: to.query,
hash: to.hash
}
}
},
]
3.5 页面滚动 (Scroll Behavior)
切换页面时始终滚动至顶部：
const router = createRouter({
history: createWebHistory(),
routes,
scrollBehavior(to, from, savedPosition) {
// 始终滚动到顶部
return { top: 0 }
},
})
相对元素偏移量：
return {
// 也可以这么写
// el: document.getElementById('main'),
el: '#main',
top: -10,
}
返回 savedPosition，在按下 后退/前进 按钮时，就会像浏览器的原生表现那样：
if (savedPosition) {
return savedPosition
} else {
return { top: 0 }
}
上次记忆，或者延迟滚动至顶：
const router = createRouter({
history: createWebHistory(),
routes,
scrollBehavior (to, from, savedPosition) {
return savedPosition || new Promise((resolve) => {
setTimeout(() => resolve({ top: 0, behavior: 'smooth' }), 500)
})
}
})
3.6 路由元信息
路由元信息可以是任意自定义信息。通常元信息用于两个用途：keep-alive 和 requiresAuth。
const routes = [
{ path: '/', name: 'Home', component: Home },
{
path: '/protected',
name: 'protected',
component: () => import('@/views/Protected.vue'),
meta: {
requiresAuth: true
}
}
]
...
router.beforeEach((to, from) => {
if (to.meta.requiresAuth && !loginLogic) {
return { name: 'login'}
}
})
3.7 路由参数 (Router Query Params)
路由参数就是路由里，?后面的参数。
https://localhost:1234/login?redirect=/invoices
然后就可以
this.$router.query.redirect
获取参数。
