go-zero项目中使用scratch基础镜像的容器调试技巧

在go-zero项目中，使用goctl工具生成的Dockerfile默认采用了scratch作为基础镜像。scratch是Docker中最轻量级的基础镜像，它不包含任何可执行文件或库，这使得生成的容器镜像体积非常小，但也带来了一些调试上的挑战。

scratch镜像的特点

scratch镜像是一个空镜像，它不包含：

• 任何可执行文件（如sh、bash等）
• 任何系统库
• 任何包管理器
• 任何系统工具

这种极简设计使得基于scratch构建的容器镜像非常小巧，但也意味着当我们需要进入容器进行调试时会遇到困难，因为容器内没有shell环境。

调试解决方案

方案一：使用busybox作为基础镜像

在生成Dockerfile时，可以通过指定--base参数来使用busybox替代scratch：

goctl docker --base busybox

busybox是一个集成了许多常用Unix工具（包括shell）的轻量级可执行文件，它只增加了少量体积但提供了完整的shell环境。

方案二：构建调试镜像

对于生产环境，可以维护两个版本的镜像：

1. 使用scratch的生产镜像
2. 使用busybox或alpine的调试镜像

在需要调试时，可以切换到调试镜像版本。

方案三：使用docker exec直接执行命令

即使容器中没有shell，如果容器中运行的是Go程序，也可以通过docker exec直接执行程序内置的命令或功能：

docker exec -it <container> ./app --debug

最佳实践建议

1. 开发环境可以使用busybox或alpine作为基础镜像，便于调试
2. 生产环境使用scratch以保持镜像最小化
3. 在应用程序中内置调试接口或健康检查端点
4. 考虑使用多阶段构建，在最终阶段使用scratch，但保留中间构建阶段用于调试

通过合理选择基础镜像和构建策略，可以在保持镜像轻量化的同时，也不牺牲可调试性。