Kotlin

VSCodeにてKotlinで利用するSpring Boot導入

・VSCodeでのSpring Boot(Kotlin)導入
・Spring Initializerからプロジェクト作成

KotlinはJavaとの互換性があるためSpring Bootも利用可能です。
今回はVSCodeで使えるSpring Boot(Kotlin)の構築方法を紹介します。

Kotlinのインストール方法やVSCodeでKotlinのビルドやデバッグ方法は下記を参考にください。

VSCodeでKotlinの開発環境構築(Mac) ・VSCodeでKotlinの開発環境構築・Hello Worldの出力、デバッグ方法の説明 VSCodeのインストール方法は省...

拡張機能インストール

VSCodeの拡張機能から下記2つをインストールします。

  • Java Extension Pack
  • Spring Boot Extension Pack

Spring InitializerでGradleプロジェクト作成

VSCodeのコマンドパレットから「Spring Initializer」と入力してGradleプロジェクトを作成します。

「Spring Initializer: Generate a Gradle Project」を選択するといくつか入力を求められるので任意の値を入力、選択します。

パッケージ名・プロジェクト名はデフォルトの入力で問題ありません。
Spring BootのバージョンやKotlin・Javaのバージョンは一番上に表示されている値を選択して問題ありません。

依存関係は下記2つを入力、選択します。

  • Spring Web
  • Thymeleaf

依存関係まで完了するとプロジェクトの格納場所を聞かれるので任意の場所を選択してプロジェクトを作成します。

ビルド・デバッグ設定

VSCodeでKotlin(Gradle)をビルド、デバッグの設定となります。
下記をベースに、run部分をbootRunコマンドで設定します。

VSCodeでKotlinの開発環境構築(Mac) ・VSCodeでKotlinの開発環境構築・Hello Worldの出力、デバッグ方法の説明 VSCodeのインストール方法は省...

.vscode>tasks.json作成

下記コマンドを実行して「.vscode」ディレクトリに「tasks.json」を作成します。

vi .vscode/tasks.json

作成したtasks.jsonに下記を貼り付けてください。
太字箇所が上記で紹介した内容と相違がある箇所です。

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "build",
            "type": "shell",
            "command": "./gradlew build -x test",
            "problemMatcher": [],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        },
        {
            "label": "run",
            "type": "shell",
            "command": "./gradlew bootRun"
        },
        {
            "label": "test",
            "type": "shell",
            "command": "./gradlew test"
        }
    ]
}

Spring Boot実行

ターミナル>タスクの実行からbuild、runを実行します。

画像に alt 属性が指定されていません。ファイル名: image-1.png

正常でしたらrun実行時に下記のように「Spring」が表示されます。

runでエラーが発生した場合

runでエラーが発生した場合、利用しているJavaのバージョンが合っていない場合があります。

その場合は「javac -version」 コマンドで表示されたバージョンに合わせて、「build.gradle.kts」ファイルの「jvmTarget」を変更してください。

下図は元々「jvmTarget = “11”」となっていましたが、私のローカル環境だとJDK1.8だったため「jvmTarget = “1.8”」に変更しました。

最後に

以上で、VSCodeでSpring Boot(Kotlin)の導入が完了しました。

Spring Bootは拡張機能のインストールを行うだけですが付随する、Kotlin、Java、Gradleのインストールも必要です。
初回動作は苦労しますがそれさえ済めば2回目以降はスムーズかと考えています。

やはりIntelliJ IDEAを使うことをオススメします。

なおVSCodeには、Remote Developmentという素晴らしい拡張機能もあります。
別の記事で上記拡張機能を利用してKotlin開発環境を構築している記事もありますのでご参照ください。

Visual Studio Code Remote Development でKotlin環境を構築 ・Visual Studio Code Remote DevelopmentでKotlinの開発環境を構築 Visual Stu...