Docker和VS Code的Go开发环境

上次我创建了一个简单的脚本,启动了一个Docker容器,可以从我的本地机器同步和执行Go源代码。但我还没有解释如何支持IntelliSense和调试,这对开发至关重要。让本文介绍一下。


注意事项

当我研究这个目标的解决方案时,我有点担心,因为它很大程度上依赖于代码编辑器/ IDE的供应商在容器内工作。幸运的是,有两个受欢迎的编辑器支持这一点:GoLand和VS Code。

GoLand支持看起来非常成熟,因为它已经存在了一段时间(源自IntelliJ)。但是,此功能仅适用于购买的版本。

VS Code Remote-Containers扩展程序刚刚发布,因此它没有GoLand那么成熟。尽管如此,该扩展程序是由Microsoft(非开源)正式开发和维护的,并计划在很多未来的服务中用作Web伴侣IDE或云IDE - 因此它非常有前途。在撰写本文时,功能集看起来也足以启动。我们来看看VS Code吧。

显然,我们可以直接在容器中使用Vim并在其中安装很棒的插件。然而,这将是我的最后一次考虑,因为我不仅为我而且为我的团队(以及你的团队)设置了这个,而且Vim的学习曲线对于大多数开发人员而言非常沉重。


VS Code远程容器

概念

VS Code Remote-Containers是一个扩展,可以帮助开发人员正常使用他们的VSC ode UI,但所有命令和操作都在容器内传播和执行。它实际上就像你是TeamViewer进入容器并在其中使用VS Code。

VS Code的实现非常强大且抽象,大多数扩展仍然可以正常工作。

有了这个概念,我们可以将环境容纳在几乎所有类型的开发中,而不仅仅是Go。

详细

安装VS Code Remote-Containers扩展。

Dockerfile使用运行和调试应用程序所需的包和工具来编写定义图像。

.devcontainer.json在工作区根目录(旁边.vscode)创建一个引用Dockerfile

{
   "dockerFile": "Dockerfile",
   "extensions": [ 
      "ms-vscode.go" 
   ]
}

.devcontainer.json使用VS Code 打开包含文件的文件夹。VS Code将自动检测它并要求您以容器模式打开项目。

然后,VSCode将根据您Dockerfile(仅在第一次)构建您的图像,并将设置一些额外的必需包,以便它可以容器化地工作。

完成此过程后,您现在可以正常使用VS Code,并且所有内容都实际在容器内运行。

像上面的例子一样,我甚至没有go在本地机器上运行,但我仍然可以从我的VS代码执行Go代码,并且可以从Safari访问服务器。一切都在容器内完成。


实现

按照上面提到的概念和配方,我创建了一个Dockerfile

FROM golang:1

# Configure to reduce warnings and limitations as instruction from official VSCode Remote-Containers.
# See https://code.visualstudio.com/docs/remote/containers-advanced#_reducing-dockerfile-build-warnings.
ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update \
    && apt-get -y install --no-install-recommends apt-utils 2>&1

# Verify git, process tools, lsb-release (common in install instructions for CLIs) installed.
RUN apt-get -y install git iproute2 procps lsb-release

# Install Go tools.
RUN apt-get update \
    # Install gocode-gomod.
    && go get -x -d github.com/stamblerre/gocode 2>&1 \
    && go build -o gocode-gomod github.com/stamblerre/gocode \
    && mv gocode-gomod $GOPATH/bin/ \
    # Install other tools.
    && go get -u -v \
        golang.org/x/tools/cmd/gopls \
        github.com/mdempsky/gocode \
        github.com/uudashr/gopkgs/cmd/gopkgs \
        github.com/ramya-rao-a/go-outline \
        github.com/acroca/go-symbols \
        golang.org/x/tools/cmd/guru \
        golang.org/x/tools/cmd/gorename \
        github.com/go-delve/delve/cmd/dlv \
        github.com/stamblerre/gocode \
        github.com/rogpeppe/godef \
        golang.org/x/tools/cmd/goimports \
        golang.org/x/lint/golint 2>&1 \
    # Clean up.
    && apt-get autoremove -y \
    && apt-get clean -y \
    && rm -rf /var/lib/apt/lists/*

# Revert workaround at top layer.
ENV DEBIAN_FRONTEND=dialog

# Expose service ports.
EXPOSE 8000

图像基于官方golang图像,因此可以go正常支持。然后我安装了Go VS Code扩展所需的一些工具,以便能够实现IntelliSense,linting和调试功能。

然后我写了一个.devcontainer.json文件。

{
    "dockerFile": "Dockerfile",
    "appPort": [
        "8000:8000"
    ],
    "extensions": [
        "ms-vscode.go"
    ]
}

它只是引用我的Dockerfile并列出了VS Code应该安装到附加容器中的所有扩展。它还设置从本地计算机到容器的端口映射,反之亦然,这样我就可以直接从浏览器测试我的应用程序。


结果

我能够编写具有所有IntelliSense功能的代码,例如自动完成,自动导入,代码导航等。

我能够在本地计算机上安装Go运行时运行应用程序。感谢端口映射,我还可以从Safari测试我的应用程序。

我能够使用Go V SCode扩展支持的强大调试功能。


限制

我几乎拥有我需要的一切; 但是,仍然有一些限制,我觉得有点烦人:

  • 我必须解决一些问题才能使用VS Code git push命令,因为它需要我的SSH凭据绑定到容器
  • 我不能使用VS Code git commit命令GPG签署我的提交,因为它需要相当多的工作才能将GPG命令从容器转发到主机

总结

尽管仍然存在一些局限性,但我能够解决这里定义的史诗并拥有一个具有本地质量开发经验的全时集装箱化开发环境。

感谢微软的这一救命功能!

您可以在此处查看我为本文撰写的源代码。

翻译自:https://medium.com/better-programming/a-complete-go-development-environment-with-docker-and-vscode-a3e4410d27f7

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

推荐阅读更多精彩内容