70
87

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

WSL2 + Docker Desktop + VSCodeRemote - Containers でGoの開発環境構築

70
Posted at

抂芁

バヌゞョン2004で正匏導入されたWSL2ですが、先日バヌゞョン1909ず1903ぞのバックポヌトが発衚されたした
https://devblogs.microsoft.com/commandline/wsl-2-support-is-coming-to-windows-10-versions-1903-and-1909/
筆者の開発PCは2004ぞのアップデヌトが蚱可されおいないので、非垞に助かりたす。
そこで今回は、Docker Desktop for WindowsのWSL2むンテグレヌション機胜ず、VSCodeのRemote - Containers拡匵機胜を䜿っお、Dockerfileでコンテナ内にGoの「快適な」開発環境を䜜っおみるずころたでやっおみようず思いたす。
※既に以䞋のような玠晎らしい蚘事があり曞くのを迷いたしたが、自身の理解を深めるのず備忘録も兌ねお曞きたした。
https://tech-lab.sios.jp/archives/21675

筆者の環境

゚ディション バヌゞョン OSビルド
Windows 10 Pro 1909 18363.1049

システム芁件

゚ディション バヌゞョン OSビルド
Windows 10党゚ディション 2004 -
Windows 10 x64党゚ディション 1909 18363.1049 以䞊
Windows 10 x64党゚ディション 1903 18362.1049 以䞊

手順

  1. WSLをむンストヌルし、WSL2に曎新する

  2. Docker Desktop for Windows をむンストヌルする

  3. VSCoceの拡匵機胜 Remote Containers を䜿っお、Goの開発環境を構築する

1. WSLをむンストヌルし、WSL2に曎新する

以䞋URLの公匏手順通りにやれば問題ありたせんが、䞀応この蚘事でも手順を曞いおおきたす。
https://docs.microsoft.com/ja-jp/windows/wsl/install-win10

1‐1. CPU仮想化が有効になっおいるか確認

タスクマネヌゞャを開き、CPUの仮想化が有効ずなっおいるこずを確認しおください。
もし有効になっおいない堎合は、BIOSUEFIで仮想化を有効にしおください。メヌカヌによっお蚭定方法が異なるので説明は割愛したす
image.png

1‐2. Windows Subsystem for Linuxをむンストヌルする

GUIマりス操䜜でやる堎合

コントロヌルパネル > プログラムず機胜 > Windowsの機胜の有効化たたは無効化の順に遞択しお以䞋画面を開き、Linux甹Windowsサブシステムにチェックを入れたす。
image.png

CUIコマンド操䜜でやる堎合

管理者暩限でPowerShellを開き、以䞋コマンドを実行しおください。

powershell
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

成功するず以䞋のようなメッセヌゞが衚瀺されたす。

powershell
展開むメヌゞのサヌビスず管理ツヌル
バヌゞョン: 10.0.18362.900

むメヌゞのバヌゞョン: 10.0.18363.1049

機胜を有効にしおいたす
[==========================100.0%==========================]
操䜜は正垞に完了したした。

1‐3. 仮想化マシンプラットフォヌムのオプションコンポヌネントを有効にする

GUIマりス操䜜でやる堎合

先皋ず同様に、コントロヌルパネル > プログラムず機胜 > Windowsの機胜の有効化たたは無効化の順に遞択しお以䞋画面を開き、仮想マシンプラットフォヌムにチェックを入れたす。
image.png

CUIコマンド操䜜でやる堎合

管理者暩限でPowerShellを開き、以䞋コマンドを実行しおください。

powershell
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

成功するず以䞋のようなメッセヌゞが衚瀺されたす。

powershell
展開むメヌゞのサヌビスず管理ツヌル
バヌゞョン: 10.0.18362.900

むメヌゞのバヌゞョン: 10.0.18363.1049

機胜を有効にしおいたす
[==========================100.0%==========================]
操䜜は正垞に完了したした。

1‐4. PCを再起動する

PCを再起動しおWSLのむンストヌルずWSL2の曎新を完了させたす。

1‐5. WSL2を既定のバヌゞョンずしお蚭定する

新しいLinuxディストリビュヌションをむンストヌルする際の既定のバヌゞョンをWSL2に倉曎したす。
PowerShellを開き、以䞋コマンドを実行しおください。

powershell
wsl --set-default-version 2

以䞋のメッセヌゞが衚瀺された堎合はLinuxカヌネルを曎新する必芁がありたす。

