Vue3自动路由注册

传统的路由注册,是固定定义好哪些路由映射哪些页面,如:

import {RouteRecordRaw} from "vue-router";

const routes = [
    {
        path: '/',
        name: 'home',
        component: () => import('@/views/home.vue')
    }
] as RouteRecordRaw[]

export default routes


在示例代码中,路由/映射views/home.vue

随着项目越来越大,目录层级会越来越多,路由相对的也会增多。如何利用文件目录层级结构自动构建出前端路由时必须考虑的问题。

思路

在动手之前,了解下Vue项目的基本结构,它是由:布局->页面->组件来构成一张网页的所有要素。


image

布局决定了大方向,网站是上下结构,还是左右,分几栏。
页面决定了内容页需要有哪些组件。
组件就是页面基础零件。

所以,在处理路由的时候,由App.vue通过router-view渲染布局layout,布局layout通过router-view渲染页面view,页面view摆放组件component

这就形成了父子路由的关系:

import {RouteRecordRaw} from "vue-router";

const routes = [
    {
        path: '/admin',
        name: 'admin',
        component: () => import('@/layouts/admin.vue'),
        children: [
            {
                path: 'user',
                name: 'user',
                component: () => import('@/views/admin/user.vue')
            }
        ]
    }
] as RouteRecordRaw[]

export default routes

当访问http://localhost:3000/admin/user的时候就展示了admin布局下的user页面。

有了这样的了解,那思路就一目了然了。我们可以先遍历layouts目录,得到所有父级路由,再通过遍历views页面,找出父路由的子路由。

实现

import {RouteRecordRaw} from "vue-router";

// 枚举layouts中的页面,主路由
const layouts = import.meta.globEager('../layouts/*.vue')
// 枚举views中的页面,子路由
const views = import.meta.globEager('../views/**/*.vue')

// 遍历layouts,使它形成router
function getRoutes() {
    // 空数组,用于存放结果
    const layoutRoutes = [] as RouteRecordRaw[]
    Object.entries(layouts).forEach(([file, module]) => {
        // 通过文件路径+模块,形成路由
        const route = getRouteByModule(file, module)
        // 将子路由也加进来
        route.children = getChildrenRoutes(route)
        layoutRoutes.push(route)
    })
    return layoutRoutes
}
// 遍历子路由
function getChildrenRoutes(layoutRoute: RouteRecordRaw): RouteRecordRaw[] {
    // 空数组,用于存放结果
    const children = [] as RouteRecordRaw[]
    Object.entries(views).forEach(([file, module]) => {
        // 找到是views路径的,加入到子路由中
        if (file.includes(`../views/${layoutRoute.name as string}`)) {
            const route = getRouteByModule(file, module)
            route.path = route.path.replace(/\//, '')
            children.push(route)
        }
    })
    return children
}
// 文件名转路由
function getRouteByModule(file: string, module: { [key: string]: any }) {
    // ../layouts/xxx.vue 从路径中拿到xxx
    const name = file.split('/').pop()?.split('.')[0]
    // 构造route
    const route = {
        path: `/${name}`,
        name: name,
        component: module.default
    }
    // 在页面中自定义路由优先于自动路由
    return Object.assign(route, module.default?.route)
}


export default getRoutes()

已经十分详细的注释了上面的代码,随后在路由中引入此文件

import {createRouter, createWebHistory, RouteRecordRaw} from "vue-router";
import {App} from "vue";
import routes from "./routes";
import layoutRoutes from "./autoload";

const router = createRouter({
    history: createWebHistory(),
    routes: [...routes, ...layoutRoutes]
})

export function setupRouter(app: App) {
    app.use(router)
}

当我们在views/admin中添加order.vue时候,自动注册了路由
http://localhost:3000/admin/order

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容