自分だけのクイズ作成 - Quipha公開中

【VS Code】Rust環境のリモート開発・デバッグ

VS Code
スポンサーリンク

はじめに

みなさんプログラミングの際にVS Codeを使っていますでしょうか。
私はよく使っています!

とても軽量ですし、必要最低限の機能はもちろん、ソースの管理や、デバッグ、強力な拡張機能など、非常に気に入っております。

今回はVS CodeでDockerを使ったリモート開発を試してみました。
驚くほど簡単に使うことができます。

Dockerを使いRust環境を用意し、VS Codeでリモートデバッグを行います。

他にも私のブログで、VS Codeについて解説している記事がありますのでご覧ください。

環境

今回試した環境
  • Windows 11 / 10
  • macOS Monterey (M1)
  • Visual Studio Code
  • Docker

2022/10/01 Windowsを使い、最新バージョンで確認しました。

リモート開発のメリット

VS Codeの起動はローカルPC、実行環境はリモート先と分けることにより、ローカルPCの環境を汚すことがありません
コンテナ上に環境を用意すれば、ローカルPCに色々と開発に必要なライブラリなどをインストールする必要がないためです。

Dockerコンテナは、不要になれば破棄することもできますし、様々なプロジェクトの開発環境が必要な場合、各コンテナごとに環境を用意できますので便利です。

今回はDockerコンテナを利用してリモート開発を行いますが、複数人で開発する際に、同じ開発環境を用意することができます。

他にも、SSHでのリモート開発もサポートしておりますので、Linuxでしか動かないアプリの開発や、クラウド環境にリモート接続し、ローカルPCのVS Codeで編集といったこともできます。

VS Codeインストール

VS Codeのインストール方法は、以下の記事にまとめましたのでご覧ください。

VS Codeのオススメ設定や拡張機能などは、以下の記事にまとめました。

起動と拡張機能のインストール

VS Codeを起動しましょう。
何も拡張機能が入っていない状態ですが、日本語パックだけはインストールしました。

以下の拡張機能をインストールします。

Remote - Containers - Visual Studio Marketplace
Extension for Visual Studio Code - Open any folder or repository inside a Docker container and take advantage of Visual Studio Code's full feature set.

VS Code上から拡張機能を検索し、「Dev Containers」をインストールします。

画像に alt 属性が指定されていません。ファイル名: 2022-10-01_22h36_11-1024x210.png

ちなみに以前は、「Remote-Containers」という名称でした。

別な拡張機能で、「Remote Development」というのもあります。

Remote Development - Visual Studio Marketplace
Extension for Visual Studio Code - An extension pack that lets you open any folder in a container, on a remote machine, or in WSL and take advantage of VS Code'...

こちらは、「Remote – SSH」「Remote – Containers」「Remote – WSL」の3つの拡張機能を含んでいるようです。

今回は、リモート先にDockerコンテナを利用しますので、「Dev Containers」拡張機能のみインストールしました。

インストールした拡張機能は、以下の2つだけです。
開発に必要なものはリモート先にインストールしますので、ローカルPCのVS Codeはこれだけにしました。

スポンサーリンク

Dockerの用意

Macの場合はDockerのみですが、Windowsの場合はDocker(WSL2がバックエンド)が必要です。
Dockerのインストール方法は、以下の記事をご覧ください。

Windows
Mac

Rust言語とは

Stack Overflowで「最も愛されているプログラミング言語」で一位を獲得した言語です。

FirefoxもRustを採用しているようです。

既に、世界中の数百という企業がRustを採用し、高速で低リソースのクロスプラットフォームソリューションを実現しています。皆さんがご存じで愛用しているソフトウェア、例えばFirefox、DropboxやCloudflareも、Rustを採用しています。

https://www.rust-lang.org/ja

Rustはガベージコレクションがなく、高速でメモリ効率が高いです。
また、所有権モデルによりメモリ安全性とスレッド安全性が保証され信頼性が高く、各種ツールが揃っており生産性が高いのが特徴です。

Rust環境の用意

