# vue3动态路由

**Repository Path**: micefind/vue3-dynamic-routing

## Basic Information

- **Project Name**: vue3动态路由
- **Description**: 开发后台管理系统时，有时后端会根据权限返回不同的菜单列表，前端需要异步获取数据然后实时生成路由配置。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-21
- **Last Updated**: 2025-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pinia 与 Vue-Router 完美协作实现vue3动态路由

### 前言

开发后台管理系统时，有时后端会根据权限返回不同的菜单列表，前端需要异步获取数据然后实时生成路由配置。

在vue3项目中，我们使用pinia、vue-router实现动态路由，关键步骤如下：

1. 异步请求获取路由接口数据；
2. pinia状态管理保存路由信息；
3. vue-router实现路由配置；
4. 动态添加路由。

### 1 异步请求获取路由接口数据

```
// /src/api/route.js
export const getRouteList = () => {
  // 模拟异步请求
  return new Promise((resolve) => {
    setTimeout(() => {
      resolve([
        {
          name: "home",
          path: "/home",
          meta: { title: "首页" },
        },
        {
          name: "user",
          path: "/user",
          meta: { title: "用户" },
        },
      ])
    }, 1000)
  })
}
```



### 2 pinia状态管理保存路由信息

```
// /src/store/route.js
import { defineStore } from "pinia"

export const useRouteStore = defineStore("route", {
  state: () => ({
    routeList: sessionStorage.getItem("routeList")
      ? JSON.parse(sessionStorage.getItem("routeList"))
      : [],
    isUpdate: false,
  }),
  actions: {
    updateRouteList(routeList) {
      this.routeList = routeList
      sessionStorage.setItem("routeList", JSON.stringify(routeList))
      this.isUpdate = true
    },
  },
  getters: {},
})
```



### 3 vue-router实现路由配置

```
import { createRouter, createWebHashHistory } from "vue-router"

// 定义基本路由配置
const routes = [
  {
    path: "/:pathMatch(.*)",
    meta: { title: "404" },
    name: "404",
    component: () => import("@/views/error/404.vue"),
  },
  {
    path: "/login",
    name: "login",
    component: () => import("@/views/login/Login.vue"),
    meta: { title: "登录" },
  },
  {
    path: "/",
    name: "layout",
    component: () => import("@/views/layout/Layout.vue"),
    redirect: "/home",
    children: [], // 初始时没有子路由
  },
]

export const router = createRouter({
  history: createWebHashHistory(import.meta.env.BASE_URL),
  routes,
})

// 路由守卫，用于处理路由跳转前的逻辑
router.beforeEach(async (to, from, next) => {
  // 判断是否已登录且没有 token，未登录时重定向到登录页
  const token = localStorage.getItem("token")
  if (to.path !== "/login" && !token) {
    return next({ name: "login" })
  }
  next()
})
```



### 4 动态添加路由

核心代码

```
router.addRoute("layout", {
	path: item.path,
	name: item.name,
	component: () => import(`@/views/${item.name}/index.vue`),
})
```

完整代码

```
// /src/router/index.js
import { createRouter, createWebHashHistory } from "vue-router"
import { useRouteStore } from "@/store/route"
import { getRouteList } from "@/api/route"

// 定义基本路由配置
const routes = [
  {
    path: "/:pathMatch(.*)",
    meta: { title: "404" },
    name: "404",
    component: () => import("@/views/error/404.vue"),
  },
  {
    path: "/login",
    name: "login",
    component: () => import("@/views/login/Login.vue"),
    meta: { title: "登录" },
  },
  {
    path: "/",
    name: "layout",
    component: () => import("@/views/layout/Layout.vue"),
    redirect: "/home",
    children: [], // 初始时没有子路由
  },
]

export const router = createRouter({
  history: createWebHashHistory(import.meta.env.BASE_URL),
  routes,
})

// 添加动态路由
const addRoute = () => {
  const routeStore = useRouteStore()
  if (routeStore.isUpdate) {
    routeStore.routeList.forEach((item) => {
      if (!router.hasRoute(item.name)) {
        router.addRoute("layout", {
          path: item.path,
          name: item.name,
          component: () => import(`@/views/${item.name}/index.vue`),
        })
      }
    })
    routeStore.isUpdate = false
  }
}

// 初始化路由
export const initRouter = async () => {
  let routeList = sessionStorage.getItem("routeList")
    ? JSON.parse(sessionStorage.getItem("routeList"))
    : await getRouteList()
  const routeStore = useRouteStore()
  routeStore.updateRouteList(routeList)
  addRoute()
}

// 路由守卫，用于处理路由跳转前的逻辑
router.beforeEach(async (to, from, next) => {
  // 添加动态路由
  addRoute()
  // 判断是否已登录且没有 token，未登录时重定向到登录页
  const token = localStorage.getItem("token")
  if (to.path !== "/login" && !token) {
    return next({ name: "login" })
  }
  next()
})
```

注意：动态添加路由后刷新页面会跳转404页面，因为在进路由守卫之前，程序已经进行了路由匹配，结果就是没匹配到任何内容。

解决方案：在router注册之前调用initRouter函数初始化路由。

```
// main.js
import "./assets/css/main.css"

import { createApp } from "vue"
import { createPinia } from "pinia"
import App from "./App.vue"
import { initRouter, router } from "./router"

const app = createApp(App)

const call = async () => {
  app.use(createPinia())
  await initRouter()
  app.use(router)

  app.mount("#app")
}
call()

```

gitee地址：https://gitee.com/micefind/vue3-dynamic-routing