使用vscode进行debug位于docker容器中的golan

debug在程序开发中具有重要的作用，通过debug，我们能定位到程序错误，修复bug和优化代码，当golang程序跑在容器中的环境时，我们也可以对程序debug，可以通过vscode进行debug

以下测试，我会写对应的两个Dockerfile文件，一份是为了run程序，一份是为了debug程序
以下是对应的项目工程结构，

image.png

1、应用程序

这边是我的golang主程序代码,http是采用8080端口进行监听

package main

import (
    "fmt"
    "net/http"
)

func hello(w http.ResponseWriter, req *http.Request) {
    fmt.Println("/hello endpoint called")
    fmt.Fprintf(w, "hello\n")
}

func main() {
    http.HandleFunc("/hello", hello)
    fmt.Println("Server up and listening...")
    http.ListenAndServe(":8080", nil)
}

2、Dockerfile

这边是构建golang程序所需要的Dockerfile文件

FROM golang:1.22.4 as builder
MAINTAINER 873026940@qq.com

COPY ./ /go/src
WORKDIR /go/src


ENV GO111MODULE=off
RUN CGO_ENABLED=0 go build -o mtgo main.go
EXPOSE 8080 
CMD [  "/go/src/mtgo" ]

3、构建和启动镜像

docker build . --tag hello-image
docker run --publish 8080:8080 --name hello-image hello-server

这时就成功构建出了镜像 hello-image和启动镜像

4、测试

在浏览器中访问http://localhost:8080/hello
显示如下，代码容器中golang程序跑通了

image.png

5、开始debug

接着，开始对容器中的程序进行debug，我们应该重新编写一份Dockerfile文件，专门用于debug用的，这样我们的dockerfile不用经常切来切去

6、Dockerfile.debug

这个Dockerfile.debug是专门用来debug用的，和Dockerfile进行区分开来,内容如下

# mac本地运行docker方式参考: 
FROM golang:1.22.4 as builder
MAINTAINER 873026940@qq.com
RUN CGO_ENABLED=0 go install -ldflags "-s -w -extldflags '-static'" github.com/go-delve/delve/cmd/dlv@latest


COPY ./ /go/src
WORKDIR /go/src


ENV GO111MODULE=off
RUN CGO_ENABLED=0 go build -gcflags "all=-N -l" -o mtgo main.go
EXPOSE 8080 4000
CMD [ "/go/bin/dlv", "--listen=:4000", "--headless=true", "--log=true", "--accept-multiclient", "--api-version=2", "exec", "/go/src/mtgo" ]

1、在这个镜像环境中，我们安装了dlv程序，注意这个最好放在dockerfile文件的开头位置，这样安装好之后，类似全局命令一样，最好别放在COPY和WORKDIR命令后面（可能会影响构建）
2、go build编译程序的时候增加了-gcflags "all=-N -l"命令，
3、CMD执行dlv，告诉dlv监听4000端口

7、launch.json

vscode进行debug程序，我们需要依赖.vocode/launch.json这个文件，文件内容如下

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Remote Docker App",
            "type": "go",
            "request": "attach",
            "mode": "remote",
            "port": 4000,
            "host": "127.0.0.1"
        }
    ]
}

这边的4000端口需要和Dockerfile.debug中CMD监听的端口一一对应上

8、构建和启动镜像

docker build . --tag debug-image --file Dockerfile.debug
docker run --publish 8080:8080 --publish 4000:4000 --name debug-server debug-image

这边的端口映射 8080对应的是程序的http监听端口，4000是 launch.json中监听和CMD监听的端口

执行这边的命令后，就可以正常debug程序了

9、开始debug

点击vscode的run and debug，进行开始debug

image.png

如图所示，在程序中增加了断点，这时候访问http://localhost:8080/hello，就可以debug到程序了

image.png