快捷導(dǎo)航

如何用vite動態(tài)導(dǎo)入vue的路由配置詳解

更新時(shí)間：2025年04月29日 08:27:16 作者：星極天下第一

這篇文章主要介紹了如何用vite動態(tài)導(dǎo)入vue的路由配置的相關(guān)資料,動態(tài)導(dǎo)入路由模仿了uniapp的頁面配置文件結(jié)構(gòu),文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

在Vue應(yīng)用中，通過路由可以實(shí)現(xiàn)不同頁面之間的切換，同時(shí)也可以實(shí)現(xiàn)頁面之間的傳參和控制頁面的顯示與隱藏。但是我們在開發(fā)的過程中，會發(fā)現(xiàn)在路由配置中的路由配置和我們的項(xiàng)目結(jié)構(gòu)高度重復(fù)，在我們修改頁面文件結(jié)構(gòu)時(shí)非常的麻煩與復(fù)雜，這時(shí)候，如果可以動態(tài)的導(dǎo)入路由，就可以大大提示我們項(xiàng)目的可維護(hù)性。

我們在開發(fā)中會經(jīng)常聽見一句話，約定大于配置，路由的動態(tài)導(dǎo)入也是這句話應(yīng)用的一種，我們這里動態(tài)導(dǎo)入路由模仿了在uniapp進(jìn)行小程序開發(fā)的頁面配置文件，要求有以下幾點(diǎn)：

所有的頁面都必須配置到/src/pages文件夾下；
所有的頁面文件層級必須是/src/pages/頁面文件夾名稱/；
所有的頁面文件中必須有page.ts作為配置文件和index.vue作為頁面入口文件；

結(jié)構(gòu)展示如下：

page.ts文件展示：

//home的page.ts
export default {
  title: '首頁',
  menuOrder: 1,
  childrens: [
    `../pages/homechildren`
  ]
}

//homechildren的page.ts
export default {
  title: '首頁的子組件',
  menuOrder: 1,
  isChild: true,
}

//login的page.ts
export default {
  title: '登錄',
  menuOrder: 2
}

此時(shí)我們要通過vite的函數(shù)import.meta.glob()和import()掃描pages文件夾動態(tài)生成路由，代碼如下：

//路由配置文件
import { createRouter, createWebHistory, RouteRecordRaw } from 'vue-router'

const pages = import.meta.glob('../pages/**/page.ts', {
  eager: true,
  import: 'default'
})

const components = import.meta.glob('../pages/**/index.vue')

const getChildRoutes = async (childrens: string[]) => {
  const res = [];

  for (const item of childrens) {
    const pageModule = await import(`${item}/page.ts`);
    const componentModule = await import(`${item}/index.vue`);

    const routePath = item.replace('../pages/', '').replace('/page.ts', '') || '/';
    const name = routePath.split('/').filter(Boolean).join('-') || 'index';

    res.push({
      path: routePath,
      name,
      component: componentModule.default,
      meta: pageModule.default
    });
  }

  return res;
};

const routes = Object.entries(pages).filter(([path, meta]: [string, any]) => !meta.isChild).map(([path, meta]: [string, any]) => {
  const compPath = path.replace('page.ts', 'index.vue')
  path = path.replace('../pages', '').replace('/page.ts', '') || '/';
  const name = path.split('/').filter(Boolean).join('-') || 'index';

  return {
    path,
    name,
    component: components[compPath],
    meta: meta,
    children: !!meta.childrens ? getChildRoutes(meta.childrens) : []
  } as RouteRecordRaw
})

const router = createRouter({
  history: createWebHistory(),
  routes: routes,
})

//路由重定向
router.beforeEach((to, from, next) => {
  if (to.path === '/') {
    next('/home')
  } else if (!routes.some(route => route.path === to.path)) {
    next('/home')
  } else {
    next()
  }
  
})

export {
  router
}