Zenn
🤖

VSCodeのDevContainersでSpringBoot環境を構築

2024/03/18に公開
Spring Boot
VS Code
tech

やりたいこと

  • ローカル環境を汚したくない
    • VisualStudioCode でワークスペースを作成し、その中でやりくりしたい
  • VisualStudioCode + DevContainers + Spring Boot の開発環境を構築する方法を残す

前提条件

以下のインストールが行われていること

※OS は Windows11 を使用

1. Visual Studio Code のワークスペースの作成

ワークスペースの作成方法は割愛しますが、以下の状態からスタート

2. 拡張機能に Spring Boot Extension Pack を追加

  1. 拡張機能マーケットプレース(Ctrl+Shift+X)で「Spring Boot Extension Pack」で検索し、インストール
    ※歯車から「devcontainer.json に追加する」を選択

  2. 「devcontainer.json に追加する」を選択するとダイアログが出るので「ファイルを追加」を選択

  3. 構成ファイルを決める
    「ワークスペースに構成を追加する」を選択

  4. 「すべての定義を表示...」を選択
    ※項目がない場合は次の「Java devcontainers」へ進んでよい

  5. Java devcontainers を選択

  6. Java バージョンは現在最新の「21-bullseye」を選択

  7. Gradle を使用予定なので「Install Gradle ～」

  8. インストールする追加機能は選択せずに「OK」

  9. 構成ファイル設定完了
    右下に「拡張機能が開発コンテナーの構成に追加されました。」と出れば完了
    devcontainer.json の中身に以下記載があることを確認

    • devcontainer.json の name に「Java」
    • extensions に「vmware.vscode-boot-dev-pack」

3. 開発コンテナ（DevContainer）に接続する

  1. 左下の緑の部分をクリックする

  2. 上部のメニューが開くので、「コンテナーで再度開く」を選択
    ※英語の場合は「Reopen in Container」

  3. 開発コンテナが読み込まれる

4. 開発用のコンテナー完成

4-1. エクスプローラ表示確認

左側のエクスプローラに「開発コンテナー：JAVA」と出てれば OK

4-2. コマンドパレットから Spring Initializr の呼び出し確認

Ctrl+Shift+P でコマンドパレットを開き、「spring init」で検索すると Spring Initializr が起動できるようになっている。

構築完了

DevContainers で SpringBoot を動かすための環境構築はここまでです。
動作確認で「Hello World!」を出力する手順は次の記事に書きました。
https://zenn.dev/sleepwalk/articles/b02ccc10b54c59

Discussion