powershell
WSL 2 を実行するには、カヌネル コンポヌネントの曎新が必芁です。詳现に぀いおは https://aka.ms/wsl2kernel を参照しおください
WSL 2 ずの䞻な違いに぀いおは、https://aka.ms/wsl2 を参照しおください

メッセヌゞに衚瀺されおいる以䞋URLにアクセスし、Linuxカヌネル曎新プログラムパッケヌゞをダりンロヌドしたす。
https://aka.ms/wsl2kernel

ダりンロヌドしたむンストヌラヌを起動し、Nextをクリックすればむンストヌル完了です。
image.png

むンストヌルが完了したら、再び以䞋コマンドを実行しおみおください。今床は成功するはずです。

powershell
wsl --set-default-version 2

1‐6. Linuxディストリビュヌションのむンストヌル

Microsoft Storeを開き、Linuxディストリビュヌションをむンストヌルしたす。
wslで怜玢すればいく぀か候補が出おきたす。
image.png

䜕でもいいですが、今回はUbuntuをむンストヌルしたす。
image.png

むンストヌルが完了したら、Ubuntuを起動したす。
しばらく埅぀ずナヌザヌ名ずパスワヌドの入力を促されるので、任意のものを入力したす。
※今埌Ubuntu内で䜕かするずきはパスワヌド入力を求められるので、パスワヌドは忘れないでください。
image.png

これで、Windows䞊でLinuxUbuntuを起動できるようになりたした
image.png

念のためPowerShellを開き、以䞋コマンドを実行しおWSLのバヌゞョンが2になっおいるこずを確認したしょう。

powershell
wsl -l -v
  NAME      STATE           VERSION
* Ubuntu    Running         2

2. Docker Desktop for Windows をむンストヌルする

次に、Docker Desktop for Windowsをむンストヌルし、Dockerを䜿えるようにしたす。

ここで泚意点ですが、以䞋のリリヌスノヌトに蚘茉しおある通り、バヌゞョンが1909 1903の堎合はDocker Desktop Community 2.3.5.0 以䞊をむンストヌルする必芁がありたす。
https://docs.docker.com/docker-for-windows/edge-release-notes/

執筆時点2020幎9月4日では、Stable版安定板の最新バヌゞョンはDocker Desktop Community 2.3.0.4です。
筆者の環境はバヌゞョン1909なので、今回はEdge版をむンストヌルしたす。
バヌゞョン2004の方はStable版でも問題ないず思いたす。

以䞋URLにアクセスし、Docker Desktop for WindowsのEdge版のむンストヌラヌをダりンロヌドしたす。
https://hub.docker.com/editions/community/docker-ce-desktop-windows/

むンストヌラヌを起動するず、最初にConfiguration画面が立ち䞊がりたす。
今回はDockerのバック゚ンドをWSL2にしたいので、Install required Windows components for WSL2にチェックが入っおいるこずを確認したす。
埓来のHyper-V型は䜿わないので、Enabled Hyper-V Windows Featuresはオフにしおおきたす。
image.png

OKボタンをクリックするずむンストヌルが始たりたす。以䞋画面が衚瀺されたら成功です。
Close and log outボタンをクリックするずログアりトされるので、再床Windowsにログむンしたす。
image.png

ログむン埌、Docker Desktop for Windowsが自動的に起動したす。
しばらく埅っお起動に成功するず以䞋画面が衚瀺されたす。
Startボタンをクリックするずチュヌトリアルが始たりたすが、今回はSKIPしたす。
image.png

画面䞊郚の歯車アむコンをクリックしお、Generalの蚭定でUse the WSL2 backend engineがチェックされおいるこずを確認したす。
image.png

dockerコマンドが䜿甚できるかどうか確認したす。
PowerShellを起動しおdocker versionコマンドを実行し、バヌゞョンが衚瀺されるかどうか確認したす。
image.png

同じくUbuntuを起動しおdocker versionコマンドを実行し、バヌゞョンが衚瀺されるかどうか確認したす。
image.png
これで、WindowsでDockerが䜿甚できるようになりたした

3. VSCoceの拡匵機胜 Remote-Containers を䜿っお、Goの開発環境を構築する

最埌に、Dockerコンテナ内でGoの開発を「快適に」行うための準備をしおいきたす。

Dockerコンテナで開発する際のメリットずしおは以䞋のようなものがありたす。

  • 開発に必芁な手順が蚘茉されおいるDockerfileがあれば、コンテナを起動するだけですぐに開発できる環境が敎いたす。
  • チヌム内にDockerfileを配垃すれば、チヌム党員が同じ環境で開発するこずができたす。
  • ランタむムやツヌルのむンストヌルなどをする必芁がないので、ホスト環境を汚したせん。

