Spring BootをVS Codeで始める方法(簡単セットアップ)
新人
「Spring Bootを使ってWebアプリを作りたいんですが、何から始めたらいいですか?」
先輩
「まずは開発環境を整えるところから始めましょう。今回は、Spring BootをVS CodeとPleiadesで簡単にセットアップする方法を紹介するよ。」
新人
「なるほど!PleiadesやGradleとかよく聞くけど、実際にどう使うのか分かっていません。」
先輩
「よし、それなら一緒にVS CodeでSpring Bootを始める手順をわかりやすく見ていこう!」
1. Spring Bootとは?
Spring Boot(スプリングブート)は、JavaでWebアプリケーションを簡単に作れるようにしたフレームワークです。Javaの標準的な開発では、設定ファイルをたくさん書いたり複雑な準備が必要ですが、Spring Bootならその面倒な部分を自動で行ってくれるため、すぐに開発を始めることができます。
「フレームワーク」とは、アプリを作るための土台のようなもので、よく使う機能や仕組みがあらかじめ用意されています。Spring Bootには、Web機能、データベース接続、セキュリティなど、よく使う機能が最初から組み込まれています。
初心者がJavaでWeb開発を始めるには、Spring Bootがとてもおすすめです。
2. なぜSpring Bootを使うのか?
JavaでWebアプリを作るには、通常たくさんの設定やライブラリの追加が必要です。しかし、Spring Bootを使えば、最初から必要な部品がそろっていて、すぐにWebアプリを作ることができます。
特に、以下のような理由でSpring Bootは人気です。
- 面倒な設定がほとんど不要
- すぐに動かせるWebアプリが作れる
- 組み込みのサーバ(Tomcat)で実行できる
- GradleやMavenでライブラリの管理が簡単にできる
また、Spring Bootを使うと、最初の画面表示までの流れがとてもスムーズです。「Hello画面」を出すだけでも、複雑なコードは不要で、少ないステップで実現できます。
3. 今回使用する開発環境について
この記事では、Spring Bootを使った簡単なWebアプリ開発を、以下の開発環境で行います。
- Pleiades(プレアデス): 日本語化されたEclipseベースの統合開発環境
- Gradle: ライブラリを自動で管理してくれるビルドツール
- VS Code: 軽量で使いやすいコードエディタ(主に表示・編集用として併用)
プロジェクトはPleiadesで作成します。PleiadesにはSpring Boot用のテンプレートがあるので、チェックを入れるだけで、必要な依存関係(ライブラリ)が自動で設定されます。
Gradleは、Pleiades内でプロジェクト作成時に選択することで、自動で設定されます。Spring Bootの実行もPleiadesから行えるので、初心者でも安心です。
この記事では、Spring BootプロジェクトをPleiadesで作成し、@Controllerを使った基本的な画面表示を行う準備までを解説します。VS Codeも併用して、コードの編集や確認ができます。
4. VS Codeに必要な設定(Java拡張パック、Pleiadesとの連携)
Spring Bootのコードを快適に書くためには、VS Code(Visual Studio Code)の環境を整えておくことが大切です。ここでは、VS Codeに必要な設定と、Pleiadesで作成したプロジェクトをVS Codeで編集できるようにする手順を説明します。
まず、VS CodeにはJava用の拡張機能が必要です。以下の手順でインストールしましょう。
- VS Codeを起動
- 左のメニューから「拡張機能(四つの四角マーク)」をクリック
- 検索欄に「Java Extension Pack」と入力
- 表示された拡張機能パックをインストール
「Java Extension Pack」には、Javaのコード補完、構文チェック、デバッグなどに必要なツールがすべて入っています。Spring Bootの開発にも対応しており、Gradleプロジェクトもサポートされています。
次に、Pleiadesで作成したSpring BootプロジェクトをVS Codeで開く方法を紹介します。手順は以下の通りです。
- Pleiadesでプロジェクトを作成して保存
- エクスプローラーなどでプロジェクトのフォルダを開く
- フォルダをVS Codeにドラッグ&ドロップする
これでVS Code上でもSpring Bootのコードが確認・編集できるようになります。
5. Spring Bootの新規プロジェクト作成手順(Pleiadesを使って)
Spring Bootプロジェクトの作成は、Pleiadesを使うととても簡単です。Mavenではなく、今回はGradle構成で作成する手順を紹介します。
以下の手順で新しいSpring Bootプロジェクトを作成します。
- Pleiadesを起動します。
- メニューの「ファイル」→「新規」→「Spring スターター・プロジェクト」を選択します。
- プロジェクト名やパッケージ名を入力します。
- 「ビルドツールの選択」で「Gradle」を選びます(※Mavenは使いません)。
- 「依存関係の追加」で「Spring Web」にチェックを入れます。
- 「完了」を押すと、プロジェクトが自動生成されます。
プロジェクトが作成されると、必要なファイルやフォルダが揃った状態になります。Gradleの構成ファイルやSpring Bootのメインクラス(Application.java)も自動で作られています。
6. Gradle構成でSpring Bootを動かす方法(MavenではなくGradle)
Spring BootプロジェクトをGradle構成で動かすには、Pleiadesの機能を使えばとても簡単です。Gradleはビルドツールと呼ばれ、必要なライブラリの管理やアプリの実行を手助けしてくれます。
まず、プロジェクトの構成を確認しましょう。Pleiadesで作成したGradleプロジェクトには、以下のような構成になっています。
- build.gradle:ビルドや依存関係の設定ファイル
- settings.gradle:プロジェクト名などの設定
- src/main/java:Javaのソースコードを置く場所
- src/main/resources:テンプレートや設定ファイルなどを置く場所
Spring Bootアプリケーションを動かすには、以下の手順で実行できます。
- プロジェクトを右クリック
- 「実行」→「Spring Boot アプリケーションの実行」を選択
これでアプリケーションが起動します。初めて実行するときはGradleがライブラリをダウンロードするため、少し時間がかかる場合があります。
Spring Bootのアプリケーションが正しく起動すると、コンソールに以下のようなメッセージが表示されます。
Tomcat started on port(s): 8080 (http)
Started Application in 5.123 seconds
この状態でWebブラウザを開き、次のURLにアクセスしてみましょう。
http://localhost:8080/
まだ画面は表示されないかもしれませんが、アプリケーション自体は正常に起動しています。次のステップでは、@Controllerを使って「Hello画面」などを表示する方法を解説していきます。
Spring BootをGradleで動かすことで、依存関係の管理がとても楽になります。また、Mavenに比べて記述が簡潔なのもメリットです。初心者でもGradleの基本を理解しやすく、Spring Bootの開発に集中できます。
7. コントローラクラスの作成とHello画面表示(@Controller使用)
ここからは、Spring Bootで実際に画面を表示するために、@Controllerを使ったコントローラクラスを作成します。@RestControllerではなく@Controllerを使って、HTMLテンプレートと連携した表示方法を学びます。
まず、プロジェクト内のパッケージ(例:com.example.demo)に、新しいJavaクラスを作成します。
package com.example.demo;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HelloController {
@GetMapping("/")
public String hello(Model model) {
model.addAttribute("message", "こんにちは、Spring Boot!");
return "hello";
}
}
このHelloControllerでは、ルートURL(/)にアクセスが来たときに、hello.htmlというテンプレートを表示します。model.addAttributeで画面に表示する文字列(「こんにちは、Spring Boot!」)を設定しています。
次に、src/main/resources/templatesフォルダを作成し、その中にhello.htmlを以下のように作ります。
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>Hello</title>
</head>
<body>
<h1 th:text="${message}">メッセージ</h1>
</body>
</html>
このHTMLは、テンプレートエンジンThymeleaf(Spring Bootが標準で使う)を使って、${message}の部分にコントローラで設定した文字列を表示します。
8. アプリケーションの起動と動作確認
それでは、作成したコントローラとテンプレートを使って、Spring Bootアプリケーションを起動し、Hello画面を確認しましょう。
- Pleiades上でメインクラス(
Application.java)を右クリックして「実行」→「Spring Boot アプリケーションの実行」を選択します。 - コンソールに「Tomcat started on port(s): 8080」などの表示が出たら、起動成功です。
ブラウザで以下のURLを開いてください:
http://localhost:8080/
「こんにちは、Spring Boot!」と表示されていれば成功です。
VS Codeでhello.htmlを編集すれば、すぐに画面表示が変わるので、Hot Reloadのような感覚で画面確認ができます。
9. よくあるエラーと解決法(実行できない・ビルドエラーなど)
Spring BootやVS Codeで初心者がつまずきやすいエラーと、その対策を紹介します。事前に知っておくことで、開発中にあわてずに済みます。
● テンプレートファイルが見つからないエラー
エラー例:
Template “hello” could not be resolved
原因と対策:
- ファイル名やフォルダ構成が間違っていないか確認:
src/main/resources/templates/hello.html @Controllerとテンプレート名が一致しているか確認
● ビルドや依存関係エラー
エラー例:
Could not find method compileJava() for arguments...
原因と対策:
- Gradleのバージョンや構成ファイル(
build.gradle)が正しいか確認 - Pleiadesでプロジェクト作成時に「Spring Web」にチェックが入っているか再確認
- VS Codeで「Java Extension Pack」を再起動して認識し直す
● ポート重複エラー
エラー例:
Tomcat failed to start. Port 8080 was already in use.
原因と対策:
- 他のアプリがポート8080を使っている可能性あり
application.propertiesにてポート番号を変更:server.port=8081などに設定
● HTMLが表示されずソースがそのまま出る
原因と対策:
- Thymeleafの依存関係が正しく設定されているか(Pleiadesの「Spring Web」チェックで含まれている)
- テンプレートエンジン用のファイル名・場所が正しいか再確認
これらのエラーは、設定ミスや構成ミスが原因のことが多いです。エラーメッセージをよく読んで、焦らずに対策すれば解決できますので、安心して進めてください。