@ibiz-template/vue3-util 0.0.3-beta.0

package/src/util/route/route.ts

@@ -0,0 +1,295 @@
+import { notNilEmpty } from 'qx-util';
+import { IBizContext, RuntimeError } from '@ibiz-template/core';
+import { IPSApplication, IPSAppView, IPSSubAppRef } from '@ibiz-template/model';
+import qs from 'qs';
+import { RouteLocationNormalizedLoaded as Route } from 'vue-router';
+import { IRoutePath, IRoutePathNode, IRouteViewData } from '../../interface';
+
+/**
+ * 生成route路径
+ *
+ * @author lxm
+ * @date 2022-08-17 21:08:00
+ * @export
+ * @param {IPSAppView} appView 视图模型
+ * @param {Route} route 路由对象
+ * @param {(IBizContext | undefined)} [context] 上下文对象
+ * @param {(IParams | undefined)} [_params] 视图参数
+ * @returns {*}  {string}
+ */
+export function generateRoutePath(
+  appView: IPSAppView,
+  route: Route,
+  context?: IBizContext | undefined,
+  params?: IParams | undefined,
+): string {
+  const routePath = string2routePath(route.fullPath);
+  // 如果上下文存在toRouteLevel时，使用上下文的层级，否则是第二级路由
+  let level = 2;
+  if (context?.toRouteLevel) {
+    level = context.toRouteLevel;
+    // 使用完后删除，避免添加到首页上下文里
+    delete context.toRouteLevel;
+  }
+  // 删除自身层级和之后的路由，保留之前层级的路由
+  routePath.pathNodes.splice(level - 1, routePath.pathNodes.length - level + 1);
+
+  // 一级首页路由
+  if (routePath.pathNodes[0].viewName === 'appredirectview') {
+    if (params?.srfindexname) {
+      routePath.pathNodes[0].viewName = params.srfindexname;
+      delete params.srfindexname;
+    } else {
+      routePath.pathNodes[0].viewName = 'index';
+    }
+  }
+
+  // 计算自身视图path路径
+  routePath.pathNodes.push({ viewName: appView.codeName.toLowerCase() });
+  const deName = appView.getPSAppDataEntity()?.codeName.toLowerCase();
+
+  // 计算自身的context参数
+  if (context) {
+    const routeContext: IData = context.getOwnContext();
+
+    // 如果有路由上下文参数的话，添加到path上
+    if (Object.values(routeContext).length > 0) {
+      // 有视图实体主键上下文时，
+      if (deName && routeContext[deName]) {
+        routePath.pathNodes[level - 1].context = routeContext[deName];
+        delete routeContext[deName];
+      }
+      // 除主键外的参数合并到首页的参数里去
+      Object.assign(routePath.pathNodes[0].context as IContext, routeContext);
+    }
+  }
+
+  // 存在视图参数时补充视图参数
+  routePath.params = params;
+
+  return routePath2string(routePath);
+}
+
+/**
+ * 获取视图模型的codeName(小写)
+ *
+ * @export
+ * @param {IPSAppView} model
+ * @returns {*}
+ */
+export function getViewName(model: IPSAppView) {
+  const viewName = model.isFill
+    ? model.codeName
+    : (model.refM.resource || '') + model.refM.view;
+  return viewName.toLowerCase();
+}
+
+/**
+ * 在单个应用里
+ * 通过视图的codeName找到视图模型
+ *
+ * @param {(IPSApplication | IPSSubAppRef)} appModel 主应用或子应用
+ * @param {string} viewCodeName 视图名称小写
+ * @returns {*}
+ */
+export function findViewByName(
+  appModel: IPSApplication | IPSSubAppRef,
+  viewCodeName: string,
+) {
+  return appModel.getAllPSAppViews()?.find((model: IPSAppView) => {
+    return getViewName(model) === viewCodeName;
+  });
+}
+
+/**
+ * 从子应用和主应用里
+ * 通过视图的codeName找视图模型
+ *
+ * @param {IPSApplication} appModel 主应用
+ * @param {string} viewCodeName 视图名称小写
+ * @returns {*}
+ */
+export function findView(appModel: IPSApplication, viewCodeName: string) {
+  let viewModel: IPSAppView | null | undefined;
+  viewCodeName = viewCodeName.toLowerCase();
+  // index找默认首页视图，其他匹配codeName
+  if (viewCodeName === 'index') {
+    viewModel = appModel.getDefaultPSAppIndexView();
+  } else {
+    // 先查找子应用，找到则不继续找了,优先从最后面的子应用找起
+    if (appModel.getAllPSSubAppRefs()?.length) {
+      appModel
+        .getAllPSSubAppRefs()!
+        .reverse()
+        .find(sub => {
+          viewModel = findViewByName(sub, viewCodeName);
+          return !!viewModel;
+        });
+    }
+    // 子应用里没有就在主应用里找。
+    if (!viewModel) {
+      viewModel = findViewByName(appModel, viewCodeName);
+    }
+  }
+  return viewModel;
+}
+
+/**
+ * 解析路由获取对应视图数据
+ *
+ * @author lxm
+ * @date 2022-08-17 22:08:51
+ * @export
+ * @param {IPSApplication} appModel 视图模型
+ * @param {Route} route 路由对象
+ * @param {number} level 层级
+ * @returns {*}  {IRouteViewData}
+ */
+export function parseRouteViewData(
+  appModel: IPSApplication,
+  route: Route,
+  level: number,
+): IRouteViewData {
+  // 解析路由的视图参数
+  const routePath = string2routePath(route.fullPath);
+
+  // 获取对应层级的视图名称参数
+  const viewCodeName = routePath.pathNodes[level - 1].viewName;
+  if (!viewCodeName) {
+    throw new RuntimeError(`找不到第${level}级路由的视图标识`);
+  }
+
+  // 根据路由视图名称参数查询视图模型
+  const viewModel = findView(appModel, viewCodeName);
+
+  // 找不到视图模型的返回空对象
+  if (!viewModel) {
+    throw new RuntimeError(`找不到视图${viewCodeName}`);
+  }
+
+  const modelPath = viewModel.modelPath!;
+  const { viewType } = viewModel.refM;
+
+  // 解析上下文参数,整合当前层级之前所有的上下文参数
+  const context: IContext = {};
+  // 合并应用上下文
+  if (ibiz.appData?.context) {
+    Object.assign(context, ibiz.appData.context);
+  }
+
+  for (let index = 0; index < level; index++) {
+    const pathNode = routePath.pathNodes[index];
+    if (notNilEmpty(pathNode.context)) {
+      if (index === 0) {
+        // 首页的context是对象直接合并
+        Object.assign(context, pathNode.context);
+      } else {
+        // 其他层级，如果存在context则是主键字符串
+        const view = findView(appModel, pathNode.viewName);
+        const deName = view!.refM.resource?.toLowerCase();
+        if (deName) {
+          context[deName] = pathNode.context;
+        }
+      }
+    }
+  }
+
+  // 最后一级路由对应的视图才会解析视图参数
+  let params;
+  if (route.matched.length === level) {
+    params = route.query as IParams;
+  }
+
+  return {
+    viewPath: modelPath,
+    viewType,
+    context,
+    params,
+  };
+}
+
+/**
+ * 路径字符串转换成路由路径对象
+ *
+ * @author lxm
+ * @date 2022-08-18 11:08:08
+ * @export
+ * @param {string} pathStr 以/开头的路径，即router的path
+ * @returns {*}  {IRoutePath}
+ */
+export function string2routePath(pathStr: string): IRoutePath {
+  let queryIndex = pathStr.lastIndexOf('?');
+  queryIndex = queryIndex === -1 ? pathStr.length : queryIndex;
+  let path = pathStr.substring(0, queryIndex);
+  if (path.indexOf('/') === 0) path = path.substring(1);
+  const queryPath = pathStr.substring(queryIndex + 1);
+
+  // 解析路径节点
+  const pathNodes: IRoutePathNode[] = [];
+
+  const paths = path.split('/');
+  let viewNum = 0;
+  paths.forEach((str: string, index: number) => {
+    // 第一级是首页
+    if (index === 0) {
+      pathNodes.push({ viewName: str.toLowerCase(), context: {} });
+    } else if (index === 1) {
+      // 第二级是上下文或者二级视图
+      if (/[^/]+=[^/]+/.test(str)) {
+        pathNodes[pathNodes.length - 1].context = qs.parse(str, {
+          delimiter: ';',
+        });
+      } else {
+        pathNodes.push({ viewName: str.toLowerCase() });
+        viewNum = 1;
+      }
+    } else if (index % 2 === viewNum) {
+      pathNodes.push({ viewName: str.toLowerCase() });
+    } else {
+      pathNodes[pathNodes.length - 1].context = str === '_' ? undefined : str;
+    }
+  });
+
+  // 解析视图参数
+  let params;
+  if (queryPath) {
+    params = qs.parse(queryPath);
+  }
+
+  return { pathNodes, params };
+}
+
+/**
+ * 路由路径对象转路径字符串
+ *
+ * @author lxm
+ * @date 2022-08-18 13:08:57
+ * @export
+ * @param {IRoutePath} routePath 路由路径对象
+ * @returns {*}  {string}
+ */
+export function routePath2string(routePath: IRoutePath): string {
+  let pathStr = '';
+  routePath.pathNodes.forEach((pathNode: IRoutePathNode, index: number) => {
+    pathStr += `/${pathNode.viewName}`;
+    // 首页路由
+    if (index === 0) {
+      if (
+        notNilEmpty(pathNode.context) &&
+        Object.values(pathNode.context!).length
+      ) {
+        // 对象转成a=11;b=222的格式，字符串直接附加在后面
+        pathStr += `/${qs.stringify(pathNode.context, { delimiter: ';' })}`;
+      }
+    } else {
+      // 非首页路由
+      pathStr += `/${pathNode.context || '_'}`;
+    }
+  });
+
+  if (notNilEmpty(routePath.params)) {
+    pathStr += qs.stringify(routePath.params, { addQueryPrefix: true });
+  }
+
+  return pathStr;
+}