说明:
vue前端开发可能使用的一个模块,用于页面跳转
- 官方文档:https://router.vuejs.org/zh/introduction.html
1. 常用方法
(1)vue-router
方法 | 说明 |
---|---|
createRouter | router工厂,对router进行配置。返回router |
createWebHashHistory | vue-router历史记录对象工厂,对router中history属性进行配置。(访问的路由中自带#号) |
createWebHistory | 说明:vue-router历史记录对象工厂,对router中history属性进行配置。(访问的路由中不带#号) |
useRouter | 获取router,setup()中使用 |
useRoute | 获取route,setup()中使用 |
onBeforeRouteUpdate | 导航钩子,在当前位置即将更新时触发。只能在vue 文件setup()内进行实现。 |
(2)router
- router : vue-router的属性,可通过createRouter(),useRouter()实例化或直接this.$router获取
方法 | 说明 |
---|---|
beforeEach(to,from,next) | router钩子,在任何导航前执行,一般在配置文件中设置;可用于进行权限验证 (如:点某页面时,判断是否登录,未登录则跳转到登录界面)示例1 |
afterEach(to,from,failure) | router钩子,每次导航执行后调用,一般在配置文件中设置;示例2 |
push(to) | 通过在历史堆栈中推送一个 entry,以编程方式导航到一个新的 URL。示例3 |
path name meta.元数据名 params.属性名 | 示例4 |
1)示例1
- 说明:beforeEach(to,from,next)登录判断示例
// beforeEach方法重写
router.beforeEach((to, from, next) => {
// to : 要去哪的route对象
// from : 来自哪的route对象
// next: 导航守卫next对象,此处用于设置接下来要跳转的页面 next(routes中path)
document.title = `${to.meta.title} | vue-manage-system`;
// localStorage 为 OM API 在 Login.vue 中设置了值
// ms_username key的值为登录的username
const role = localStorage.getItem('ms_username');
if (!role && to.path !== '/login') {
next('/login');
} else if (to.meta.permission) {
// 如果是管理员权限则可进入,这里只是简单的模拟管理员权限而已
role === 'admin'
? next()
: next('/403');
} else {
next();
}
});
2)示例2
- 说明:afterEach(to,from,failure)示例
// afterEach方法重写
router.afterEach((to, from, failure) => {
// to : 要去哪的route属性
// from : 来自哪的route属性
// failure : 错误信息属性
if (isNavigationFailure(failure)) {
console.log('failed navigation', failure)
}
})
3)示例3
- 说明:push(to)示例
// push方法调用
import { useRouter } from "vue-router";
const router = useRouter()
// to : 要去哪的route属性
router.push(to)
// 直接写路径path,根据path跳转
router.push({path: 'home'})
router.push('home') //
// 根据name跳转
router.push({ name: 'user', params: { userId: 123 }})
4)示例4
// 调用
import { useRoute } from "vue-router";
const route = useRoute()
route.path // 设置获取 route的path值
route.name // 略
route.meta.元数据名 // 略
route.params.属性名 // 略
2. vue-router的标签
(1)<router-link>
<router-link to="xxx"></router-link>
// 相当于 a标签
// to="{name='路由路径',params:{json数据}}" 或 to="路由路径"
(2)<router-view>
- 说明:视图标签,
<router-link>
访问组件页面显示位置占位标签(相当于占位符)
1)命名视图
- 应用场景:有时候想同时 (同级) 展示多个视图,而不是嵌套展示,例如创建一个布局,有
sidebar
(侧导航) 和main
(主内容) 两个视图,这个时候命名视图就派上用场了。你可以在界面中拥有多个单独命名的视图,而不是只有一个单独的出口。如果router-view
没有设置名字,那么默认为default
。
<router-view class="view left-sidebar" name="LeftSidebar"></router-view>
<router-view class="view main-content"></router-view>
<router-view class="view right-sidebar" name="RightSidebar"></router-view>
2)示例
<!-- 示例1 -->
<router-view />
<!-- 示例2 -->
<router-view class="view left-sidebar" name="LeftSidebar"></router-view>
<!-- 示例3 -->
<router-view v-slot="{ Component }">
<transition name="move" mode="out-in">
<!-- 设置 保持生存状态的组件,避免路由跳转后,原视图组件内数据丢失-->
<!-- include接收一个数组 ,其内元素为routes中的name值-->
<keep-alive :include="xxx">
<component :is="Component" />
</keep-alive>
</transition>
</router-view>
<!--
说明:`<router-view>` 暴露了一个 `v-slot` API,主要使用 `<transition>` 和 `<keep-alive>` 组件来包裹你的路由组件。
`Component`: 要传递给 `<component>` 的 VNodes `是` prop。
`route`: 当前新跳转页面的route对象。`route.meta.transition`未定义默认为`default`
`name`:命名视图,默认为 `default`
`include`:设置 保持生存状态的组件,避免路由跳转后,原视图组件内数据丢失
`is`:设置,要加载的视图组件Component
-->
3. 应用
(1)安装
npm install vue-router --save-dev
(2)配置文件格式
- 文件名:index.js
- 位置:src/config/router
import {createRouter, createWebHistory} from "vue-router";
const routes = [
{
path: "/",
name: "Home",
component: "../views/Home.vue",
// 地址重定向
redirect: '/dashboard',
children: [
{
path: "/dashboard",
name: "dashboard",
meta: {
title: '系统首页'
},
component: () => import ("../views/Dashboard.vue")
}
]
},
{path: '*',component: "../views/404.vue"}
];
const router = createRouter({
history: createWebHistory(),
routes: routes
});
router.beforeEach((to, from, next) => {
// to : 要去哪的route对象
// from : 来自哪的route对象
// next: 导航守卫,此处用于设置接下来要跳转的页面
});
export default router;
(3)挂载
- 文件:main.js
import { createApp } from 'vue'
import App from './App.vue'
import router from './router' // 目录路径,自动扫描目录下配置文件
let app =createApp(App);
app.use(router);
app.mount('#app');
(4)使用
// ----------------视图层-----------
<router-link to="xxx"></router-link>
// 相当于 a标签
// to="{name='路由路径',params:{json数据}}" 或 to="路由路径"
<router-view></router-view> // <router-link>访问组件页面显示位置占位标签(相当于占位符)
// ----------模型层-----------
// 导入
import {useRoute,useRouter} from 'vue-router'
this.$router.xx
this.$route.xx
const route = useRoute()
const router = useRouter()
4. 示例
说明
-
有5个组件,分别为,App.vue(已存在不用新建), Main首页页面组件,messageSelect内容选择组件,messageOne内容组件和messageOne内容组件。
-
为三层路由嵌套
vue-router
(1)基本步骤
- 安装模组
- 新建4个组件
- 配置vue-router:自定义配置文件
- 挂载vue- router配置:编写main.js
- 页面编写:编写App.vue
(2)安装
npm install vue-router --save-dev
(3)新建组件
- 文件名:Main.vue和Message.vue
- 位置:component目录下
<!-- Main.vue 首页页面组件 -->
<template>
<h1>首页</h1>
</template>
<script>
</script>
<style>
</style>
<!-- MessageSelect.vue messageSelect页面组件 -->
<template>
<h1>MessageSelect</h1>
<router-link to="/messageOne">查看信息1</router-link>-
<router-link to="/messageTwo">查看信息2</router-link>
<router-view></router-view>
</template>
<script>
</script>
<style>
</style>
<!-- MessageOne.vue messageOne页面组件 -->
<template>
<h2>信息1</h2>
</template>
<script>
</script>
<style>
</style>
<!-- MessageTwo.vue messageTwo页面组件 -->
<template>
<h2>信息2</h2>
</template>
<script>
</script>
<style>
</style>
(4)配置
- 文件名:index.js
- 位置:根目录/router/
/* 路由配置 */
import Vue from "vue"
import {createRouter,createWebHistory} from "vue-router"
import MessageSelect from "../components/MessageSelect.vue"
import Main from "../components/Main.vue"
import MessageOne from "../components/MessageOne.vue"
import MessageTwo from "../components/MessageTwo.vue"
// 配置导出对象
const router = createRouter({
history: createWebHistory(),
routes: [
{
path: '',
component: Main,
children:[ // 子路由,该路由组件下有其他路由组件时使用
{
// 路由路径, 访问路径
path: '/message',
// 路径组件
component: MessageSelect,
children:[ // 子路由,该路由组件下有其他路由组件时使用
{path: '/messageOne',component: MessageOne},
{path: '/messageTwo',component: MessageTwo}
]
}
]
}
]
})
export default router
(5)挂载
- 文件名:main.js
import { createApp } from 'vue'
import App from './App.vue'
import router from './router' // 目录路径,自动扫描目录下配置文件
let app =createApp(App);
app.use(router);
app.mount('#app');
(6)页面编写
- 文件名:app.vue
<template>
<div id="app">
<router-view></router-view>
</div>
</template>
<script>
export default {
name: 'App'
}
</script>
<style>
#app {
font-family: Avenir, Helvetica, Arial, sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-align: center;
color: #2c3e50;
margin-top: 60px;
}
</style>
(7)路由传值
注意:有些是route有些是router
1)方式一
- 说明:router-link路由导航方式
适用于传递少量参数时
// 父组件
<router-link to = "/跳转路径/传入的参数"></router-link>
// 或
<router-link to = "/跳转路径" params="{num:值}"></router-link>
// 路由配置
{path: '/跳转路径/:num', name: A, component: A, props:true}
// 子组件 获取
<template>
<div>
// 子组件 template模板中直接使用
{{this.$route.params.num}}
// 或 若路由配置有props:true
{{num}}
</div>
</template>
<script>
export default {
// 或 若路由配置有props:true
props: ['num'],
name: "xxx",
methods:{
// 或 script函数中调用
func(){
let result = this.$route.params.num;
}
}
}
</script>
2)方式二
- 说明:调用$router.push路径传参方式
// 父组件
<button @click="deliverParams(123)">push传参</button>
methods: {
deliverParams (id) {
this.$router.push({
path: `/跳转路径/${id}`
})
}
}
// 路由配置
{path: '/跳转路径/:num', name: A, component: A, props:true}
// 子组件 获取
<template>
<div>
// 子组件 template模板中直接使用
{{this.$route.params.num}}
// 或 若路由配置有props:true
{{num}}
</div>
</template>
<script>
export default {
// 或 若路由配置有props:true
props: ['num'],
name: "xxx",
methods:{
// 或 script函数中调用
func(){
let result = this.$route.params.num;
}
}
}
</script>
3)方式三
- 说明:调用$router.push用params传参
<button @click="deliverByName()">params传参</button>
deliverByName () {
this.$router.push({
name: '跳转路径',
params: {
num: 123
}
})
}
// 路由配置
{path: '/跳转路径/', name: A, component: A, props:true}
// 子组件 获取
<template>
<div>
// 子组件 template模板中直接使用
{{this.$route.params.num}}
// 或 若路由配置有props:true
{{num}}
</div>
</template>
<script>
export default {
// 或 若路由配置有props:true
props: ['num'],
name: "xxx",
methods:{
// 或 script函数中调用
func(){
let result = this.$route.params.num;
}
}
}
</script>
4)方式四
- 说明:调用$router.push用query传参
<button @click="deliverByName()">params传参</button>
deliverByName () {
this.$router.push({
name: '跳转路径',
query: {
num: 123
}
})
}
// 路由配置
{path: '/跳转路径/', name: A, component: A, props:true}
// 子组件 获取
<template>
<div>
// 子组件 template模板中直接使用
{{this.$route.params.num}}
// 或 若路由配置有props:true
{{num}}
</div>
</template>
<script>
export default {
// 或 若路由配置有props:true
props: ['num'],
name: "xxx",
methods:{
// 或 script函数中调用
func(){
let result = this.$route.params.num;
}
}
}
</script>