Docker和VS Code的Go开发环境

2019-09-16  本文已影响0人  开心人开发世界

上次我创建了一个简单的脚本,启动了一个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扩展支持的强大调试功能。


限制

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


总结

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

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

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

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

上一篇下一篇

猜你喜欢

热点阅读