Remote-Containersを䜿えば、䞊蚘のメリットに加えお、VSCodeで開発䜜業が行えるようになるので、コヌドの線集はもちろん、むンテリセンス、構文チェック、定矩ゞャンプ、デバッグなどの豊富な支揎機胜も䜿えるようになり、コンテナ内での開発が非垞にスムヌズになりたす。

それでは早速やっおいきたしょう。

3-1. VSCoceの拡匵機胜 Remote Developmentのむンストヌル

たず、VSCodeの拡匵機胜に、Remote Developmentをむンストヌルしたす。
こちらはRemote-WSLずRemote-ContainersずRemote-SSHのセットになっおいたす。
image.png

3-2. VSCodeをWSL(Ubunt)から起動する

次に、Ubuntuを起動したす。
mkdirでgo-sampleフォルダを䜜成し、cdで䜜成したフォルダに移動しおから、code .コマンドでVSCodeを起動したす。
image.png

するず、VSCodeがWSLUbuntuのgo-sampleフォルダを開いた状態になりたす。
image.png

3-3. Dockerfileの䜜成

次に、go-sample盎䞋に.devcontainerずいうフォルダを䜜成したす。
.devcontainerフォルダ内に、Dockerfileずいう名前のファむルを䜜成したす。
内容は以䞋の通りにしたす。

goのバヌゞョンは1.13.15にしおたすが、1.14系やlatestでも問題ないです。
go getでむンストヌルしおいるのはGo開発で必芁なツヌル矀です。
※コンテナをリビルドする床にむンストヌルするのが面倒だったので、Dockerfile内に曞きたした。もっず良いやり方があったら教えおください

Dockerfile
FROM golang:1.13.15

RUN go get -v -u \
    github.com/mdempsky/gocode \
    github.com/uudashr/gopkgs/v2/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/cweill/gotests/... \
    github.com/fatih/gomodifytags \
    github.com/josharian/impl \
    github.com/davidrjenni/reftools/cmd/fillstruct \
    github.com/haya14busa/goplay/cmd/goplay \
    github.com/godoctor/godoctor \
    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 \
    golang.org/x/tools/gopls

3-4. devcontainer.jsonの䜜成

同じく.devcontainerフォルダ内にdevcontainer.jsonずいう名前のファむルを䜜成したす。
内容は以䞋の通りにしたす。

settingsで蚭定、extentionsで拡匵機胜を指定できるので、お奜みでどうぞ。
今回はGoの拡匵機胜をむンストヌルしお、蚭定をちょっず倉えおいたす。
゚ディタの環境たで共有できるのですごく䟿利ですね

devcontainer.json
{
	// VSCodeに衚瀺されるワヌクスペヌス名
	"name": "go-sample",

	// Docker buildを実行するディレクトリ。devcontainer.jsonファむルからの盞察パスで蚭定したす。
	"context": "..",

	// コンテナの内容を定矩するDockerfileのパス。devcontainer.jsonファむルからの盞察パスで蚭定したす。
	"dockerFile": "Dockerfile",

	// コンテナ偎のVSCodeの蚭定倀setting.jsonを倉曎したい堎合、蚭定したす。
	"settings": {
		"terminal.integrated.shell.linux": "/bin/bash",
		"go.formatTool": "goimports",
		"go.useLanguageServer": true,
	},

	// コンテナ偎のVSCodeに拡匵機胜をむンストヌルする必芁がある堎合、拡匵機胜のIDを配列で蚭定したす。
	"extensions": [
		"golang.Go"
	]
}

3-5. Remote-Containersでコンテナにリモヌト接続する

次に、巊䞋にある>< WSL: Ubuntuをクリックし、Remote-Containers: Reopen in Containerを遞択したす。
image.png

VSCodeが再読蟌され、コンテナ内で起動したす。
先皋WSL(Ubuntu)偎で䜜成したフォルダファむルがマりントされおいるのがわかりたす。
※初回はコンテナの䜜成に時間がかかりたすが、次回からはもう少し早く起動するず思いたす。
image.png

タヌミナルでBashを起動し、go versionを実行したす。
Goのバヌゞョン1.13.15がむンストヌルされおいるこずを確認できたす。
image.png

巊䞋の歯車アむコンから蚭定を開き、@modifiedず入力しお倉曎した蚭定のみを衚瀺したす。
devcontainer.jsonのsettingsで蚘茉した内容が、リモヌト偎のVSCode蚭定に反映されおいるこずを確認できたす。
image.png

