Dumi项目中Hash路由模式下Base配置的注意事项

问题背景

在使用Dumi构建文档站点时，开发者可能会遇到一个特殊场景：当项目需要部署在非根目录下，同时使用Hash路由模式时，配置不当会导致页面白屏且无报错的问题。这种情况在Dumi 2.4.14版本中被发现并确认。

问题现象

当开发者在dumi配置中同时设置了以下内容时：

• base: '/docs-dist/'（指定项目部署的基础路径）
• history: { type: "hash" }（使用Hash路由模式）
• publicPath: '/docs-dist/'（指定静态资源路径）

页面访问会出现白屏现象，且控制台没有任何错误提示。而当注释掉Hash路由配置后，页面又能正常显示。

技术分析

Hash路由与Browser路由的区别

在Web应用中，路由模式主要分为两种：

1. Browser路由：依赖HTML5 History API，URL显示为常规路径（如/docs-dist/page）
2. Hash路由：使用URL的hash部分（如/#/page），兼容性更好，不需要服务器额外配置

Base配置的作用

base配置项用于指定应用部署的基础路径，这在项目部署到非根目录时尤为重要。它会影响：

• 路由匹配
• 静态资源路径
• 导航链接生成

解决方案

经过验证，在Dumi中使用Hash路由模式时，不应设置base配置项。这是因为：

1. Hash路由本身不依赖路径前缀，它的路由信息存储在#之后
2. 浏览器对hash部分的处理与常规路径不同，不需要base前缀
3. 静态资源路径仍可通过publicPath单独配置

正确的配置方式应该是：

export default defineConfig({
  outputPath: 'docs-dist',
  themeConfig: {
    name: 'test',
  },
  publicPath: '/docs-dist/', // 仅配置静态资源路径
  history: {
    type: "hash" // 使用hash路由
  },
  exportStatic: false,
});

最佳实践建议

1. 非必要不使用Hash路由：除非有特殊兼容性需求，否则推荐使用默认的Browser路由
2. 部署路径规划：尽量将项目部署在根目录，避免复杂的路径配置
3. 测试验证：部署前应在本地使用serve等工具模拟生产环境测试
4. 文档查阅：仔细阅读框架文档中关于路由和部署的说明

总结

Dumi作为专业的文档工具，在大多数情况下都能很好地处理各种部署场景。但当遇到特殊配置组合时，开发者需要理解底层原理。Hash路由与base配置的冲突问题，本质上是因为两种机制对URL处理方式的差异导致的。通过合理配置和深入理解，可以避免这类问题的发生。

对于文档类项目，如果必须使用Hash路由，记住只需配置publicPath而无需设置base，这是解决此类白屏问题的关键。