我正在为 Windows 10 使用 vscode(1.34.0 内部和稳定版本)开发 Go (1.12.0) api-server。源代码位于 Windows 机器上定义的 %GOPATH% 中。Delve (dlv.exe - 1.2.0 版) 也安装在 %GOPATH%\bin 中,%GOPATH%\bin 也安装在 Windows %PATH% 中。
然后使用 docker-compose 在 Docker(Docker 桌面版本 2.0.0.3 (31259))容器中构建 go 应用程序(因为数据库和 Web 服务器等其他一些服务正在其他容器中运行)。然后将最终的 go 应用程序二进制文件与 delve 可执行文件一起复制到 Alpine-Linux 容器中,并以无头模式启动 delve 服务器。没有源代码被复制到 Alpine-Linux 容器中,只有二进制文件。
使用此设置,我无法在 vscode 中正确设置远程调试。调试器确实启动了我的应用程序,但任何断点都会立即变为灰色并变为“未验证”。当应用程序(api 服务器)运行时,它们也不会受到影响。
使用 Jetbrains 的 Goland IDE 进行远程调试时,使用此设置进行调试非常有效(调试器启动,可以设置断点并命中)。
在过去的几天里,我试图找到一个解决方案,在论坛上找到与 Chrome 调试、Node.js 调试等类似问题的论坛帖子,以及 Go 上的这篇帖子,特别是:
我还找到了这个示例配置:
https://github.com/lukehoban/webapp-go/blob/debugging/.vscode/launch.json
我认为我遇到的主要问题是,我在任何地方都找不到任何示例,说明如何在 launch.json 中为 Windows 机器上的远程调试配置正确设置程序的路径(我也找不到任何与此相关的文档)。源代码仅在 GOPATH 中的 Windows 机器上,而不是在应用程序和 delve 运行的最终容器中(这同样适用于 Goland 调试器)
我的项目路径/目录结构(简化):
%GOPATH%\github.com\myuser\project_dir\
.vscode\
launch.json
cmd\
my_api\
main.go
another_app\
main.go
package1\
package1.go (this is where I am setting the breakpoint, this package is imported in cmd\my_api\main.go)
Dockerfile
... (.gitignore, GoPkg etc.)
我当前的 launch.json 配置(请参阅下面我尝试的一些变体)
launch.json - 远程配置
{
"name": "RemoteDockerAPI",
"type": "go",
"request": "launch",
"mode": "remote",
"program": "${workspaceFolder}/cmd/my_api",
"env": {},
"args": [],
"remotePath": "/my_api",
"port": 40400, // Port
"host": "127.0.0.1", // Docker IP
"showLog": true
}
注意:project_folder/cmd/my_api 是 api 服务器的 main.go 所在的位置。但是,此应用程序的某些包直接位于项目文件夹下,即 project_folder/package1/package1.go
我试过了
"program": "${workspaceFolder}",
和
"program": "${workspaceFolder}\\cmd\\my_api",
和
"program": "${workspaceFolder}/cmd/my_api",
和
"program": "${workspaceFolder}\\cmd\\my_api\\main.go",
和
"program": "${workspaceFolder}/cmd/my_api/main.go",
我也试图改变这一点(没有明显的变化):
"remotePath": "/",
没有成功。
我用于构建应用程序并以无头模式启动 delve 的多阶段 Dockerfile:
FROM golang:1.11.6-alpine3.9 AS builder
RUN wget -O /usr/bin/dep 'https://github.com/golang/dep/releases/download/v0.5.1/dep-linux-amd64' \
&& chmod +x /usr/bin/dep
# For debugging: conmpile Delve
RUN apk add --no-cache git
RUN go get github.com/derekparker/delve/cmd/dlv
# Copy Code and build it:
WORKDIR $GOPATH/src/github.com/myuser/my_api/
COPY Gopkg.toml Gopkg.lock ./
RUN dep ensure --vendor-only
COPY . ./
# Compile with necessary flags for delve
RUN CGO_ENABLED=0 GOOS=linux go build -gcflags "all=-N -l" -a -installsuffix nocgo -o /my_api ./cmd/my_api
FROM alpine:3.9 AS runtime-base
# DEBUGGING: Allow delve to run on Alpine based containers.
RUN apk add --no-cache libc6-compat
# App container
FROM runtime-base
WORKDIR /
# Copy certificates
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
# Copy app
COPY --from=builder /my_api ./
# Copy delve
COPY --from=builder /go/bin/dlv /
# 40400 for delve
EXPOSE 40400
CMD ["/dlv","--listen=:40400","--headless=true","--api-version=2", "exec", "./my_api"]
我在其中一个包中设置了一个断点(不是在 project_dir/cmd/my_api/main.go 中,而是在 project_dir/package1/package1.go 中)。一旦我在 vscode 中启动调试器并且没有命中断点,它就会变成灰色并且“未经验证”。
我可能在一个非常简单的层面上做错了什么,但我似乎无法弄清楚是什么。
更新 我终于找到了调试器日志并看到了这个:
From client: setBreakpoints({"source":{"name":"package1.go","path":"c:\\Users\\myuser\\go\\src\\github.com\\githubaccount\\project_dir\\package1\\package1.go"},"lines":[165,170],"breakpoints":[{"line":165},{"line":170}],"sourceModified":false})
SetBreakPointsRequest
All cleared
Creating on: C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go (C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go) :165
Creating on: C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go (C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go) :170
Error on CreateBreakpoint: could not find C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:165
Error on CreateBreakpoint: could not find C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170
我不确定它是否能帮助我真正找出 vscode 的问题。这可能是一个错误吗?我找到了对旧 MacOS 错误的引用:
https://github.com/Microsoft/vscode-go/issues/1859
和
https://github.com/go-delve/delve/issues/1282
但这些都是旧的和固定的(?)。
除了windows路径分隔符(“\”)被vscode(?)转换为Unix风格的路径分隔符“/”外,路径正确,文件存在,设置断点的行在中间文件的(和正确的)...
在 vscode 中,如果我按住 CTRL 键单击“找不到..”中显示的路径(由 vscode 制成链接),它会将我直接带到文件(因此 vscode 可以找到/看到它没有问题)。
这在 Windows 主机上连接没有问题(但仅在从该目录中调用时):
%GOPATH%\...\project_dir\cmd\my_api\dlv debug -l 127.0.0.1:40400
和
(dlv) funcs any_function_in_package1
找到这个函数,所以(源)代码似乎是可见的。
直接在 Delve 中设置我想要的断点也可以:
(dlv) break C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170
Breakpoint 1 set at 0xad8dd8 for github.com/githubaccount/project_dir/package1.(*Struct).Function() C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170
Windows 样式的路径在命令行上也以相同的方式工作:
(dlv) break C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go:170
Breakpoint 1 set at 0xad8dd8 for github.com/githubaccount/project_dir/package1.(*Struct).Function() C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170
这是 vscode 中的 Windows/Unix 路径样式问题吗?有什么建议么?
更新 2 刚发现这个 2018 年末的错误报告,它似乎描述了 Delve 和 vscode 之间的类似问题:
https://github.com/bazelbuild/rules_go/issues/1844
但是,正如我在上面发布的那样,在我的情况下,Delve 似乎没有问题通过断点的绝对(Windows)路径,所以我不确定上述错误是否适用于这种情况?另外,为什么它会直接在 Delve 中工作,而不是通过 vscode?还是毕竟是 Windows 路径/Unix 路径问题?
感谢您的任何帮助!