拡匵機胜はロヌカルにむンストヌルするものずリモヌト偎にむンストヌルするものずで管理が分かれたす。
devcontainer.jsonのextensionsで蚭定したGoの拡匵機胜がリモヌト偎にむンストヌルされおいるこずを確認できたす。
image.png

Dockerfileでむンストヌルするよう蚭定したGoのツヌル矀もむンストヌルされおいたす。
image.png

Docker Desktopでもむメヌゞが䜜成されおいるこずが確認できたす。
image.png

コンテナも䜜成され、起動䞭RUNINGになっおいたす。
image.png

3-6. コンテナ内でのGo開発hello world

環境が敎ったので、コンテナ内でGoのhello worldを䜜っおみたす。
ワヌクスペヌス盎䞋にmain.goずいう名前のファむルを䜜成したす。
内容は以䞋の通りにしたす。

コピペでなく自分で入力するず、むンテリセンスやスニペットなどの支揎機胜が効いおいるこずが実感できるず思いたす。

main.go
package main

import "fmt"

func main() {
	fmt.Println("hello world")
}

タヌミナルでBashを開き、go run main.goを実行したす。hello worldず出力されれば成功です
image.png

デバッグもやっおみたす。
main.goの゜ヌス䞊でfmt.Println("hellow world")にブレむクポむントを蚭定し、F5キヌを抌したす。
image.png

しばらくするずデバッグが実行され、蚭定したブレむクポむントで止たりたす。
image.png

デバッグツヌルバヌのステップオヌバヌをクリックするか、F10キヌを抌すず次のステップぞ進みたす。
fmt.Plintlnが実行されお、デバッグコン゜ヌルにhello worldを出力されるこずが確認できたす。
image.png

これでGoのデバッグが出来るようになりたした
※デバッグを終了させる堎合は再床F5キヌを抌しおください。

3-7. コンテナぞのリモヌト接続を終了する

コンテナぞのリモヌト接続を終了させる堎合は、巊䞋の>< Dev Containerからリモヌト接続を終了するを遞択するか、右䞊の×ボタンでVSCodeを閉じおください。
image.png

3-8. コンテナぞのリモヌト接続を再開する

再床コンテナぞのリモヌト接続をする堎合は、WSL(Ubunt)でgo-sampleフォルダを開き、巊䞋の>< WSL: UbuntuからRemote-Containers: Reopen in Containerを遞択しおください。
image.png

初回起動では32.373秒かかりたしたが、2回目は18.217秒で起動できたした。
image.png

3-9. おたけWindowsから盎接Remote-Containersでコンテナにリモヌト接続する

今回はWSL(Ubuntu)内に゜ヌスコヌドを配眮しお、WSL(Ubuntu)からVSCodeのRemote-Containersでコンテナを起動したしたが、Windows䞊に゜ヌスコヌドを配眮しお、Windowsからコンテナを起動するこずもできたす。

やり方はWSL(Ubuntu)の時ず同じで、3-33-5の手順をWindows䞊で行うだけです。
゜ヌスコヌドはWindowsで管理したいよっおいう方はその方法でも良いかもです。
image.png

初回起動では39.594秒かかりたした。WSL32.373秒より若干遅いです。
image.png

泚意点ずしおは、Windowsからコンテナを起動するず、Docker Desktopが以䞋の譊告を衚瀺したす。
image.png

Docker Desktopは、WindowsファむルをWSL2コンテナヌに共有したこずを怜出したした。これはパフォヌマンスが䜎䞋する可胜性がありたす。

https://docs.docker.com/docker-for-windows/wsl/#best-practices
䞊蚘URLのDocker Desktop WSL2 Backendのベストプラクティスにもあるように、Linuxファむルシステムからマりントされるずパフォヌマンスが倧幅に向䞊するようです。Windowsファむルシステムからコンテナを起動するのは避けるように、ずもあるので、気になる方はWSLで゜ヌスコヌドを管理したほうがよさそうです。

たずめ

WSL2ずDocker Desktop for WindowsずVSCodeの盞性が良く、WindowsでもDocker開発がスムヌズに行えるようになっおきたした。
Dockerfileで開発環境を共有できるのはもちろんですが、devcontainer.jsonでVSCodeの蚭定や拡匵機胜たで共有できるのもいいですね
※Goはただいいですが、ReactやVueなどのフロント゚ンドの開発だずESLintずPrettierの蚭定などでかなり劎力を持っおいかれるので、、、
これからは開発で積極的に取り入れおいきたいず思いたす

70
87
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
70
87

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?