VS Code(Visual Studio Code)を使ってSpring Frameworkの開発を行う方法

こんにちは。ゆうせいです。

VS Codeは軽量で拡張性が高く、Java開発に必要な機能をプラグインで追加することで、Springアプリケーションの開発に適した環境を構築できます。

以下に、VS CodeでSpring開発を行うための具体的な手順を解説します。


必要な準備

1. Javaのインストール

SpringはJavaベースのフレームワークなので、Java開発環境を用意する必要があります。

必須のツール:

  • JDK(Java Development Kit)
    最新のJDK(17以上)をインストールしてください。

確認方法:

ターミナルで以下のコマンドを実行し、インストールを確認します。

java -version

2. VS Codeのインストール

  • VS Codeは公式サイト(Visual Studio Code)からダウンロードしてインストールします。

3. VS Codeの拡張機能をインストール

VS CodeにJava開発やSpring開発用の拡張機能を追加します。

必須の拡張機能:

  • Java Extension Pack
    Java開発に必要なツール(コード補完、デバッグなど)が含まれています。 インストール手順:
    • VS Codeの拡張機能アイコン(サイドバーの四角いアイコン)をクリック
    • 検索バーに「Java Extension Pack」と入力
    • 拡張機能をインストール
  • Spring Boot Extension Pack
    Spring Bootの開発に特化したツールセットです。Spring Initializrやプロジェクト管理が簡単に行えます。

Springプロジェクトの作成

方法1: Spring Initializrを使う

Spring Initializrは、Springプロジェクトの雛形を生成する公式ツールです。

VS Codeでの手順:

  1. Spring Initializrを起動:
    • コマンドパレット(Ctrl+Shift+P)を開く。
    • Spring Initializr: Generate a Maven Project または Spring Initializr: Generate a Gradle Project を選択。
  2. プロジェクトの設定:
    • 必要な情報を入力(例: Group ID、Artifact ID、依存関係など)。
    • 依存関係として以下を追加するのがおすすめです:
      • Spring Web(REST APIを作成する場合)
      • Spring Data JPA(データベース操作)
      • Spring Boot DevTools(開発時のホットリロード)
  3. プロジェクトを作成:
    • プロジェクトが作成されると、自動的にフォルダが開かれます。

方法2: 手動でプロジェクトを設定

Spring Initializr以外にも、MavenまたはGradleを使って手動でプロジェクトを設定することも可能です。

  1. Mavenの場合:
    • ターミナルで以下のコマンドを実行してプロジェクトを作成: mvn archetype:generate -DgroupId=com.example -DartifactId=spring-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
  2. Gradleの場合:
    • build.gradle ファイルを作成し、Spring関連の依存関係を追加します。

開発環境の整備

1. 依存関係の管理

Springプロジェクトの pom.xml(Maven)または build.gradle(Gradle)に必要な依存関係を追加します。VS CodeのJava拡張機能が自動補完とエラー検知をサポートします。


2. コード補完とデバッグ

VS CodeのJava Extension Packは、以下のような機能を提供します:

  • クラスやメソッドの補完
  • 変数や依存関係のエラー検知
  • Springアプリケーションのデバッグ

デバッグを行うには、launch.json を設定する必要がありますが、VS CodeはJavaアプリケーションの自動デバッグ設定をサポートしているため簡単にセットアップできます。


3. ホットリロード

Spring Boot DevToolsを導入すれば、コード変更時にアプリケーションを再起動せずに反映することが可能です。開発速度が大幅に向上します。


アプリケーションの実行

  1. Spring Bootアプリケーションを実行: ターミナルで以下のコマンドを実行します: ./mvnw spring-boot:run # Mavenの場合 ./gradlew bootRun # Gradleの場合
  2. VS Codeのデバッグ機能を利用する:
    • Main メソッドを右クリックして「Start Debugging」を選択。
    • アプリケーションが起動し、デバッグ環境が整います。

補足

VS CodeでのSpring開発のメリット:

  • 軽量で高速。
  • 必要な機能をカスタマイズ可能。
  • GitやDocker、CI/CDツールとの統合がスムーズ。

注意点:

  • EclipseやIntelliJ IDEAに比べ、設定やプラグイン導入が必要な場合があります。
  • 大規模なプロジェクトでは、IDE(IntelliJなど)が推奨される場合もあります。

まとめ

VS Codeは、Spring Frameworkの開発を行うための強力なツールとして活用できます。特に、軽量で使いやすい環境を好むエンジニアには最適です。Spring InitializrやJava/Springの拡張機能を活用し、効率的に開発を進めていきましょう。

もし分からないことがあれば、いつでも質問してくださいね!

セイ・コンサルティング・グループの新人エンジニア研修のメニューへのリンク

投稿者プロフィール

山崎講師
山崎講師代表取締役
セイ・コンサルティング・グループ株式会社代表取締役。
岐阜県出身。
2000年創業、2004年会社設立。
IT企業向け人材育成研修歴業界歴20年以上。
すべての無駄を省いた費用対効果の高い「筋肉質」な研修を提供します!
この記事に間違い等ありましたらぜひお知らせください。