Blame view

src/router/helper/routeHelper.ts 4.85 KB
vben authored
1
import type { AppRouteModule, AppRouteRecordRaw } from '/@/router/types';
2
import type { Router, RouteRecordNormalized } from 'vue-router';
vben authored
3
4

import { getParentLayout, LAYOUT } from '/@/router/constant';
5
import { cloneDeep, omit } from 'lodash-es';
vben authored
6
import { warn } from '/@/utils/log';
7
import { createRouter, createWebHashHistory } from 'vue-router';
vben authored
8
9
export type LayoutMapKey = 'LAYOUT';
10
const IFRAME = () => import('/@/views/sys/iframe/FrameBlank.vue');
11
12
const LayoutMap = new Map<string, () => Promise<typeof import('*.vue')>>();
13
14
15

LayoutMap.set('LAYOUT', LAYOUT);
LayoutMap.set('IFRAME', IFRAME);
16
17
let dynamicViewsModules: Record<string, () => Promise<Recordable>>;
18
19
// Dynamic introduction
vben authored
20
function asyncImportRoute(routes: AppRouteRecordRaw[] | undefined) {
Vben authored
21
  dynamicViewsModules = dynamicViewsModules || import.meta.glob('../../views/**/*.{vue,tsx}');
vben authored
22
23
  if (!routes) return;
  routes.forEach((item) => {
24
25
26
    if (!item.component && item.meta?.frameSrc) {
      item.component = 'IFRAME';
    }
vben authored
27
28
29
    const { component, name } = item;
    const { children } = item;
    if (component) {
30
      const layoutFound = LayoutMap.get(component as string);
31
32
33
34
35
      if (layoutFound) {
        item.component = layoutFound;
      } else {
        item.component = dynamicImport(dynamicViewsModules, component as string);
      }
vben authored
36
    } else if (name) {
37
      item.component = getParentLayout();
vben authored
38
39
40
41
42
    }
    children && asyncImportRoute(children);
  });
}
43
function dynamicImport(
44
  dynamicViewsModules: Record<string, () => Promise<Recordable>>,
45
46
47
  component: string
) {
  const keys = Object.keys(dynamicViewsModules);
vben authored
48
  const matchKeys = keys.filter((key) => {
49
50
51
52
    let k = key.replace('../../views', '');
    const lastIndex = k.lastIndexOf('.');
    k = k.substring(0, lastIndex);
    return k === component;
vben authored
53
54
55
  });
  if (matchKeys?.length === 1) {
    const matchKey = matchKeys[0];
56
    return dynamicViewsModules[matchKey];
vben authored
57
58
59
60
61
62
63
64
65
  }
  if (matchKeys?.length > 1) {
    warn(
      'Please do not create `.vue` and `.TSX` files with the same file name in the same hierarchical directory under the views folder. This will cause dynamic introduction failure'
    );
    return;
  }
}
vben authored
66
67
68
// Turn background objects into routing objects
export function transformObjToRoute<T = AppRouteModule>(routeList: AppRouteModule[]): T[] {
  routeList.forEach((route) => {
69
70
71
72
    const component = route.component as string;
    if (component) {
      if (component.toUpperCase() === 'LAYOUT') {
        route.component = LayoutMap.get(component.toUpperCase());
vben authored
73
74
75
76
77
78
79
80
81
82
83
84
85
      } else {
        route.children = [cloneDeep(route)];
        route.component = LAYOUT;
        route.name = `${route.name}Parent`;
        route.path = '';
        const meta = route.meta || {};
        meta.single = true;
        meta.affix = false;
        route.meta = meta;
      }
    }
    route.children && asyncImportRoute(route.children);
  });
86
  return routeList as unknown as T[];
vben authored
87
88
}
89
90
91
/**
 * Convert multi-level routing to level 2 routing
 */
92
93
94
95
export function flatMultiLevelRoutes(routeModules: AppRouteModule[]) {
  const modules: AppRouteModule[] = cloneDeep(routeModules);
  for (let index = 0; index < modules.length; index++) {
    const routeModule = modules[index];
96
97
98
99
100
    if (!isMultipleRoute(routeModule)) {
      continue;
    }
    promoteRouteLevel(routeModule);
  }
101
  return modules;
102
103
104
105
106
107
}

// Routing level upgrade
function promoteRouteLevel(routeModule: AppRouteModule) {
  // Use vue-router to splice menus
  let router: Router | null = createRouter({
108
    routes: [routeModule as unknown as RouteRecordNormalized],
109
110
111
112
    history: createWebHashHistory(),
  });

  const routes = router.getRoutes();
113
  addToChildren(routes, routeModule.children || [], routeModule);
114
115
  router = null;
116
  routeModule.children = routeModule.children?.map((item) => omit(item, 'children'));
117
118
119
120
121
122
123
124
125
126
127
}

// Add all sub-routes to the secondary route
function addToChildren(
  routes: RouteRecordNormalized[],
  children: AppRouteRecordRaw[],
  routeModule: AppRouteModule
) {
  for (let index = 0; index < children.length; index++) {
    const child = children[index];
    const route = routes.find((item) => item.name === child.name);
128
129
130
131
132
    if (!route) {
      continue;
    }
    routeModule.children = routeModule.children || [];
    if (!routeModule.children.find((item) => item.name === route.name)) {
133
      routeModule.children?.push(route as unknown as AppRouteModule);
134
135
136
    }
    if (child.children?.length) {
      addToChildren(routes, child.children, routeModule);
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
    }
  }
}

// Determine whether the level exceeds 2 levels
function isMultipleRoute(routeModule: AppRouteModule) {
  if (!routeModule || !Reflect.has(routeModule, 'children') || !routeModule.children?.length) {
    return false;
  }

  const children = routeModule.children;

  let flag = false;
  for (let index = 0; index < children.length; index++) {
    const child = children[index];
    if (child.children?.length) {
      flag = true;
      break;
    }
  }
  return flag;
vben authored
158
}