# admin-router-plus

**Repository Path**: lin779249475/admin-router-plus

## Basic Information

- **Project Name**: admin-router-plus
- **Description**: vue-router封装库、功能扩展
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-11
- **Last Updated**: 2025-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, JavaScript, npm

## README

# admin-router-plus

### 介绍

vue-router 登录拦截(前置)、动态注册路由。

### 安装

```bash
  npm i admin-router-plus --save
```

### 说明

1. 插件依赖`vue-router`(路由)，需在注册`vue-router`之后注册
2. 登录拦截(前置)：判断`cookie`中的`token`值是否不为空，否则将被拦截至登录页
3. 无需登录鉴权路由需配置`meta: { noAuth: true }`, 否则将被拦截跳转到登录页
4. 动态路由触发条件：会在进入首个鉴权路由前触发请求，并注册完动态路由后进入页面。

### API

#### RouterConfig

动态路由配置项（注意路由路径 path 以/开头自动会变成顶级路由）。

```ts
export interface RouterConfig {
  modules?: Record<string, unknown>; // 所有动态路由文件（import.meta.glob 返回的对象）
  loginPagePath?: string; // 登录页路径，默认 '/login'
  parentRouteName?: string; // 动态路由挂载父级的 name
  routeTreeNodeHandler?: (route: any) => void; // 路由节点预处理回调（可以映射字段、设置 meta 等）
  dynamicRoutesRequest?: () => Promise<RouteTreeNode[]>; // 获取动态路由树的异步方法
}

export interface RouteTreeNode {
  path: string; // 路由地址
  name: string; // 路由名称
  redirect?: string; // 路由重定向
  component?: string; // 页面文件名
  meta?: Record<string, unknown>; // 路由元信息
  children?: RouteTreeNode[]; // 子路由
}
```

#### clearDynamicRoutes(router?) => string[]

用于移除已注册的动态路由（由插件在运行时注册的路由）。

```js
import { clearDynamicRoutes } from 'admin-router-plus';

// 使用内部 router
const removed = clearDynamicRoutes();
console.log('移除的动态路由：', removed);

// 传入 router 实例
const removed2 = clearDynamicRoutes(router);
console.log('移除的动态路由（指定 router）：', removed2);
```

### 使用

main.ts

```js
import { createApp } from 'vue';
import { createPinia } from 'pinia';

import RouterPlus from 'admin-router-plus';

import router from './router';
import App from './App.vue';

const app = createApp(App);

app.use(createPinia());
app.use(router);

app.use(RouterPlus, {
  modules: import.meta.glob(`./views/**`),
  routeTreeNodeHandler: (route) => {
    route.name = route.menuCode;
    route.meta = { title: route.menuName };
  },
  dynamicRoutesRequest: async () => {
    // 请求动态路由...
    return menusTree;
  },
});

app.mount('#app');
```

### 实例

router/index.ts 如下：

```js
import { createRouter, createWebHistory } from 'vue-router';

const router = createRouter({
  history: createWebHistory(),
  routes: [
    {
      path: '/login',
      name: 'login',
      meta: { noAuth: true, noCache: true },
      component: () => import('../views/LoginView.vue'),
    },
    // 动态路由添加内容
    {
      path: '/',
      name: 'layout',
      redirect: '/home',
      component: () => import('../views/LayoutView.vue'),
      children: [],
    },
  ],
});

export default router;
```

动态路由接口响应 json 数据

```json
[
  {
    "path": "company",
    "menuCode": "company",
    "menuName": "公司管理",
    "redirect": "/company/user",
    "children": [
      {
        "path": "user",
        "menuCode": "user",
        "menuName": "员工管理",
        "component": "./views/UserView.vue"
      },
      {
        "path": "department",
        "menuCode": "department",
        "menuName": "部门管理",
        "component": "./views/DepartmentView.vue"
      }
    ]
  }
]
```

等同效果

```js
import { createRouter, createWebHistory } from 'vue-router';

const router = createRouter({
  history: createWebHistory(),
  routes: [
    // 静态路由
    {
      path: '/login',
      name: 'login',
      meta: { noAuth: true, noCache: true },
      component: () => import('../views/LoginView.vue'),
    },
    // 等同动态路由添加内容
    {
      path: '/',
      name: 'layout',
      redirect: '/home',
      component: () => import('../views/LayoutView.vue'),
      children: [
        {
          path: 'company',
          name: 'company',
          redirect: '/company/user',
          meta: { title: '公司管理' },
          component: () => import('../views/Empty.vue'),
          children: [
            {
              path: 'user',
              name: 'user',
              meta: { title: '用户管理' },
              component: () => import('../views/UserView.vue'),
            },
            {
              path: 'department',
              name: 'department',
              meta: { title: '部门管理' },
              component: () => import('../views/DepartmentView.vue'),
            },
          ],
        },
      ],
    },
  ],
});

export default router;
```