🤑

VS CodeでSpring Bootプロジェクトの作成

2023/01/22に公開

タイトル通り、Spring BootのプロジェクトをVS Codeで作成してみた備忘録を記載します。Batchの場合も基本的に手順は同様のはず。

試した時のバージョンなど

項目 バージョン
VS Code 1.74.3
Spring Boot 2.79
Java 17
Windows 10

準備

ソフトウェアのインストール

VS Code、JavaのJDK等については事前にインストールが済んでいるものとします。
入れてない場合は、適当にこの辺↓から取得してインストールします。

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

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

Spring Bootプロジェクトの作成

VS Code上で、以下の手順を実施します。

  1. Ctrl + P を押してコマンドパレットを表示(以降、コマンドパレット上で作業を進めていくことになります。)

  2. >Spring Initializrと入力

  3. 表示された候補から「Create a (Maven | Gradle) Project」を選択(本記事ではGradle Projectを選択)

  4. 2.79を選択(これもお好みで)

  5. Javaを選択

  6. Group IDを入力(パッケージ名の一部になる)

  7. Artifact IDを入力(これもパッケージ名の一部になる)

  8. Jarを選択

  9. 17を選択

  10. 利用したいライブラリを選択して、Enter

今回は以下のライブラリをインストールします。

  • Spring Boot DevTools
  • Lombok
  • JDBC API
  • Spring Data JDBC
  • H2 Database
  • Thymeleaf
  • Spring Web
  • Spring Batch

(今回はライブラリを入れる必要は無いのですが、書籍などのハンズオンなどを進める際には、概ねこのあたりのライブラリを入れることが多いと思うので、備忘録の意味合いで記載。)

Enterを押すとエクスプローラが開くので、プロジェクトの作成先ディレクトリを選択して「Generate to this folder」

プロジェクトを開く

作成したフォルダをVS Codeで開き、VS Code上のExplorerで、以下のファイルを探して開きます。

src/main/java/com/example/demo/DemoApplication.java
  1. 右上の▷ボタンを押してRun

  2. ブラウザを開いて、http://localhost:8080 へアクセス

  3. こんなページが表示されるはず

コントローラ等を何も作成していないのでエラーページが表示されますが、ここからVS Codeを使ってSpring Boot、あるいはBatch等の開発を進められるはずです。

また、上記の作業を行うだけでGo to Definition(F12)を使った参照先のライブラリのクラスを閲覧、Source Actionでメソッドのテンプレートを自動生成、デバッグ実行、なども行えるようになりました。私はEclipseからの移行組なのですが、現状特に困らずVS Codeでの開発を進められています。

参考サイト

https://spring.pleiades.io/guides/gs/guides-with-vscode/

Discussion