首页
/ Umi.js 项目中获取路由 basename 的最佳实践

Umi.js 项目中获取路由 basename 的最佳实践

2025-05-14 20:54:17作者:滕妙奇

在 Umi.js 项目中,开发者有时需要获取当前应用的路由 basename 值,特别是在处理跨应用跳转、微前端场景或自定义插件开发时。本文将深入探讨几种获取 basename 的可靠方法。

为什么需要 basename

basename 是 Umi.js 应用的基础路径前缀,通常在配置文件中通过 base 参数设置。在以下场景中特别重要:

  1. 微前端架构中子应用需要拼接完整路径
  2. 自定义插件中需要处理登录跳转等逻辑
  3. 跨应用导航时需要确保路径正确性

获取 basename 的几种方式

1. 通过环境变量注入

最推荐的方式是在配置文件中使用 define 配置项:

// .umirc.ts
export default {
  define: {
    BASE_NAME: '/your-base-path'
  }
}

然后在代码中通过 process.env.BASE_NAME 获取。

2. 通过 modifyClientRenderOpts 钩子

app.ts 中,可以通过修改客户端渲染选项获取:

// src/app.ts
export const modifyClientRenderOpts = (opts: any) => {
  console.log('basename:', opts.basename);
  return opts;
}

3. 微前端场景下的处理

在 qiankun 微前端架构中,子应用可以通过以下方式获取完整路径:

  • 通过主应用传递的 props 获取
  • 使用全局状态管理共享 basename
  • 在主应用生命周期钩子中暴露 basename

注意事项

  1. 避免直接依赖内部实现,如直接导入 @@/core/history
  2. 生产环境和开发环境的 basename 可能不同,需要做好兼容
  3. 在 SSR 场景下,需要考虑服务端和客户端 basename 的一致性

最佳实践建议

对于大多数场景,推荐使用环境变量注入的方式,这是最稳定且符合 Umi.js 设计理念的做法。对于复杂场景,可以考虑结合多种方式,确保应用在不同环境下都能正确获取 basename。

通过合理使用这些方法,开发者可以优雅地处理各种需要 basename 的场景,确保应用的稳定性和可维护性。

登录后查看全文
热门项目推荐
相关项目推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K