コンテナ上にRustの環境を用意してみましょう。
今回は、以下のサンプルプロジェクトを利用して試してみます。

GitHub - microsoft/vscode-remote-try-rust: Rust sample project for trying out the VS Code Remote - Containers extension
Rust sample project for trying out the VS Code Remote - Containers extension - GitHub - microsoft/vscode-remote-try-rust: Rust sample project for trying out the...

サンプルプロジェクトはコマンドで開くことができます。
VS Code上でF1をクリックし、以下を入力しましょう。

Remote-Containers: Try

「Remote-Containers: Try a Development Container Sample…」を選択します。

Rustを選択し、サンプルプロジェクトを構築します。

サンプルプロジェクトを開くことができました。
この時点でコンテナは作成され、コンテナ上にソースコードがあります。

ソースはDockerのボリュームに存在します。ですので、コンテナが破棄されてもソースは残ります。
Docker Desktop上でも確認できます。

スポンサーリンク

Rustの実行

VS Codeのターミナルを開き、コンテナ上でコマンドを確認してみましょう。

試しにunameと打ってみましょう。
Linuxと表示され、コンテナ内であることが確認できました。

vscode ➜ /workspaces/vscode-remote-try-rust (main) $ uname
Linux

Rustの各種バージョンを確認してみましょう。

vscode ➜ /workspaces/vscode-remote-try-rust (main) $ cargo --version
cargo 1.56.0 (4ed5d137b 2021-10-04)

vscode ➜ /workspaces/vscode-remote-try-rust (main) $ rustc --version
rustc 1.56.1 (59eed8a2a 2021-11-01)

vscode ➜ /workspaces/vscode-remote-try-rust (main) $ rustdoc --version
rustdoc 1.56.1 (59eed8a2a 2021-11-01)

CargoはRustのビルドシステム・パッケージマネージャで、rustcはコンパイラです。

サンプルソースを見てみましょう。以下のファイルを開きます。

src/main.rs

/*--------------------------------------------------------------------------------------------------------------
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 *-------------------------------------------------------------------------------------------------------------*/

fn main() {
    let name = "VS Code Remote - Containers";
    println!("Hello, {}!", name);
}

Rustを実行してデバッグを確認します。
ソースコードにブレークポイントを設定します。

F5を押し、ブレークポイントが止まることを確認できます。

実行結果も確認できました。

Hello, VS Code Remote - Containers!

コンテナの環境について

今回はサンプルプロジェクトをダウンロードし、簡単に試してみました。
環境については、プロジェクト直下の「.devcontainer」フォルダに格納されています。

devcontainer.jsonにはリモート先のVS Codeの拡張機能や設定、Dockerfileにはコンテナの定義が記載されています。
このファイルを元にして、Rust環境をカスタマイズするのも良いでしょう。

Dockerファイルを修正したら、左下の緑のボタンをクリックし、「Rebuild Container」でコンテナの再作成ができます。

Dockerfileを修正し、コンテナの環境をカスタマイズ→コンテナ作成が、VS Code上で完結し、非常に便利です。他の人との開発環境の共有にも便利ですね。

devcontainer.jsonの中身を見てみましょう。
コンテナ側のVSCodeにインストールされる拡張機能が定義されています。

{
..
	// Add the IDs of extensions you want installed when the container is created.
	"extensions": [
		"vadimcn.vscode-lldb",
		"mutantdino.resourcemonitor",
		"matklad.rust-analyzer",
		"tamasfe.even-better-toml",
		"serayuzgur.crates"
	],
..
}

上記の拡張機能が一式インストールされていることが分かります。

さいごに

VS Codeのリモート開発は素晴らしいですね!
ローカルPCの環境を汚さず、コンテナで開発環境を作成することができます。
手順も面倒ではないので、ぜひ活用しましょう。

さらに詳しくリモート開発を知りたい場合は、以下の記事もご覧ください。

他にも私のブログで、VS Codeについて解説している記事がありますのでご覧ください。

\オススメ/

コメント

タイトルとURLをコピーしました