cloud-web-corejs 1.0.54-dev.781 → 1.0.54-dev.783

package/src/utils/menuAdapter.js

@@ -1,277 +1,277 @@
-/**
- * 微前端菜单适配层（零依赖纯函数）。
- * 供引包应用与未引包主应用（deep-import 本文件）共用，
- * 禁止在此引入 @base 的 store / router / request / 组件。
- * 协议说明见 docs/qiankun微前端改造-实现方案.md 第三章。
- */
-
-// 表单菜单（动态表单）类型值，菜单归属识别的唯一权威标识
-export const FORM_MENU_TYPE = 5;
-
-// url 命名空间保留首段：/base/xxx 表示组件在 npm 包内（@base/views/xxx）
-export const BASE_SEGMENT = "base";
-
-/**
- * 微前端固定前缀：访问路径形如 /micro/<appCode>/<来源>/<组件路径>。
- * 用固定前缀而非"首段即 appCode"，是为了让归属命名空间与主应用自身的
- * 一级视图目录（/user、/pmd、/yx…）结构性隔离——否则注册一个与视图目录
- * 同名的 appCode 会劫持主应用整棵子树，且新增视图目录还会反向撞掉已注册的应用。
- */
-export const MICRO_SEGMENT = "micro";
-
-/**
- * 本机调试命名空间：/micro_debug/<appCode>/... 与 /micro/<appCode>/... 归属相同、
- * 菜单相同、组件解析相同，**只有 entry 不同**（正式取注册表，调试取约定端口）。
- * 把"调试还是正式"编码进路径而非存储，是为了让调试态无状态——不会残留在
- * localStorage 里跨天生效，刷新/分享/多标签页的行为都由 URL 自身决定。
- */
-export const MICRO_DEBUG_SEGMENT = "micro_debug";
-
-const MICRO_SEGMENTS = [MICRO_SEGMENT, MICRO_DEBUG_SEGMENT];
-const BASE_VIEW_PREFIX = "@base/views";
-const APP_CODE_REG = /^[A-Za-z][A-Za-z0-9_-]*$/;
-
-export function isFormMenu(menu) {
-  return !!menu && menu.type === FORM_MENU_TYPE;
-}
-
-/**
- * 访问路径 = route || url（与 createRoute3 现有取值逻辑一致）
- */
-export function getAccessPath(menu) {
-  if (!menu) return "";
-  return String(menu.route || menu.url || "");
-}
-
-/**
- * 取路径首段（不含查询串）；@ 开头的存量组件路径无首段语义，返回 ""
- */
-function getFirstSegment(path) {
-  return getSegments(path)[0] || "";
-}
-
-/** 切分路径为段数组（不含查询串）；@ 开头的存量组件路径无首段语义，返回 [] */
-function getSegments(path) {
-  if (!path || typeof path !== "string" || path.startsWith("@")) {
-    return [];
-  }
-  return path.split("?")[0].split("/").filter(Boolean);
-}
-
-/**
- * 取访问路径里的归属 appCode：仅 /micro/<appCode>/... 或
- * /micro_debug/<appCode>/... 形态才有归属，其余（主应用自身路由、
- * /base 命名空间、裸路径）一律返回 ""。
- */
-export function getOwnerSegment(path) {
-  const segs = getSegments(path);
-  if (segs.length < 2 || MICRO_SEGMENTS.indexOf(segs[0]) < 0) return "";
-  return segs[1];
-}
-
-/**
- * 切换访问路径的微前端命名空间（/micro/ ⇄ /micro_debug/），非微前端路径原样返回。
- * 用途：主应用在调试命名空间下装载子应用时，把下发的菜单路径一并换过去——
- * 子应用据此生成的路由才与浏览器 hash 对得上（主子路径始终保持一致）。
- */
-export function swapMicroNamespace(path, debug) {
-  const segs = getSegments(path);
-  if (segs.length < 2 || MICRO_SEGMENTS.indexOf(segs[0]) < 0) return path;
-  const target = debug ? MICRO_DEBUG_SEGMENT : MICRO_SEGMENT;
-  if (segs[0] === target) return path;
-  return "/" + target + stripFirstSegment(path);
-}
-
-/**
- * 按调试与否重写整条菜单的访问路径命名空间（浅拷贝，不改原对象）。
- * route 有值改 route，否则改 url——与 getAccessPath 的取值口径一致；
- * 单字段写法里 url 同时是组件路径，但 resolveComponentPath 对两个命名空间
- * 都会剥前缀，所以换过去不影响组件解析。
- */
-export function swapMenuNamespace(menu, debug) {
-  if (!menu) return menu;
-  const field = menu.route ? "route" : "url";
-  const swapped = swapMicroNamespace(String(menu[field] || ""), debug);
-  if (swapped === menu[field]) return menu;
-  return Object.assign({}, menu, { [field]: swapped });
-}
-
-/**
- * 解析菜单归属：访问路径的 /micro/<appCode>（或 /micro_debug/<appCode>）
- * 命中注册表则归属该子应用，否则（无前缀 / base / 未命中）归主应用，返回 ""。
- */
-export function resolveOwner(menu, registry) {
-  const seg = getOwnerSegment(getAccessPath(menu));
-  if (!seg || seg === BASE_SEGMENT) return "";
-  const apps = normalizeRegistry(registry);
-  return apps.some((app) => app.appCode === seg) ? seg : "";
-}
-
-/**
- * 解析组件路径（type 0 普通菜单）：
- * - "@..." 存量旧写法：url 即组件路径，原样返回；
- * - /micro/<appCode>/… 或 /micro_debug/<同>：剥掉归属两段后本地解析——条件是
- *   归属自己，或来源为 base（/micro/<any>/base/… 是包内组件，任何引包应用本地都有，
- *   不看归属直接本地渲染，省去为一个共享组件装载整个子应用）；
- * - 首段 base：转 @base/views 命名空间；
- * - 其余原样（无前缀走渲染方 @/views；归属别家的私有页原样返回交子应用渲染）。
- */
-export function resolveComponentPath(menu, rendererAppCode) {
-  const url = menu && menu.url != null ? String(menu.url) : "";
-  if (!url) return "";
-  if (url.startsWith("@")) return url;
-  const seg = getFirstSegment(url);
-  if (!seg) return url;
-  if (MICRO_SEGMENTS.indexOf(seg) >= 0) {
-    const owner = getOwnerSegment(url);
-    // 剥掉归属两段 /micro/<owner>；剩余首段为 base 即"包内组件来源"
-    const rest = stripFirstSegment(stripFirstSegment(url));
-    const isBaseSource = getFirstSegment(rest) === BASE_SEGMENT;
-    // 归属自己、或来源 base（包内组件人人有）→ 本地解析；否则（归属别家的私有页）原样返回。
-    // 递归一次把 rest 里的 base 命名空间转 @base/views；appCode 传空避免连剥两轮。
-    if (isBaseSource || (owner && rendererAppCode && owner === rendererAppCode)) {
-      return rest ? resolveComponentPath({ url: rest }, "") : "";
-    }
-    return url;
-  }
-  if (seg === BASE_SEGMENT) {
-    const rest = stripFirstSegment(url);
-    return rest ? BASE_VIEW_PREFIX + rest : "";
-  }
-  return url;
-}
-
-function stripFirstSegment(url) {
-  const clean = url.startsWith("/") ? url : "/" + url;
-  const idx = clean.indexOf("/", 1);
-  return idx > 0 ? clean.slice(idx) : "";
-}
-
-/**
- * 全量菜单按归属切分，返回 { appCode: [菜单行] }。
- * 主应用侧不需要切分结果——它始终用原始整树渲染侧边栏，直接用入参即可；
- * 这里只产出各子应用归属自己的扁平列表（用于 props 下发生成子应用内部路由）。
- */
-export function dispatchMenus(menus, registry) {
-  const apps = normalizeRegistry(registry);
-  const subAppMenus = {};
-  apps.forEach((app) => {
-    subAppMenus[app.appCode] = [];
-  });
-  const walk = (rows) => {
-    (rows || []).forEach((row) => {
-      const owner = resolveOwner(row, apps);
-      if (owner) {
-        subAppMenus[owner].push(row);
-      }
-      if (row && row.children && row.children.length) {
-        walk(row.children);
-      }
-    });
-  };
-  walk(menus || []);
-  return subAppMenus;
-}
-
-/**
- * 校验应用注册表（逻辑参数 micro_app_registry 的 paramValue）。
- * 非法条目跳过并记入 errors，绝不静默；enabled === false 的合法条目不收录也不报错。
- * appCode 处在 /micro/ 命名空间内，与主应用一级视图目录天然隔离，无需再防目录撞名；
- * 仅保留 base（组件来源命名空间）与 micro / micro_debug（前缀自身）三个保留字。
- * options.reservedSegments 可追加应用自定义保留字。
- */
-export function validateRegistry(raw, options = {}) {
-  const errors = [];
-  let list = raw;
-  if (typeof raw === "string") {
-    try {
-      list = JSON.parse(raw);
-    } catch (e) {
-      return { apps: [], errors: ["注册表 JSON 解析失败: " + e.message] };
-    }
-  }
-  if (!Array.isArray(list)) {
-    return { apps: [], errors: ["注册表必须是 JSON 数组"] };
-  }
-  const reserved = [BASE_SEGMENT]
-    .concat(MICRO_SEGMENTS)
-    .concat(options.reservedSegments || []);
-  const apps = [];
-  const seen = {};
-  list.forEach((item, index) => {
-    const tag = "注册表第" + (index + 1) + "项";
-    if (!item || typeof item !== "object" || Array.isArray(item)) {
-      errors.push(tag + "不是对象");
-      return;
-    }
-    const appCode = item.appCode;
-    if (!appCode || typeof appCode !== "string" || !APP_CODE_REG.test(appCode)) {
-      errors.push(tag + " appCode 缺失或格式非法: " + JSON.stringify(appCode));
-      return;
-    }
-    if (reserved.indexOf(appCode) >= 0) {
-      errors.push(tag + " appCode 与保留字/视图目录撞名: " + appCode);
-      return;
-    }
-    if (seen[appCode]) {
-      errors.push(tag + " appCode 重复: " + appCode);
-      return;
-    }
-    if (typeof item.entry !== "string" || !item.entry.trim()) {
-      errors.push(
-        tag
-          + "（"
-          + appCode
-          + "）entry 必须是非空字符串（分环境对象写法已废弃，"
-          + "注册表本身按环境分库；本机联调用 /"
-          + MICRO_DEBUG_SEGMENT
-          + "/ 命名空间）"
-      );
-      return;
-    }
-    seen[appCode] = true;
-    if (item.enabled === false) return;
-    apps.push({
-      appCode: appCode,
-      appName: item.appName || appCode,
-      entry: item.entry.trim(),
-      enabled: true,
-    });
-  });
-  return { apps, errors };
-}
-
-/**
- * 解析调试开关（逻辑参数 micro_debug_enabled 的值）→ 布尔。
- * 与注册表分开承载：注册表描述"有哪些应用"，本开关是环境级运维动作，
- * 生命周期不同——运维开关调试不必改注册表 JSON，少一类把注册表改坏的风险。
- *
- *   "true"（忽略大小写与首尾空格）→ 开启
- *   其余一切（不存在 / 空 / "false" / 认不出的值）→ 关闭
- *
- * 只认一个字面量、其余一律关闭，是有意的安全默认：认不出就不放行，
- * 不会因为写了个形近值而把某个环境悄悄放开。
- */
-export function isDebugEnabled(raw) {
-  return (raw == null ? "" : String(raw)).trim().toLowerCase() === "true";
-}
-
-/**
- * 取 entry。不再支持分环境对象写法：注册表存在后端逻辑参数里，本身已按环境分库，
- * 主应用连哪个后端就拿到哪份注册表——再按前端 NODE_ENV 分一次是重复机制。
- * 本机联调走 /micro_debug/ 命名空间（显式、按 URL 生效），不依赖构建环境。
- */
-export function resolveEntry(entry) {
-  return typeof entry === "string" ? entry.trim() : "";
-}
-
-function normalizeRegistry(registry) {
-  if (!registry) return [];
-  const list = Array.isArray(registry) ? registry : registry.apps || [];
-  return list.filter((app) => {
-    return app
-      && typeof app.appCode === "string"
-      && app.appCode
-      && app.enabled !== false;
-  });
-}
+/**
+ * 微前端菜单适配层（零依赖纯函数）。
+ * 供引包应用与未引包主应用（deep-import 本文件）共用，
+ * 禁止在此引入 @base 的 store / router / request / 组件。
+ * 协议说明见 docs/qiankun微前端改造-实现方案.md 第三章。
+ */
+
+// 表单菜单（动态表单）类型值，菜单归属识别的唯一权威标识
+export const FORM_MENU_TYPE = 5;
+
+// url 命名空间保留首段：/base/xxx 表示组件在 npm 包内（@base/views/xxx）
+export const BASE_SEGMENT = "base";
+
+/**
+ * 微前端固定前缀：访问路径形如 /micro/<appCode>/<来源>/<组件路径>。
+ * 用固定前缀而非"首段即 appCode"，是为了让归属命名空间与主应用自身的
+ * 一级视图目录（/user、/pmd、/yx…）结构性隔离——否则注册一个与视图目录
+ * 同名的 appCode 会劫持主应用整棵子树，且新增视图目录还会反向撞掉已注册的应用。
+ */
+export const MICRO_SEGMENT = "micro";
+
+/**
+ * 本机调试命名空间：/micro_debug/<appCode>/... 与 /micro/<appCode>/... 归属相同、
+ * 菜单相同、组件解析相同，**只有 entry 不同**（正式取注册表，调试取约定端口）。
+ * 把"调试还是正式"编码进路径而非存储，是为了让调试态无状态——不会残留在
+ * localStorage 里跨天生效，刷新/分享/多标签页的行为都由 URL 自身决定。
+ */
+export const MICRO_DEBUG_SEGMENT = "micro_debug";
+
+const MICRO_SEGMENTS = [MICRO_SEGMENT, MICRO_DEBUG_SEGMENT];
+const BASE_VIEW_PREFIX = "@base/views";
+const APP_CODE_REG = /^[A-Za-z][A-Za-z0-9_-]*$/;
+
+export function isFormMenu(menu) {
+  return !!menu && menu.type === FORM_MENU_TYPE;
+}
+
+/**
+ * 访问路径 = route || url（与 createRoute3 现有取值逻辑一致）
+ */
+export function getAccessPath(menu) {
+  if (!menu) return "";
+  return String(menu.route || menu.url || "");
+}
+
+/**
+ * 取路径首段（不含查询串）；@ 开头的存量组件路径无首段语义，返回 ""
+ */
+function getFirstSegment(path) {
+  return getSegments(path)[0] || "";
+}
+
+/** 切分路径为段数组（不含查询串）；@ 开头的存量组件路径无首段语义，返回 [] */
+function getSegments(path) {
+  if (!path || typeof path !== "string" || path.startsWith("@")) {
+    return [];
+  }
+  return path.split("?")[0].split("/").filter(Boolean);
+}
+
+/**
+ * 取访问路径里的归属 appCode：仅 /micro/<appCode>/... 或
+ * /micro_debug/<appCode>/... 形态才有归属，其余（主应用自身路由、
+ * /base 命名空间、裸路径）一律返回 ""。
+ */
+export function getOwnerSegment(path) {
+  const segs = getSegments(path);
+  if (segs.length < 2 || MICRO_SEGMENTS.indexOf(segs[0]) < 0) return "";
+  return segs[1];
+}
+
+/**
+ * 切换访问路径的微前端命名空间（/micro/ ⇄ /micro_debug/），非微前端路径原样返回。
+ * 用途：主应用在调试命名空间下装载子应用时，把下发的菜单路径一并换过去——
+ * 子应用据此生成的路由才与浏览器 hash 对得上（主子路径始终保持一致）。
+ */
+export function swapMicroNamespace(path, debug) {
+  const segs = getSegments(path);
+  if (segs.length < 2 || MICRO_SEGMENTS.indexOf(segs[0]) < 0) return path;
+  const target = debug ? MICRO_DEBUG_SEGMENT : MICRO_SEGMENT;
+  if (segs[0] === target) return path;
+  return "/" + target + stripFirstSegment(path);
+}
+
+/**
+ * 按调试与否重写整条菜单的访问路径命名空间（浅拷贝，不改原对象）。
+ * route 有值改 route，否则改 url——与 getAccessPath 的取值口径一致；
+ * 单字段写法里 url 同时是组件路径，但 resolveComponentPath 对两个命名空间
+ * 都会剥前缀，所以换过去不影响组件解析。
+ */
+export function swapMenuNamespace(menu, debug) {
+  if (!menu) return menu;
+  const field = menu.route ? "route" : "url";
+  const swapped = swapMicroNamespace(String(menu[field] || ""), debug);
+  if (swapped === menu[field]) return menu;
+  return Object.assign({}, menu, { [field]: swapped });
+}
+
+/**
+ * 解析菜单归属：访问路径的 /micro/<appCode>（或 /micro_debug/<appCode>）
+ * 命中注册表则归属该子应用，否则（无前缀 / base / 未命中）归主应用，返回 ""。
+ */
+export function resolveOwner(menu, registry) {
+  const seg = getOwnerSegment(getAccessPath(menu));
+  if (!seg || seg === BASE_SEGMENT) return "";
+  const apps = normalizeRegistry(registry);
+  return apps.some((app) => app.appCode === seg) ? seg : "";
+}
+
+/**
+ * 解析组件路径（type 0 普通菜单）：
+ * - "@..." 存量旧写法：url 即组件路径，原样返回；
+ * - /micro/<appCode>/… 或 /micro_debug/<同>：剥掉归属两段后本地解析——条件是
+ *   归属自己，或来源为 base（/micro/<any>/base/… 是包内组件，任何引包应用本地都有，
+ *   不看归属直接本地渲染，省去为一个共享组件装载整个子应用）；
+ * - 首段 base：转 @base/views 命名空间；
+ * - 其余原样（无前缀走渲染方 @/views；归属别家的私有页原样返回交子应用渲染）。
+ */
+export function resolveComponentPath(menu, rendererAppCode) {
+  const url = menu && menu.url != null ? String(menu.url) : "";
+  if (!url) return "";
+  if (url.startsWith("@")) return url;
+  const seg = getFirstSegment(url);
+  if (!seg) return url;
+  if (MICRO_SEGMENTS.indexOf(seg) >= 0) {
+    const owner = getOwnerSegment(url);
+    // 剥掉归属两段 /micro/<owner>；剩余首段为 base 即"包内组件来源"
+    const rest = stripFirstSegment(stripFirstSegment(url));
+    const isBaseSource = getFirstSegment(rest) === BASE_SEGMENT;
+    // 归属自己、或来源 base（包内组件人人有）→ 本地解析；否则（归属别家的私有页）原样返回。
+    // 递归一次把 rest 里的 base 命名空间转 @base/views；appCode 传空避免连剥两轮。
+    if (isBaseSource || (owner && rendererAppCode && owner === rendererAppCode)) {
+      return rest ? resolveComponentPath({ url: rest }, "") : "";
+    }
+    return url;
+  }
+  if (seg === BASE_SEGMENT) {
+    const rest = stripFirstSegment(url);
+    return rest ? BASE_VIEW_PREFIX + rest : "";
+  }
+  return url;
+}
+
+function stripFirstSegment(url) {
+  const clean = url.startsWith("/") ? url : "/" + url;
+  const idx = clean.indexOf("/", 1);
+  return idx > 0 ? clean.slice(idx) : "";
+}
+
+/**
+ * 全量菜单按归属切分，返回 { appCode: [菜单行] }。
+ * 主应用侧不需要切分结果——它始终用原始整树渲染侧边栏，直接用入参即可；
+ * 这里只产出各子应用归属自己的扁平列表（用于 props 下发生成子应用内部路由）。
+ */
+export function dispatchMenus(menus, registry) {
+  const apps = normalizeRegistry(registry);
+  const subAppMenus = {};
+  apps.forEach((app) => {
+    subAppMenus[app.appCode] = [];
+  });
+  const walk = (rows) => {
+    (rows || []).forEach((row) => {
+      const owner = resolveOwner(row, apps);
+      if (owner) {
+        subAppMenus[owner].push(row);
+      }
+      if (row && row.children && row.children.length) {
+        walk(row.children);
+      }
+    });
+  };
+  walk(menus || []);
+  return subAppMenus;
+}
+
+/**
+ * 校验应用注册表（逻辑参数 micro_app_registry 的 paramValue）。
+ * 非法条目跳过并记入 errors，绝不静默；enabled === false 的合法条目不收录也不报错。
+ * appCode 处在 /micro/ 命名空间内，与主应用一级视图目录天然隔离，无需再防目录撞名；
+ * 仅保留 base（组件来源命名空间）与 micro / micro_debug（前缀自身）三个保留字。
+ * options.reservedSegments 可追加应用自定义保留字。
+ */
+export function validateRegistry(raw, options = {}) {
+  const errors = [];
+  let list = raw;
+  if (typeof raw === "string") {
+    try {
+      list = JSON.parse(raw);
+    } catch (e) {
+      return { apps: [], errors: ["注册表 JSON 解析失败: " + e.message] };
+    }
+  }
+  if (!Array.isArray(list)) {
+    return { apps: [], errors: ["注册表必须是 JSON 数组"] };
+  }
+  const reserved = [BASE_SEGMENT]
+    .concat(MICRO_SEGMENTS)
+    .concat(options.reservedSegments || []);
+  const apps = [];
+  const seen = {};
+  list.forEach((item, index) => {
+    const tag = "注册表第" + (index + 1) + "项";
+    if (!item || typeof item !== "object" || Array.isArray(item)) {
+      errors.push(tag + "不是对象");
+      return;
+    }
+    const appCode = item.appCode;
+    if (!appCode || typeof appCode !== "string" || !APP_CODE_REG.test(appCode)) {
+      errors.push(tag + " appCode 缺失或格式非法: " + JSON.stringify(appCode));
+      return;
+    }
+    if (reserved.indexOf(appCode) >= 0) {
+      errors.push(tag + " appCode 与保留字/视图目录撞名: " + appCode);
+      return;
+    }
+    if (seen[appCode]) {
+      errors.push(tag + " appCode 重复: " + appCode);
+      return;
+    }
+    if (typeof item.entry !== "string" || !item.entry.trim()) {
+      errors.push(
+        tag
+          + "（"
+          + appCode
+          + "）entry 必须是非空字符串（分环境对象写法已废弃，"
+          + "注册表本身按环境分库；本机联调用 /"
+          + MICRO_DEBUG_SEGMENT
+          + "/ 命名空间）"
+      );
+      return;
+    }
+    seen[appCode] = true;
+    if (item.enabled === false) return;
+    apps.push({
+      appCode: appCode,
+      appName: item.appName || appCode,
+      entry: item.entry.trim(),
+      enabled: true,
+    });
+  });
+  return { apps, errors };
+}
+
+/**
+ * 解析调试开关（逻辑参数 micro_debug_enabled 的值）→ 布尔。
+ * 与注册表分开承载：注册表描述"有哪些应用"，本开关是环境级运维动作，
+ * 生命周期不同——运维开关调试不必改注册表 JSON，少一类把注册表改坏的风险。
+ *
+ *   "true"（忽略大小写与首尾空格）→ 开启
+ *   其余一切（不存在 / 空 / "false" / 认不出的值）→ 关闭
+ *
+ * 只认一个字面量、其余一律关闭，是有意的安全默认：认不出就不放行，
+ * 不会因为写了个形近值而把某个环境悄悄放开。
+ */
+export function isDebugEnabled(raw) {
+  return (raw == null ? "" : String(raw)).trim().toLowerCase() === "true";
+}
+
+/**
+ * 取 entry。不再支持分环境对象写法：注册表存在后端逻辑参数里，本身已按环境分库，
+ * 主应用连哪个后端就拿到哪份注册表——再按前端 NODE_ENV 分一次是重复机制。
+ * 本机联调走 /micro_debug/ 命名空间（显式、按 URL 生效），不依赖构建环境。
+ */
+export function resolveEntry(entry) {
+  return typeof entry === "string" ? entry.trim() : "";
+}
+
+function normalizeRegistry(registry) {
+  if (!registry) return [];
+  const list = Array.isArray(registry) ? registry : registry.apps || [];
+  return list.filter((app) => {
+    return app
+      && typeof app.appCode === "string"
+      && app.appCode
+      && app.enabled !== false;
+  });
+}