使用vscode进行debug位于docker容器中的golang程序

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容