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

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

VS Code
スポンサーリンク

はじめに

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

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

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

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

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

環境

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

2022/04/20 WindowsとMacを使い、最新バージョンで確認しました。

リモート開発のメリット

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上から拡張機能を検索し、「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コンテナを利用しますので、「Remote – Containers」拡張機能のみインストールしました。

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

スポンサーリンク

Dockerの用意

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

Windows
Mac

Java環境の用意

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

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

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

Remote-Containers: Try

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

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

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

Javaのプラグインをお勧めされましたので、インストールしました。

このリポジトリには、’Extension Pack for Java’ 拡張機能をお勧めします。インストールしますか?

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

スポンサーリンク

Javaの実行

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

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

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

Javaのバージョンを確認してみましょう。
OpenJDKの11.0.14.1でした。

vscode ➜ /workspaces/vscode-remote-try-java (main ✗) $ java -version
openjdk version "11.0.14.1" 2022-02-08 LTS
OpenJDK Runtime Environment Microsoft-31205 (build 11.0.14.1+1-LTS)
OpenJDK 64-Bit Server VM Microsoft-31205 (build 11.0.14.1+1-LTS, mixed mode)

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

src/main/java/com/mycompany/app/App.java

/*----------------------------------------------------------------------------------------
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE in the project root for license information.
 *---------------------------------------------------------------------------------------*/

package com.mycompany.app;

public class App 
{
    public static void main( String[] args )
    {
        System.out.println( "Hello Remote World!" );
    }
}

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

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

個人的にJavaの開発は、EclipseかIntelliJ IDEAを使ってきましたので、違和感はあるものの、手軽に環境を構築してコーディングできるのは便利だと思いました。

テストの実行

以下のファイルを開きます。

src/test/java/com/mycompany/app/AppTest.java

package com.mycompany.app;

import org.junit.Test;
import static org.junit.Assert.*;


public class AppTest
{
    public AppTest() {
    }

    @Test
    public void testApp()
    {
        assertTrue( true );
    }

    @Test
    public void testMore()
    {
        assertTrue( true );
    }
}

テストにブレークポイントを設定しました。

右上のDebugボタンをクリックし、JUnitを起動します。

テストの実行でもブレークポイントに止まることが確認できました。

試しにテストの失敗を試してみましょう。
テストの失敗箇所が表示されました、便利ですね!

コンテナの環境について

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

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

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

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

さいごに

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

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

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

\オススメ/

コメント

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