SolidStart项目在Docker中启用HMR热模块替换的配置方法

问题背景

在使用SolidStart框架开发时，很多开发者会选择通过Docker容器来运行开发环境。然而，当项目运行在Docker容器中时，经常会遇到热模块替换(HMR)功能失效的问题。具体表现为：代码修改后页面不会自动刷新，需要手动刷新浏览器才能看到变更。

问题原因分析

这个问题的根源在于Docker容器与宿主机的网络通信机制。Vite的HMR功能默认会使用WebSocket连接来实现实时更新，但在Docker环境中：

1. HMR服务会随机选择端口
2. 这些随机端口通常没有在Docker端口映射中暴露
3. 客户端尝试连接的端口与服务器实际监听的端口不匹配

解决方案

配置HMR固定端口

通过修改SolidStart项目的配置文件，我们可以为HMR指定固定端口：

import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
  vite({ router }) {
    if (router === 'client') {
      return {
        server: {
          hmr: {
            port: 4000,  // 指定HMR服务端口
          },
        },
      };
    }
    return {};
  },
});

Docker运行命令调整

运行Docker容器时，需要同时映射应用端口和HMR端口：

docker run --rm -it -v $PWD:/usr/src/app -w /usr/src/app -p 3000:3000 -p 4000:4000 'oven/bun:latest' run dev

技术细节说明

1. 端口配置区别：

   • port: 指定HMR服务器实际监听的端口
   • clientPort: 仅告诉客户端连接哪个端口，不改变服务器端口

2. 类型定义问题：

   • 当前Vinxi的类型定义中省略了server属性
   • 临时解决方案是使用@ts-ignore忽略类型错误
   • 未来版本会修复这个类型定义问题

最佳实践建议

1. 对于Docker开发环境，建议始终为HMR指定固定端口
2. 端口号选择应避开常用端口范围(0-1024)
3. 开发和生产环境使用不同的配置文件
4. 考虑使用docker-compose来管理多端口映射

总结

通过正确配置HMR端口和确保Docker端口映射，可以完美解决SolidStart在Docker环境中的热更新问题。这种配置方式不仅适用于SolidStart，对于其他基于Vite的框架也有参考价值。开发者应该理解HMR工作原理，才能更好地解决各种环境下的开发体验问题。