vue2-client 1.3.1 → 1.3.2

package/CHANGELOG.md

@@ -1,7 +1,11 @@
 # Change Log
 > 所有关于本项目的变化都在该文档里。
 
-**1.3.1 -2022-09-08 @江超**
+**1.3.2 -2022-09-09 @江超**
+- 功能修改：
+- 新增基础路由配置，用于重写登录等页面路由
+
+**1.3.0 - 1.3.1 -2022-09-08 @江超**
 - 不兼容调整：
 - `common.js`中接口前缀调整为`af-system`，需重新配置映射
 - 功能修改：

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue2-client",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "private": false,
   "scripts": {
     "serve": "vue-cli-service serve",

package/src/router/async/config.async.js

@@ -20,7 +20,8 @@ const routesConfig = [
 
 const options = {
   mode: 'history',
-  routes: parseRoutes(routesConfig, routerMap)
+  routes: parseRoutes(routesConfig, routerMap),
+  config: routesConfig
 }
 
 export default options

package/src/utils/routerUtil.js

@@ -1,350 +1,358 @@
-import Vue from 'vue'
-import routerMap from '@vue2-client/router/async/router.map'
-import { mergeI18nFromRoutes } from '@vue2-client/utils/i18n'
-import { arrRemoveEmpty } from '@vue2-client/utils/util'
-import Router from 'vue-router'
-import deepMerge from 'deepmerge'
-import basicOptions from '@vue2-client/router/async/config.async'
-
-// 应用配置
-const appOptions = {
-  router: undefined,
-  i18n: undefined,
-  store: undefined
-}
-
-/**
- * 设置应用配置
- * @param options
- */
-function setAppOptions (options) {
-  const { router, store, i18n } = options
-  appOptions.router = router
-  appOptions.store = store
-  appOptions.i18n = i18n
-}
-
-// 应用路由资源
-const appRouterMap = {
-  routerMap: routerMap
-}
-
-/**
- * 设置应用路由资源
- * @param options
- */
-function setAppRouterMap (router) {
-  appRouterMap.routerMap = Object.assign(appRouterMap.routerMap, router)
-}
-
-/**
- * 根据 路由配置 和 路由组件注册 解析路由
- * @param routesConfig 路由配置
- * @param routerMap 本地路由组件注册配置
- */
-function parseRoutes (routesConfig, routerMap) {
-  const routes = []
-  routesConfig.forEach(item => {
-    // 获取注册在 routerMap 中的 router，初始化 routeCfg
-    let router; let routeCfg = {}
-    if (typeof item === 'string') {
-      router = routerMap[item]
-      routeCfg = { path: (router && router.path) || item, router: item }
-    } else if (typeof item === 'object') {
-      // 当没有设置路由对象名或者设置的是blank路由对象时, 给空界面, path为名称
-      if (!item.router || item.router == 'blank') {
-        router = routerMap['blank']
-        item.path = item.name
-      } else {
-        router = routerMap[item.router]
-      }
-      // 查看是否是单页面
-      if (item.meta && item.meta.singlePage) {
-        router = routerMap['singlePage']
-        item.path = item.name
-      }
-      // 当没在动态路由对象中找到时, 不添加到路由
-      if (!router) return
-      routeCfg = item
-    }
-    if (!router) {
-      console.warn(`can't find register for router ${routeCfg.router}, please register it in advance.`)
-      router = typeof item === 'string' ? { path: item, name: item } : item
-    }
-    // 从 router 和 routeCfg 解析路由
-    const meta = {
-      authority: router.authority,
-      icon: router.icon,
-      page: router.page,
-      link: router.link,
-      params: router.params,
-      query: router.query,
-      ...router.meta
-    }
-    const cfgMeta = {
-      authority: routeCfg.authority,
-      icon: routeCfg.icon,
-      page: routeCfg.page,
-      link: routeCfg.link,
-      params: routeCfg.params,
-      query: routeCfg.query,
-      ...routeCfg.meta
-    }
-    Object.keys(cfgMeta).forEach(key => {
-      if (cfgMeta[key] === undefined || cfgMeta[key] === null || cfgMeta[key] === '') {
-        delete cfgMeta[key]
-      }
-    })
-    Object.assign(meta, cfgMeta)
-    const route = {
-      path: routeCfg.path || router.path || routeCfg.router,
-      name: routeCfg.name || router.name,
-      component: router.component || router,
-      redirect: routeCfg.redirect || router.redirect,
-      meta: { ...meta, authority: meta.authority || '*' }
-    }
-    if (routeCfg.invisible || router.invisible) {
-      route.meta.invisible = true
-    }
-    if (routeCfg.children && routeCfg.children.length > 0) {
-      route.children = parseRoutes(routeCfg.children, routerMap)
-    }
-    // 当没有子并且自己时blank(空界面)时, 不添加到路由
-    if (route.component.name === 'blank' && route.children && route.children.length <= 0) return
-    routes.push(route)
-  })
-  return routes
-}
-
-/**
- * 加载路由
- * @param routesConfig {[{router: string, children: [{router: string, children: string[]}, {router: string, children: string[]}, {router: string, authority: string, name: string, icon: string}, {path: string, router: string, name: string, icon: string, link: string}, {path: string, router: string, name: string, icon: string, link: string}]}]} 路由配置
- */
-function loadRoutes (routesConfig) {
-  // 兼容 0.6.1 以下版本
-  /** ************* 兼容 version < v0.6.1 *****************/
-  if (arguments.length > 0) {
-    const arg0 = arguments[0]
-    if (arg0.router || arg0.i18n || arg0.store) {
-      routesConfig = arguments[1]
-      console.error('the usage of signature loadRoutes({router, store, i18n}, routesConfig) is out of date, please use the new signature: loadRoutes(routesConfig).')
-      console.error('方法签名 loadRoutes({router, store, i18n}, routesConfig) 的用法已过时, 请使用新的方法签名 loadRoutes(routesConfig)。')
-    }
-  }
-  /** ************* 兼容 version < v0.6.1 *****************/
-
-  // 应用配置
-  const { router, store, i18n } = appOptions
-
-  // 刷新页面时,有些全局状态丢失,在此处从本地缓存拿出来赋值
-  if (JSON.stringify(Vue.$login.f) == '{}') {
-    const login = store.getters['account/login']
-    Object.assign(Vue.$login, login)
-  }
-  // 如果 routesConfig 有值，则更新到本地，否则从本地获取
-  if (routesConfig) {
-    store.commit('account/setRoutesConfig', routesConfig)
-  } else {
-    routesConfig = store.getters['account/routesConfig']
-  }
-  // 如果开启了异步路由，则加载异步路由配置
-  const asyncRoutes = store.state.setting.asyncRoutes
-  if (asyncRoutes) {
-    if (routesConfig && routesConfig.length > 0) {
-      const routes = parseRoutes(routesConfig, appRouterMap.routerMap)
-      const finalRoutes = mergeRoutes(basicOptions.routes, routes)
-      formatRoutes(finalRoutes)
-      router.options = { ...router.options, routes: finalRoutes }
-      router.matcher = new Router({ ...router.options, routes: [] }).matcher
-      router.addRoutes(finalRoutes)
-    }
-  }
-  // 提取路由国际化数据
-  mergeI18nFromRoutes(i18n, router.options.routes)
-  // 初始化Admin后台菜单数据
-  const rootRoute = router.options.routes.find(item => item.path === '/')
-  const menuRoutes = rootRoute && rootRoute.children
-  if (menuRoutes) {
-    store.commit('setting/setMenuData', menuRoutes)
-  }
-}
-
-/**
- * 合并路由
- * @param target {Route[]}
- * @param source {Route[]}
- * @returns {Route[]}
- */
-function mergeRoutes (target, source) {
-  const routesMap = {}
-  // eslint-disable-next-line no-return-assign
-  target.forEach(item => routesMap[item.path] = item)
-  // eslint-disable-next-line no-return-assign
-  source.forEach(item => routesMap[item.path] = item)
-  return Object.values(routesMap)
-}
-
-/**
- * 深度合并路由
- * @param target {Route[]}
- * @param source {Route[]}
- * @returns {Route[]}
- */
-function deepMergeRoutes (target, source) {
-  // 映射路由数组
-  const mapRoutes = routes => {
-    const routesMap = {}
-    routes.forEach(item => {
-      routesMap[item.path] = {
-        ...item,
-        children: item.children ? mapRoutes(item.children) : undefined
-      }
-    })
-    return routesMap
-  }
-  const tarMap = mapRoutes(target)
-  const srcMap = mapRoutes(source)
-
-  // 合并路由
-  const merge = deepMerge(tarMap, srcMap)
-
-  // 转换为 routes 数组
-  const parseRoutesMap = routesMap => {
-    return Object.values(routesMap).map(item => {
-      if (item.children) {
-        item.children = parseRoutesMap(item.children)
-      } else {
-        delete item.children
-      }
-      return item
-    })
-  }
-  return parseRoutesMap(merge)
-}
-
-/**
- * 格式化路由
- * @param routes 路由配置
- */
-function formatRoutes (routes) {
-  routes.forEach(route => {
-    const { path } = route
-    if (!path.startsWith('/') && path !== '*') {
-      route.path = '/' + path
-    }
-  })
-  formatAuthority(routes)
-}
-
-/**
- * 格式化路由的权限配置
- * @param routes 路由
- * @param pAuthorities 父级路由权限配置集合
- */
-function formatAuthority (routes, pAuthorities = []) {
-  routes.forEach(route => {
-    const meta = route.meta
-    const defaultAuthority = pAuthorities[pAuthorities.length - 1] || { permission: '*' }
-    if (meta) {
-      let authority = {}
-      if (!meta.authority) {
-        authority = defaultAuthority
-      } else if (typeof meta.authority === 'string') {
-        authority.permission = meta.authority
-      } else if (typeof meta.authority === 'object') {
-        authority = meta.authority
-        const { role } = authority
-        if (typeof role === 'string') {
-          authority.role = [role]
-        }
-        if (!authority.permission && !authority.role) {
-          authority = defaultAuthority
-        }
-      }
-      meta.authority = authority
-    } else {
-      const authority = defaultAuthority
-      route.meta = { authority }
-    }
-    route.meta.pAuthorities = pAuthorities
-    if (route.children) {
-      formatAuthority(route.children, [...pAuthorities, route.meta.authority])
-    }
-  })
-}
-
-/**
- * 从路由 path 解析 i18n key
- * @param path
- * @returns {*}
- */
-function getI18nKey (path) {
-  const keys = path.split('/').filter(item => !item.startsWith(':') && item != '')
-  keys.push('name')
-  return keys.join('.')
-}
-
-/**
- * 加载导航守卫
- * @param guards
- * @param options
- */
-function loadGuards (guards, options) {
-  const { beforeEach, afterEach } = guards
-  const { router } = options
-  beforeEach.forEach(guard => {
-    if (guard && typeof guard === 'function') {
-      router.beforeEach((to, from, next) => guard(to, from, next, options))
-    }
-  })
-  afterEach.forEach(guard => {
-    if (guard && typeof guard === 'function') {
-      router.afterEach((to, from) => guard(to, from, options))
-    }
-  })
-}
-
-/**
- * 资源服务路由转新路由
- * @param func
- */
-function funcToRouter (func) {
-  return [{
-    router: 'root',
-    children: positionRouter(parsefunc(func))
-  }]
-}
-
-function parsefunc (func) {
-  const router = []
-  for (const row of func) {
-    const route = {
-      router: row.link,
-      meta: {
-        singlePage: row.navigate
-      },
-      position: row.position - 1,
-      icon: row.icon,
-      name: row.name
-    }
-    if (row.children && row.children.length > 0) {
-      route.children = parsefunc(row.children)
-    }
-    router.push(route)
-  }
-  return router
-}
-
-/**
- * 资源服务路由排序
- */
-function positionRouter (r) {
-  let router = []
-  for (const row of r) {
-    router[row.position] = row
-  }
-  router = arrRemoveEmpty(router)
-  return router
-}
-
-export { parseRoutes, loadRoutes, formatAuthority, getI18nKey, loadGuards, deepMergeRoutes, formatRoutes, setAppOptions, funcToRouter, setAppRouterMap }
+import Vue from 'vue'
+import routerMap from '@vue2-client/router/async/router.map'
+import { mergeI18nFromRoutes } from '@vue2-client/utils/i18n'
+import { arrRemoveEmpty } from '@vue2-client/utils/util'
+import Router from 'vue-router'
+import deepMerge from 'deepmerge'
+import basicOptions from '@vue2-client/router/async/config.async'
+
+// 应用配置
+const appOptions = {
+  router: undefined,
+  i18n: undefined,
+  store: undefined
+}
+
+/**
+ * 设置应用配置
+ * @param options
+ */
+function setAppOptions (options) {
+  const { router, store, i18n } = options
+  appOptions.router = router
+  appOptions.store = store
+  appOptions.i18n = i18n
+}
+
+// 应用路由资源
+const appRouterMap = {
+  routerMap: routerMap
+}
+
+/**
+ * 设置应用路由资源
+ * @param router 应用路由
+ */
+function setAppRouterMap (router) {
+  appRouterMap.routerMap = Object.assign(appRouterMap.routerMap, router)
+}
+
+/**
+ * 设置基础应用路由资源
+ * @param router 基础路由
+ */
+function setBaseRouterMap (router) {
+  basicOptions.routes = Object.assign(basicOptions.routes, parseRoutes(basicOptions.config, router))
+}
+
+/**
+ * 根据 路由配置 和 路由组件注册 解析路由
+ * @param routesConfig 路由配置
+ * @param routerMap 本地路由组件注册配置
+ */
+function parseRoutes (routesConfig, routerMap) {
+  const routes = []
+  routesConfig.forEach(item => {
+    // 获取注册在 routerMap 中的 router，初始化 routeCfg
+    let router; let routeCfg = {}
+    if (typeof item === 'string') {
+      router = routerMap[item]
+      routeCfg = { path: (router && router.path) || item, router: item }
+    } else if (typeof item === 'object') {
+      // 当没有设置路由对象名或者设置的是blank路由对象时, 给空界面, path为名称
+      if (!item.router || item.router == 'blank') {
+        router = routerMap['blank']
+        item.path = item.name
+      } else {
+        router = routerMap[item.router]
+      }
+      // 查看是否是单页面
+      if (item.meta && item.meta.singlePage) {
+        router = routerMap['singlePage']
+        item.path = item.name
+      }
+      // 当没在动态路由对象中找到时, 不添加到路由
+      if (!router) return
+      routeCfg = item
+    }
+    if (!router) {
+      console.warn(`can't find register for router ${routeCfg.router}, please register it in advance.`)
+      router = typeof item === 'string' ? { path: item, name: item } : item
+    }
+    // 从 router 和 routeCfg 解析路由
+    const meta = {
+      authority: router.authority,
+      icon: router.icon,
+      page: router.page,
+      link: router.link,
+      params: router.params,
+      query: router.query,
+      ...router.meta
+    }
+    const cfgMeta = {
+      authority: routeCfg.authority,
+      icon: routeCfg.icon,
+      page: routeCfg.page,
+      link: routeCfg.link,
+      params: routeCfg.params,
+      query: routeCfg.query,
+      ...routeCfg.meta
+    }
+    Object.keys(cfgMeta).forEach(key => {
+      if (cfgMeta[key] === undefined || cfgMeta[key] === null || cfgMeta[key] === '') {
+        delete cfgMeta[key]
+      }
+    })
+    Object.assign(meta, cfgMeta)
+    const route = {
+      path: routeCfg.path || router.path || routeCfg.router,
+      name: routeCfg.name || router.name,
+      component: router.component || router,
+      redirect: routeCfg.redirect || router.redirect,
+      meta: { ...meta, authority: meta.authority || '*' }
+    }
+    if (routeCfg.invisible || router.invisible) {
+      route.meta.invisible = true
+    }
+    if (routeCfg.children && routeCfg.children.length > 0) {
+      route.children = parseRoutes(routeCfg.children, routerMap)
+    }
+    // 当没有子并且自己时blank(空界面)时, 不添加到路由
+    if (route.component.name === 'blank' && route.children && route.children.length <= 0) return
+    routes.push(route)
+  })
+  return routes
+}
+
+/**
+ * 加载路由
+ * @param routesConfig {[{router: string, children: [{router: string, children: string[]}, {router: string, children: string[]}, {router: string, authority: string, name: string, icon: string}, {path: string, router: string, name: string, icon: string, link: string}, {path: string, router: string, name: string, icon: string, link: string}]}]} 路由配置
+ */
+function loadRoutes (routesConfig) {
+  // 兼容 0.6.1 以下版本
+  /** ************* 兼容 version < v0.6.1 *****************/
+  if (arguments.length > 0) {
+    const arg0 = arguments[0]
+    if (arg0.router || arg0.i18n || arg0.store) {
+      routesConfig = arguments[1]
+      console.error('the usage of signature loadRoutes({router, store, i18n}, routesConfig) is out of date, please use the new signature: loadRoutes(routesConfig).')
+      console.error('方法签名 loadRoutes({router, store, i18n}, routesConfig) 的用法已过时, 请使用新的方法签名 loadRoutes(routesConfig)。')
+    }
+  }
+  /** ************* 兼容 version < v0.6.1 *****************/
+
+    // 应用配置
+  const { router, store, i18n } = appOptions
+
+  // 刷新页面时,有些全局状态丢失,在此处从本地缓存拿出来赋值
+  if (JSON.stringify(Vue.$login.f) == '{}') {
+    const login = store.getters['account/login']
+    Object.assign(Vue.$login, login)
+  }
+  // 如果 routesConfig 有值，则更新到本地，否则从本地获取
+  if (routesConfig) {
+    store.commit('account/setRoutesConfig', routesConfig)
+  } else {
+    routesConfig = store.getters['account/routesConfig']
+  }
+  // 如果开启了异步路由，则加载异步路由配置
+  const asyncRoutes = store.state.setting.asyncRoutes
+  if (asyncRoutes) {
+    if (routesConfig && routesConfig.length > 0) {
+      const routes = parseRoutes(routesConfig, appRouterMap.routerMap)
+      const finalRoutes = mergeRoutes(basicOptions.routes, routes)
+      formatRoutes(finalRoutes)
+      router.options = { ...router.options, routes: finalRoutes }
+      router.matcher = new Router({ ...router.options, routes: [] }).matcher
+      router.addRoutes(finalRoutes)
+    }
+  }
+  // 提取路由国际化数据
+  mergeI18nFromRoutes(i18n, router.options.routes)
+  // 初始化Admin后台菜单数据
+  const rootRoute = router.options.routes.find(item => item.path === '/')
+  const menuRoutes = rootRoute && rootRoute.children
+  if (menuRoutes) {
+    store.commit('setting/setMenuData', menuRoutes)
+  }
+}
+
+/**
+ * 合并路由
+ * @param target {Route[]}
+ * @param source {Route[]}
+ * @returns {Route[]}
+ */
+function mergeRoutes (target, source) {
+  const routesMap = {}
+  // eslint-disable-next-line no-return-assign
+  target.forEach(item => routesMap[item.path] = item)
+  // eslint-disable-next-line no-return-assign
+  source.forEach(item => routesMap[item.path] = item)
+  return Object.values(routesMap)
+}
+
+/**
+ * 深度合并路由
+ * @param target {Route[]}
+ * @param source {Route[]}
+ * @returns {Route[]}
+ */
+function deepMergeRoutes (target, source) {
+  // 映射路由数组
+  const mapRoutes = routes => {
+    const routesMap = {}
+    routes.forEach(item => {
+      routesMap[item.path] = {
+        ...item,
+        children: item.children ? mapRoutes(item.children) : undefined
+      }
+    })
+    return routesMap
+  }
+  const tarMap = mapRoutes(target)
+  const srcMap = mapRoutes(source)
+
+  // 合并路由
+  const merge = deepMerge(tarMap, srcMap)
+
+  // 转换为 routes 数组
+  const parseRoutesMap = routesMap => {
+    return Object.values(routesMap).map(item => {
+      if (item.children) {
+        item.children = parseRoutesMap(item.children)
+      } else {
+        delete item.children
+      }
+      return item
+    })
+  }
+  return parseRoutesMap(merge)
+}
+
+/**
+ * 格式化路由
+ * @param routes 路由配置
+ */
+function formatRoutes (routes) {
+  routes.forEach(route => {
+    const { path } = route
+    if (!path.startsWith('/') && path !== '*') {
+      route.path = '/' + path
+    }
+  })
+  formatAuthority(routes)
+}
+
+/**
+ * 格式化路由的权限配置
+ * @param routes 路由
+ * @param pAuthorities 父级路由权限配置集合
+ */
+function formatAuthority (routes, pAuthorities = []) {
+  routes.forEach(route => {
+    const meta = route.meta
+    const defaultAuthority = pAuthorities[pAuthorities.length - 1] || { permission: '*' }
+    if (meta) {
+      let authority = {}
+      if (!meta.authority) {
+        authority = defaultAuthority
+      } else if (typeof meta.authority === 'string') {
+        authority.permission = meta.authority
+      } else if (typeof meta.authority === 'object') {
+        authority = meta.authority
+        const { role } = authority
+        if (typeof role === 'string') {
+          authority.role = [role]
+        }
+        if (!authority.permission && !authority.role) {
+          authority = defaultAuthority
+        }
+      }
+      meta.authority = authority
+    } else {
+      const authority = defaultAuthority
+      route.meta = { authority }
+    }
+    route.meta.pAuthorities = pAuthorities
+    if (route.children) {
+      formatAuthority(route.children, [...pAuthorities, route.meta.authority])
+    }
+  })
+}
+
+/**
+ * 从路由 path 解析 i18n key
+ * @param path
+ * @returns {*}
+ */
+function getI18nKey (path) {
+  const keys = path.split('/').filter(item => !item.startsWith(':') && item != '')
+  keys.push('name')
+  return keys.join('.')
+}
+
+/**
+ * 加载导航守卫
+ * @param guards
+ * @param options
+ */
+function loadGuards (guards, options) {
+  const { beforeEach, afterEach } = guards
+  const { router } = options
+  beforeEach.forEach(guard => {
+    if (guard && typeof guard === 'function') {
+      router.beforeEach((to, from, next) => guard(to, from, next, options))
+    }
+  })
+  afterEach.forEach(guard => {
+    if (guard && typeof guard === 'function') {
+      router.afterEach((to, from) => guard(to, from, options))
+    }
+  })
+}
+
+/**
+ * 资源服务路由转新路由
+ * @param func
+ */
+function funcToRouter (func) {
+  return [{
+    router: 'root',
+    children: positionRouter(parsefunc(func))
+  }]
+}
+
+function parsefunc (func) {
+  const router = []
+  for (const row of func) {
+    const route = {
+      router: row.link,
+      meta: {
+        singlePage: row.navigate
+      },
+      position: row.position - 1,
+      icon: row.icon,
+      name: row.name
+    }
+    if (row.children && row.children.length > 0) {
+      route.children = parsefunc(row.children)
+    }
+    router.push(route)
+  }
+  return router
+}
+
+/**
+ * 资源服务路由排序
+ */
+function positionRouter (r) {
+  let router = []
+  for (const row of r) {
+    router[row.position] = row
+  }
+  router = arrRemoveEmpty(router)
+  return router
+}
+
+export { parseRoutes, loadRoutes, formatAuthority, getI18nKey, loadGuards, deepMergeRoutes, formatRoutes, setAppOptions, funcToRouter, setAppRouterMap, setBaseRouterMap }