欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

vue 自动化路由实现代码

程序员文章站 2022-09-07 09:01:57
1.需求描述 在写vue的项目中,一般情况下我们每添加一个新页面都得添加一个新路由。为此我们在项目中会专门的一个文件夹来管理路由,如下图所示 那么有没有一种方案,能...

1.需求描述

在写vue的项目中,一般情况下我们每添加一个新页面都得添加一个新路由。为此我们在项目中会专门的一个文件夹来管理路由,如下图所示

vue 自动化路由实现代码

那么有没有一种方案,能够实现我们在文件夹中新建了一个vue文件,就自动帮我们添加路由。特别在我们的一个erp后台项目中,我们几乎都是一个文件夹下有很多子文件,子文件中一般包含index.vue, detail.vue, edit.vue,分别对应的事列表页,详情页和编辑页。

vue 自动化路由实现代码

上图是我们的文件目录,views文件夹中存放的是所有的页面,goodsplanning是一级目录,onnewcomplete和thirdgoods是二级目录,二级目录中存放的是具体的页面,indexcomponents中存放的是index.vue的文件,editcomponents也是同样的道理。index.vue对应的路由是/goodsplanning/onnewcomplete, edit.vue对应的路由是/goodsplanning/onnewcomplete/edit,detail.vue也是同样的道理。所以我们的文件夹和路由是完全能够对应上的,只要知道路由,就能很快的找到对应的文件。那么有没有办法能够读取我们二级目录下的所有文件,然后根据文件名来生成路由呢?答案是有的

2. require.context介绍

官方文档

简单说就是:有了require.context,我们可以得到指定文件夹下的所有文件

require.context(directory, usesubdirectories = false, regexp = /^\.\//);

require.context有三个参数:

  • directory:说明需要检索的目录
  • usesubdirectories:是否检索子目录
  • regexp: 匹配文件的正则表达式

require.context()的返回值,有一个keys方法,返回的是个数组

let routers = require.context('views', true).keys()
console.log(routers)

vue 自动化路由实现代码

通过上面的代码,我们打印出了所有的views文件夹下的所有文件和文件夹,我们只要写好正则就能找到我们所需要的文件

3.直接上代码

import layout from 'views/layout/index'
/**
 * 正则 首先匹配./ ,然后一级目录,不包含components的二级目录,以.vue结尾的三级目录
 */
let routers = require.context('views', true, /\.\/[a-z]+\/(?!components)[a-z]+\/[a-z]+\.vue$/i).keys()
let indexroutermap = {} // 用来存储以index.vue结尾的文件,因为index.vue是列表文件,需要加入layout(我们的菜单),需要keepalive,需要做权限判断
let detailrouterarr = [] // 用来存储以非index.vue结尾的vue文件,此类目前不需要layout
routers.foreach(item => {
 const paths = item.match(/[a-za-z]+/g) //paths中存储了一个目录,二级目录,文件名
 const routerchild = { //定义路由对象
  path: paths[1],   
  name: `${paths[0]}${_.upperfirst(paths[1])}`,  //upperfirst,lodash 首字母大写方法
  component(resolve) {
   require([`../../views${item.slice(1)}`], resolve)
  },
 }
 if (/index\.vue$/.test(item)) { //判断是否以index。vue结尾
  if (indexroutermap[paths[0]]) {  //判断一级路由是否存在,存在push二级路由,不存在则新建
   indexroutermap[paths[0]].children.push(routerchild)
  } else {
   indexroutermap[paths[0]] = {
    path: '/' + paths[0],
    component: layout,
    children: [routerchild]
   }
  }
 } else {   //不以index.vue结尾的,直接添加到路由中
  detailrouterarr.push({
   path: item.slice(1, -4),  //渠道最前面的 . 和最后的.vue
   name: `${paths[0]}${_.upperfirst(paths[1])}${_.upperfirst(paths[2])}`,
   component(resolve) {
    require([`../../views${item.slice(1)}`], resolve)
   },
   meta: {
    nocache: true,  //不keepalive
    noverify: true  //不做权限验证
   }
  })
 }
})
export default [
 ...object.values(indexroutermap),
 ...detailrouterarr,
 /**
  * dashboard单独处理下
  */
 {
  path: '',
  component: layout,
  redirect: 'dashboard',
  children: [
   {
    path: 'dashboard',
    component: () => import('views/dashboard/index'),
    name: 'dashboard',
    meta: { title: '首页', nocache: true, noverify: true }
   }
  ]
 },
]

简简单单的几十行代码就实现了所有的路由功能,再也不用一行一行的写路由文件了。可能你的文件管理方式和我的不一样,但是只要稍微改改正则就行了。

4. 注意

  1. 不能用import引入路由,因为用import引入不支持变量
  2. 不能用别名,找了半天问题,才知道用变量时也不能用别名,所以我用的都是相对路径

5.好处

  • 不用在添加路由了,这个就不说了,明眼人都看得出来
  • 知道了路由,一个能找到对应的文件,以前我们团队就出现过,乱写path的情况
  • 更好的控制验证和keepalive

总结

以上所述是小编给大家介绍的vue 自动化路由实现代码,希望对大家有所帮助