Spring Boot、または一般的に「Spring」を始めようとしている場合は、この入門セクションを参照してください。基本的な「何？」、「どのように？」、「なぜ？」といった質問に回答します。Spring Bootの紹介とインストール手順が含まれています。次に、入門用に最初のSpring Bootアプリケーションの構築を順を追って、いくつかの主要な原則について説明します。
1. Spring Bootの紹介
Spring Bootを使用すると、実行可能なスタンドアロンの本番グレードのSpringベースアプリケーションを簡単に作成できます。Springフレームワークプラットフォームとサードパーティライブラリを私たち独自の見解で捉えることにより、最小限の手間で開始できるようにします。多くのSpring Bootアプリケーションは、Spring構成をほとんど必要としません。
Spring Bootを使用して、java -jar または従来のwar デプロイを使用して起動できるJavaアプリケーションを作成できます。「Springスクリプト」を実行するコマンドラインツールも提供しています。
主なゴールは次のとおりです。
すべてのSpring開発に、非常に高速で広くアクセス可能な入門体験を提供します。
すぐに使用できますが、要件がデフォルトと異なる場合でもすぐに対応できます。
大規模なクラスのプロジェクトに共通のさまざまな非機能機能（組み込みサーバー、セキュリティ、メトリック、ヘルスチェック、外部化された構成など）を提供します。
コード生成やXML構成は一切不要です。
2. システム要件
Spring Boot 2.2.4.RELEASEにはJava 8(英語) が必要で、Java 13（付属）まで互換性があります。Spring Framework 5.2.3.RELEASE以上も必要です。
次のビルドツールに対して明示的なビルドサポートが提供されます。
| ビルドツール | バージョン |
|---|---|
Maven | 3.3+ |
Gradle | 5.xおよび6.x (4.10 サポートされていますが、非推奨の形式です) |
3. Spring Bootのインストール
Spring Bootは、「古典的な」Java開発ツールで使用するか、コマンドラインツールとしてインストールできます。いずれにしても、Java SDK v1.8(英語) 以上が必要です。開始する前に、次のコマンドを使用して現在のJavaインストールを確認する必要があります。
$ java -version
Java開発を初めて使用する場合、またはSpring Bootを実験する場合は、最初にSpring Boot CLI（コマンドラインインターフェース）を試してください。それ以外の場合は、「クラシック」インストール手順を参照してください。
3.1. Java開発者向けのインストール手順
Spring Bootは、標準のJavaライブラリと同じ方法で使用できます。そのためには、クラスパスに適切な spring-boot-*.jar ファイルを含めます。Spring Bootは特別なツールの統合を必要としないため、任意のIDEまたはテキストエディターを使用できます。また、Spring Bootアプリケーションには特別なものはないため、他のJavaプログラムと同様にSpring Bootアプリケーションを実行およびデバッグできます。
Spring Boot jarをコピーできますが、一般的に、依存関係管理をサポートするビルドツール（MavenやGradleなど）を使用することをお勧めします。
3.1.1. Mavenのインストール
Spring Bootは、Apache Maven 3.3以上と互換性があります。Mavenがまだインストールされていない場合は、maven.apache.org(英語) の指示に従ってください。
多くのオペレーティングシステムでは、Mavenはパッケージマネージャーを使用してインストールできます。OSX Homebrewを使用する場合は、brew install mavenを試してください。Ubuntuユーザーは sudo apt-get install mavenを実行できます。Chocolatey(英語) を使用するWindowsユーザーは、昇格した（管理者）プロンプトから choco install maven を実行できます。 |
Spring Boot依存関係は org.springframework.boot groupIdを使用します。通常、Maven POMファイルは spring-boot-starter-parent プロジェクトから継承し、1つ以上の“スターター”への依存関係を宣言します。Spring Bootは、実行可能なjarを作成するためのオプションのMavenプラグインも提供します。
次のリストは、典型的な pom.xml ファイルを示しています。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1-SNAPSHOT</version>
<!-- Inherit defaults from Spring Boot -->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
</parent>
<!-- Override inherited settings -->
<description/>
<developers>
<developer/>
</developers>
<licenses>
<license/>
</licenses>
<scm>
<url/>
</scm>
<url/>
<!-- Add typical dependencies for a web application -->
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<!-- Package as an executable jar -->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project> spring-boot-starter-parent はSpring Bootを使用する優れた方法ですが、常に適しているとは限りません。別の親POMから継承する必要がある場合や、デフォルト設定が気に入らない場合があります。これらの場合、import スコープを使用する代替ソリューションについては、using-spring-boot.htmlを参照してください。 |
3.1.2. Gradleのインストール
Spring Bootは5.xおよび6.xと互換性があります。4.10もサポートされていますが、このサポートは非推奨であり、将来のリリースで削除される予定です。Gradleがまだインストールされていない場合は、gradle.org(英語) の指示に従ってください。
Spring Boot依存関係は、org.springframework.boot groupを使用して宣言できます。通常、プロジェクトは1つ以上の“スターター”への依存関係を宣言します。Spring Bootは、依存関係の宣言を単純化し、実行可能jarを作成するために使用できる便利なGradle プラグインを提供します。
Spring BootとGradleの使用開始の詳細については、Gradleプラグインのリファレンスガイドのはじめにセクションを参照してください。
3.2. Spring Boot CLIのインストール
Spring Boot CLI（コマンドラインインターフェース）は、Springを使用して迅速にプロトタイプを作成するために使用できるコマンドラインツールです。これにより、Groovy(英語) スクリプトを実行できます。つまり、定型コードをあまり使用せずに、使い慣れたJavaのような構文を使用できます。
Spring Bootを操作するためにCLIを使用する必要はありませんが、Springアプリケーションを開発する最も確実な方法は間違いありません。
3.2.1. 手動インストール
Spring CLIディストリビューションは、Springソフトウェアリポジトリからダウンロードできます。
最先端のスナップショット配布(英語) も利用可能です。
ダウンロードしたら、解凍したアーカイブのINSTALL.txt(英語) の指示に従ってください。要約すると、.zip ファイルの bin/ ディレクトリには、spring スクリプト（Windowsの場合はspring.bat ）があります。または、.jar ファイルで java -jar を使用できます（スクリプトは、クラスパスが正しく設定されていることを確認できます）。
3.2.2. SDKMAN!を使用したインストール
SDKMAN!（Software Development Kit Manager）は、GroovyやSpring Boot CLIなど、さまざまなバイナリSDKの複数のバージョンを管理するために使用できます。sdkman.io(英語) からSDKMAN!を取得し、次のコマンドを使用してSpring Bootをインストールします。
$ sdk install springboot $ spring --version Spring Boot v2.2.4.RELEASE
CLIの機能を開発し、作成したバージョンに簡単にアクセスしたい場合は、次のコマンドを使用します。
$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.2.4.RELEASE-bin/spring-2.2.4.RELEASE/ $ sdk default springboot dev $ spring --version Spring CLI v2.2.4.RELEASE
上記の手順では、dev インスタンスと呼ばれる spring のローカルインスタンスをインストールします。ターゲットビルドの場所を指すため、Spring Bootを再構築するたびに、spring は最新の状態になります。
次のコマンドを実行して確認できます。
$ sdk ls springboot ================================================================================ Available Springboot Versions ================================================================================ > + dev * 2.2.4.RELEASE ================================================================================ + - local version * - installed > - currently in use ================================================================================
3.2.3. OSX Homebrewのインストール
MacでHomebrew(英語) を使用している場合、次のコマンドを使用してSpring Boot CLIをインストールできます。
$ brew tap pivotal/tap $ brew install springboot
Homebrewは、spring から /usr/local/binをインストールします。
formulaが表示されない場合、brewのインストールが古くなっている可能性があります。その場合は、brew update を実行して再試行してください。 |
3.2.4. MacPortsのインストール
MacでMacPorts(英語) を使用している場合、次のコマンドを使用してSpring Boot CLIをインストールできます。
$ sudo port install spring-boot-cli
3.2.5. コマンドライン補完
Spring Boot CLIには、BASH(英語) およびzsh(英語) シェルのコマンド補完を提供するスクリプトが含まれています。任意のシェルでスクリプト（ springとも呼ばれる）を source するか、個人またはシステム全体のbash完了初期化に配置できます。Debianシステムでは、システム全体のスクリプトは /shell-completion/bash にあり、そのディレクトリ内のすべてのスクリプトは、新しいシェルの起動時に実行されます。例：SDKMAN!を使用してインストールした場合にスクリプトを手動で実行するには、次のコマンドを使用します。
$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring $ spring <HIT TAB HERE> grab help jar run test version
| HomebrewまたはMacPortsを使用してSpring Boot CLIをインストールすると、コマンドライン補完スクリプトがシェルに自動的に登録されます。 |
3.2.6. Windows Scoopのインストール
WindowsでScoop(英語) を使用している場合、次のコマンドを使用してSpring Boot CLIをインストールできます。
> scoop bucket add extras > scoop install springboot
Scoopは、spring から ~/scoop/apps/springboot/current/binをインストールします。
アプリのマニフェストが表示されない場合、スクープのインストールが古くなっている可能性があります。その場合は、scoop update を実行して再試行してください。 |
3.2.7. クイックスタートSpring CLIの例
次のWebアプリケーションを使用して、インストールをテストできます。開始するには、次のように app.groovyというファイルを作成します。
@RestController
class ThisWillActuallyRun {
@RequestMapping("/")
String home() {
"Hello World!"
}
}次に、次のようにシェルから実行します。
$ spring run app.groovy
| 依存関係がダウンロードされるため、アプリケーションの最初の実行は遅くなります。後続の実行ははるかに高速です。 |
お気に入りのWebブラウザーで localhost:8080 を開きます。次の出力が表示されます。
Hello World!
3.3. Spring Bootの以前のバージョンからのアップグレード
Spring Bootの 1.x リリースからアップグレードする場合、詳細なアップグレード手順を提供するプロジェクトwikiの「移行ガイド」(GitHub) を確認してください。各リリースの「注目すべき新機能」のリストについては、「リリースノート」(GitHub) も確認してください。
新しい機能リリースにアップグレードすると、一部のプロパティの名前が変更または削除された可能性があります。Spring Bootは、アプリケーションの環境を分析し、起動時に診断を出力する方法を提供しますが、実行時にプロパティを一時的に移行することもできます。その機能を有効にするには、プロジェクトに次の依存関係を追加します。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-properties-migrator</artifactId>
<scope>runtime</scope>
</dependency> @PropertySourceを使用する場合など、環境に遅れて追加されるプロパティは考慮されません。 |
| 移行が完了したら、プロジェクトの依存関係からこのモジュールを削除してください。 |
既存のCLIインストールをアップグレードするには、適切なパッケージマネージャーコマンド（たとえば、brew upgrade）を使用します。CLIを手動でインストールした場合は、PATH 環境変数を更新して古い参照を削除することを忘れないで、標準の手順に従ってください。
4. 初めてのSpring Bootアプリケーションの開発
このセクションでは、Spring Bootの主要な機能のいくつかを強調するシンプルな「Hello World!」Webアプリケーションの開発方法について説明します。ほとんどのIDEでサポートされているため、Mavenを使用してこのプロジェクトを構築します。
start.spring.io(英語) に移動し、依存関係サーチャーから「Web」スターターを選択することにより、以下のステップをショートカットできます。これにより、新しいプロジェクト構造が生成されるため、すぐにコーディングを開始できます。詳細については、Spring Initializrドキュメント(英語) を確認してください。 |
開始する前に、ターミナルを開いて次のコマンドを実行し、JavaおよびMavenの有効なバージョンがインストールされていることを確認します。
$ java -version java version "1.8.0_102" Java(TM) SE Runtime Environment (build 1.8.0_102-b14) Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)
$ mvn -v Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00) Maven home: /usr/local/Cellar/maven/3.3.9/libexec Java version: 1.8.0_102, vendor: Oracle Corporation
| このサンプルは、独自のフォルダーに作成する必要があります。以降の手順では、適切なフォルダーを作成し、それが現在のディレクトリであることを前提としています。 |
4.1. POMの作成
まず、Maven pom.xml ファイルを作成する必要があります。 pom.xml は、プロジェクトのビルドに使用されるレシピです。お気に入りのテキストエディターを開き、次を追加します。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
</parent>
<description/>
<developers>
<developer/>
</developers>
<licenses>
<license/>
</licenses>
<scm>
<url/>
</scm>
<url/>
<!-- Additional lines to be added here... -->
</project>上記のリストは、機能するビルドを提供します。 mvn package を実行してテストできます（現時点では、「jarは空になります。含めるコンテンツは含まれていません! 」という警告は無視できます）。
| この時点で、プロジェクトをIDEにインポートできます（ほとんどの最新のJava IDEにはMavenの組み込みサポートが含まれています）。簡単にするために、この例では引き続きプレーンテキストエディターを使用します。 |
4.2. クラスパスの依存関係を追加する
Spring Bootには、クラスパスにjarを追加できるいくつかの「スターター」が用意されています。スモークテスト用アプリケーションは、POMの parent セクションにある spring-boot-starter-parent を使用します。spring-boot-starter-parent は、有用なMavenデフォルトを提供する特別なスタータです。また、 dependency-management セクションも用意されているため、特別な依存関係の version タグを省略できます。
その他の「スターター」は、特定のタイプのアプリケーションを開発するときに必要になる可能性のある依存関係を提供します。Webアプリケーションを開発しているため、spring-boot-starter-web 依存関係を追加します。その前に、次のコマンドを実行して、現在あるものを確認できます。
$ mvn dependency:tree [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
mvn dependency:tree コマンドは、プロジェクトの依存関係のツリー表現を出力します。 spring-boot-starter-parent 自体には依存関係がないことがわかります。必要な依存関係を追加するには、pom.xml を編集し、parent セクションのすぐ下に spring-boot-starter-web 依存関係を追加します。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies> mvn dependency:tree を再度実行すると、Tomcat WebサーバーやSpring Boot自体を含む、多くの追加の依存関係があることがわかります。
4.3. コードの作成
アプリケーションを終了するには、単一のJavaファイルを作成する必要があります。デフォルトでは、Mavenは src/main/javaからソースをコンパイルするため、そのフォルダー構造を作成してから、src/main/java/Example.java という名前のファイルを追加して、次のコードを含める必要があります。
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;
@RestController
@EnableAutoConfiguration
public class Example {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
}ここには多くのコードはありませんが、非常に多くのことが行われています。次のいくつかのセクションで重要な部分を順に説明します。
4.3.1. @RestControllerおよび@RequestMappingアノテーション
Example クラスの最初のアノテーションは @RestControllerです。これはステレオタイプアノテーションとして知られています。コードを読んでいる人や、クラスが特定のロールを果たすSpringのヒントを提供します。この場合、クラスはWeb @Controllerであるため、Springは受信Web要求を処理するときにそれを考慮します。
@RequestMapping アノテーションは、「ルーティング」情報を提供します。 / パスを持つHTTPリクエストは home メソッドにマッピングする必要があることをSpringに伝えます。 @RestController アノテーションは、結果の文字列を呼び出し元に直接返すようにSpringに指示します。
@RestController および @RequestMapping アノテーションはSpring MVCアノテーションです（Spring Bootに固有のものではありません）。詳細については、SpringリファレンスドキュメントのMVCセクションを参照してください。 |
4.3.2. @EnableAutoConfigurationアノテーション
2番目のクラスレベルのアノテーションは @EnableAutoConfigurationです。このアノテーションは、追加したjar依存関係に基づいて、Spring BootにSpringの構成方法を「推測」するよう指示します。 spring-boot-starter-web はTomcatとSpring MVCを追加したため、自動構成ではWebアプリケーションを開発していると想定し、それに応じてSpringをセットアップします。
4.3.3. 「メイン」メソッド
アプリケーションの最後の部分は、main メソッドです。これは、アプリケーションエントリポイントのJava規則に従う単なる標準的なメソッドです。メインメソッドは、runを呼び出してSpring Bootの SpringApplication クラスに委譲します。 SpringApplication はアプリケーションをブートストラップし、Springを起動します。Springは、自動構成されたTomcat Webサーバーを起動します。 Example.class を引数として run メソッドに渡して、SpringApplication がプライマリSpringコンポーネントであることを伝える必要があります。 args 配列もコマンドライン引数を公開するためにパススルーされます。
4.4. サンプルの実行
この時点で、アプリケーションは動作するはずです。 spring-boot-starter-parent POMを使用したため、アプリケーションを開始するために使用できる有用な run ゴールがあります。ルートプロジェクトディレクトリから mvn spring-boot:run と入力して、アプリケーションを起動します。次のような出力が表示されます。
$ mvn spring-boot:run . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.2.4.RELEASE) ....... . . . ....... . . . (log output here) ....... . . . ........ Started Example in 2.222 seconds (JVM running for 6.514)
Webブラウザーを localhost:8080で開くと、次の出力が表示されるはずです。
Hello World!
アプリケーションを正常に終了するには、ctrl-cを押します。
4.5. 実行可能Jarの作成
実例を実行できる完全に自己完結型の実行可能jarファイルを作成することで、この例を終了します。実行可能jar（「fat jar」と呼ばれることもあります）は、コードの実行に必要なすべてのjar依存関係とともに、コンパイルされたクラスを含むアーカイブです。
実行可能なjarを作成するには、spring-boot-maven-plugin を pom.xmlに追加する必要があります。これを行うには、dependencies セクションのすぐ下に次の行を挿入します。
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build> spring-boot-starter-parent POMには、repackage ゴールをバインドする <executions> 構成が含まれています。親POMを使用しない場合、この構成を自分で宣言する必要があります。詳細については、プラグインのドキュメントを参照してください。 |
次のように、pom.xml を保存し、コマンドラインから mvn package を実行します。
$ mvn package [INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building myproject 0.0.1-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] .... .. [INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject --- [INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar [INFO] [INFO] --- spring-boot-maven-plugin:2.2.4.RELEASE:repackage (default) @ myproject --- [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------
target ディレクトリを見ると、myproject-0.0.1-SNAPSHOT.jarが表示されているはずです。ファイルのサイズは約10 MBでなければなりません。内部を覗きたい場合は、次のように jar tvfを使用できます。
$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar
また、myproject-0.0.1-SNAPSHOT.jar.original という名前のはるかに小さいファイルが target ディレクトリに表示されるはずです。これは、Spring Bootによって再パッケージ化される前にMavenが作成した元のjarファイルです。
そのアプリケーションを実行するには、次のように java -jar コマンドを使用します。
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.2.4.RELEASE) ....... . . . ....... . . . (log output here) ....... . . . ........ Started Example in 2.536 seconds (JVM running for 2.864)
前と同様に、アプリケーションを終了するには、ctrl-cを押します。
5. 次のステップ
このセクションでいくつかのSpring Bootの基本を説明し、独自のアプリケーションを作成する方法について説明しました。タスク指向の開発者なら、spring.ioにジャンプして、特定の「Springでそれを行うには？」を解決するための、入門ガイドをチェックしてみてください。また、Spring Boot固有の「使い方」リファレンスドキュメントもあります。
それ以外の場合、次の論理ステップはusing-spring-boot.htmlに進みましょう。本当にせっかちな場合は、先に進んでSpring Bootの機能について読むこともできます。