Java | Spring Boot | 統合開発環境(IDE)を使用せずに構築する手順
Java
Spring Boot を統合開発環境(IDE)を使用せずに構築する手順
1. JDKのインストール
Spring Bootを実行するためには、Java Development Kit (JDK) が必要なため、
以下の手順でJDKをインストールする。
- Oracle JDK または OpenJDK をダウンロードしてインストールする。Amazon CorrettoでもOK。
- インストール後、環境変数 JAVA_HOME を設定し、PATH に bin ディレクトリを追加する。
# bashの場合(Linux/Mac)
export JAVA_HOME=/path/to/jdk
export PATH=$JAVA_HOME/bin:$PATH
# Windowsの場合は、環境変数の設定を行う。
2. Mavenのインストール
Spring Bootのプロジェクト管理にはMavenを使用する。
以下の手順でMavenをインストールする。
- Mavenのダウンロードページから最新のバージョンをダウンロード。
- 解凍後、環境変数 M2_HOME を設定し、PATH に bin ディレクトリを追加する。
# bashの場合(Linux/Mac)
export M2_HOME=/path/to/maven
export PATH=$M2_HOME/bin:$PATH
# Windowsの場合は、環境変数の設定を行う。
3. Spring Bootプロジェクトの作成
Spring Bootのプロジェクトを作成するために、"Spring Initializr"を使用する。
"Spring Initializr"はWebベースのツールで、プロジェクトの雛形を生成することができる。
- "Spring Initializr"にアクセスする。
- "Spring Initializr"にアクセスしたら、各項目を入力する。
<Project>
プロジェクトのビルドツールを選択する。
"Maven"を選択。
<Language>
プロジェクトで使用するプログラミング言語を選択する。
"Java"を選択。
<Spring Boot>
使用する"Spring Bootフレームワーク"のバージョンを選択。
一般的には最新の安定版を選択することが推奨されている。
<Project Metadata>
項目 | 内容 |
---|---|
Group | プロジェクトのグループIDを指定する。通常は、組織名やドメイン名を逆にした形式(例: com.example)を使用する。 |
Artifact | プロジェクトのアーティファクトIDを指定する。これはプロジェクトの名前に相当し、通常は小文字で書く。(例: myapp、demo など。プロジェクトの機能を反映したわかりやすい名前) |
Name | プロジェクトの表示名を指定します。通常、Artifactと同じ値を使用する。必要に応じて変更できる。(例: My Application、Demo Application など) |
Description | プロジェクトの簡単な説明を記述する。プロジェクトの目的や機能を簡潔に説明したものを記述する。 |
Package name | Javaのパッケージ名を指定します。通常は、GroupとArtifactを組み合わせた形式。(例: com.example.myapp など。自動的に生成されることが多いが、必要に応じて変更できる) |
Packaging | アプリケーションのパッケージ形式を指定する。: 一般的なSpring BootアプリケーションではJar形式が推奨される。特に組み込みWebサーバーを使う場合はJar形式が適している。既存のJava EEアプリケーションや外部のWebサーバー(Tomcatなど)にデプロイする場合はWar形式を選択する。 |
Java | 使用するJavaのバージョンを選択。Java 11やJava 17などのLTS(Long Term Support)バージョンを選択することが推奨される。 |
<Dependencies>
必要な依存関係を"Add Dependencies"ボタンから選択(例: Spring Web)
よく使用されるDependencies | 内容 |
---|---|
Spring Web | Webアプリケーションを作成する場合に選択 |
Spring Data JPA | データベースとのやり取りが必要な場合に追加 |
Spring Security | セキュリティ機能が必要な場合に追加 |
Thymeleaf | テンプレートエンジンが必要な場合に追加 |
- 入力したら、「Generate」ボタンをクリックして、プロジェクトをZIPファイルとしてダウンロードする。
- ZIPファイルを解凍する。
unzip archive_name.zip
- "Spring Initializr"で生成したプロジェクトには、デフォルトでTomcatが含まれている。
4. プロジェクトの構造
解凍したプロジェクトには、以下のような基本的な構造が含まれている。
my-spring-boot-app/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/
│ │ │ └── example/
│ │ │ └── myapp/
│ │ │ └── MySpringBootApplication.java
│ │ └── resources/
│ │ └── application.properties
│ └── test/
├── pom.xml
5. アプリケーションコードの作成
MySpringBootApplication.java というファイルに、以下のような基本的なSpring Bootアプリケーションのコードを記述する。
package com.example.myapp;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MySpringBootApplication {
public static void main(String[] args) {
SpringApplication.run(MySpringBootApplication.class, args);
}
}
6. 依存関係の管理
既に、pom.xml ファイルには必要な依存関係が自動的に追加されている。
必要に応じて、依存関係を追加・変更する。
7. コーディング
SpringBootフレームワークを使用したコーディングを行っていく。
8. アプリケーションのビルドと実行
コマンドラインでプロジェクトのルートディレクトリに移動し、Mavenを使用してアプリケーションをビルドする。
cd path/to/my-spring-boot-app
mvn clean package
ビルドが成功したら、次のコマンドでアプリケーションを実行する。
java -jar target/my-spring-boot-app-0.0.1-SNAPSHOT.jar
9. ブラウザでの確認
アプリケーションが正常に起動したら、ブラウザで http://localhost:8080
にアクセスして、アプリケーションが動作していることを確認する。
組み込みのWebサーバーが自動的に提供されるため、手動でWebサーバーを構築する必要はない。
"Spring Initializr"で生成したばかりのプロジェクトをそのまま起動した場合は、Whitelabel Error Page: デフォルトのエラーページが表示され、通常は「Whitelabel Error Page」というタイトルで、404エラーなどの情報が表示される。このページは、特定のエンドポイントが実装されていない場合に表示される。
9. application.propertiesファイル:ポート番号の変更など
必要に応じて、application.propertiesファイルでポート番号や他の設定を変更できる。
例えば、ポート番号を8081に変更する場合はapplication.propertiesファイルに、
server.port=8081
を記載すると、 http://localhost:8081
でアクセスできるようになる。
Discussion