IntelliJ IDEA 2020.1ヘルプ

Spring Boot

Spring Boot(英語)は、Springアプリケーションの初期構成を簡素化するSpring(英語)フレームワークの拡張です。これにより、最小限のデフォルト設定で動作するスタンドアロンSpringアプリケーションをすばやく作成できます。

Spring Initializr(英語)は、Spring Bootプロジェクトを生成できるWebアプリケーションです。ビルドツール、言語、Spring Bootフレームワークのバージョン、プロジェクトの依存関係など、必要な構成を選択できます。IntelliJ IDEAは、Spring Initializr APIと統合してIDEからプロジェクトを直接生成およびインポートするSpring Initializrプロジェクトウィザードを提供します。

Spring Bootプロジェクトを作成する

  1. メインメニューからファイル | 新規 | プロジェクトを選択します。

  2. 新規プロジェクトウィザードの左側のペインで、Spring Initializrを選択します。

  3. プロジェクト SDKリストから、プロジェクトで使用するJDKを選択します。

    JDKがコンピューターにインストールされているが、IDEで定義されていない場合は、JDKを追加を選択し、JDKホームディレクトリへのパスを指定します。

    コンピューターに必要なJDKがない場合は、JDK のダウンロードを選択します。

  4. デフォルトのSpring Initializr(英語)サービスを選択し、次へをクリックします。

    必要に応じて、さまざまなデフォルト設定と使用可能な設定を使用して、サービスのカスタムインスタンスを使用できます。詳細については、独自のインスタンスを作成するを参照してください。

  5. プロジェクト設定を構成し、次へをクリックします。

    プロジェクトJDKのバージョンとは異なるJavaバージョンでプロジェクトをビルドする場合は、ここで選択できます。

  6. プロジェクトの依存関係を選択し、次へをクリックします。追加のプラグインを必要とするテクノロジーを選択した場合、IntelliJ IDEAはプロジェクトが作成されるとそれについて通知し、インストールまたは有効にすることを提案します。

  7. プロジェクト構成を完成させ、完了をクリックします。

Spring Initializrは、以下のファイルを使用して有効なプロジェクト構造を生成します。

  • ビルド構成ファイル。たとえば、Gradleの場合は build.gradle、Mavenの場合は pom.xml

  • アプリケーションをブートストラップする main() メソッドを持つクラス。

  • 空のJUnitテストクラス。

  • 空のSpringアプリケーション構成ファイル: application.properties

デフォルトでは、IntelliJ IDEAは生成されたファイルにコードフォーマットを適用します。Spring Initializrによって生成されたファイルをフォーマットしたままにする場合は、設定/環境設定ダイアログ Ctrl+Alt+Sを開き、言語 & フレームワーク | Spring | Spring Bootに移動して、イニシャルグループのコードの再フォーマットオプションを無効にします。

カスタム構成ファイル

Spring Initializrは1つのデフォルト構成ファイルを作成しますが、開発には必ずしも十分とは限りません。デフォルトの構成ファイルを使用しない場合、または異なる環境でコードを実行する場合は、プロジェクトで定義されたカスタム構成ファイルを使用できます。

IntelliJ IDEAにプロジェクト内の構成ファイルを知らせて、関連する強調表示とコーディング支援を有効にします。

  1. メインメニューからファイル | プロジェクト構造を選択するか、Ctrl+Shift+Alt+S を押してプロジェクト構造ダイアログを開きます。

  2. 左側のリストからファセットを選択します。

  3. 中央のリストからSpringファセットを選択し、右側のセクションで Customize Spring Boot をクリックします。

  4. デフォルトのファイルの代わりにカスタム構成ファイルを使用する場合は、その名前を spring.config.name フィールドに入力します。

    複数の構成ファイルを使用する場合は、The Add button をクリックして、プロジェクトツリーからファイルを選択します。

    有効な構成ファイルは The Spring Boot iconでマークされています。

  5. OKをクリックし、変更を適用します。

Configuring a custom configuration file

ランタイムエンドポイント

Spring Bootには、HTTPエンドポイントを介して、またはJava Management Extensions(JMX)を使用して、実稼働環境でアプリケーションの状態を監視および管理するための追加機能が含まれています。詳細については、Spring Bootアクチュエータ: 本番環境対応機能を参照してください。

Spring Bootエンドポイントを有効にする

  • プロジェクトのSpring Bootアクチュエータ依存関係を追加します。

    pom.xml ファイルを開き、次の依存関係を dependenciesに追加します。

    <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>

    build.gradle ファイルを開き、次の依存関係を dependenciesに追加します。

    implementation 'org.springframework.boot:spring-boot-starter-actuator'

この依存関係でアプリケーションを実行すると、公開されたアクチュエータエンドポイントにHTTP経由でアクセスできます。例:アプリケーションがlocalhostポート番号8080で実行されている場合、health エンドポイントのデフォルトURLはhttp://localhost:8080/actuator/health(英語)になります。

JMXを介してSpring Bootエンドポイントを公開する

デフォルトでは、IntelliJ IDEAはSpring Boot実行構成のJMXエージェントを有効にするため、アプリケーションを実行すると、IDEはアクチュエータエンドポイントにアクセスできます。

  1. メインメニューから実行 | 構成の編集を選択します。

  2. 実行/デバッグ構成ダイアログで、Spring Boot実行構成を選択してから、JMX エージェントを使用可能にするオプションを選択します。

Spring Bootエンドポイントを表示する

  1. Spring Bootアプリケーションを実行し、サービスツールウィンドウを開きます。表示 | ツール・ウィンドウ | サービスを選択するか、Alt+8を押します。

  2. 実行中のSpring Bootアプリケーションを選択し、エンドポイントタブを開きます。

Spring endpoints shown in Services tool window

タブを使用して、ランタイムBeanヘルス情報リクエストマッピングなどのタイプのエンドポイントを表示できます。

Bean

エンドポイントBeanタブには、Spring BootアプリケーションのランタイムBeanが表示されます。beanをダブルクリックして、その宣言をエディターで開きます。これらのBeanは、ガターの Spring Live bean アイコンを使用して示されます。このアイコンをクリックして、依存Beanとインジェクション済みBeanを表示します。

Beanタブには、次のツールバーアクションがあります。

アクション

説明

The Refresh button リフレッシュ

JMXエージェントによって収集されたランタイムBean情報をリフレッシュします。

The Diagram Mode button ダイアグラムモード

リストではなく、すべてのランタイムBeanの完全なグラフを表示します。

必要なプラグイン:UML(バンドル)。

The Show Library Beans button ライブラリBeanを表示

ライブラリのbeanを表示します。

The Show Contexts button コンテキストを表示

利用可能なSpring アプリケーションコンテキストを表示します。

The Show Configuration Files button 構成ファイルの表示

利用可能な設定ファイルを表示します。

The Show Bean Documentation button Bean ドキュメントの表示

選択したbeanのドキュメントを表示します。

The Show Bean Graph button Bean グラフの表示

選択したbeanの直接の依存関係を表示します。

必要なプラグイン:UML(バンドル)。

状態

エンドポイント状態タブには、アプリケーションのステータスが表示されます。自動構成されたヘルスインジケーターがいくつかあり、カスタムヘルスインジケーターを作成することもできます。

詳しくは、状態を参照してください。

マッピング

エンドポイントマッピングタブには、アプリケーションのリクエストマッピングが表示されます。 @RequestMapping 注釈または @GetMappingなどのショートカットを含むすべてのメソッドをリストします。

パスマッピングURIをクリックすると、対応するHTTPリクエストを実行するか、リクエストでHTTPリクエストファイルを開くか、リクエストURLをWebブラウザーで開くかを選択できます( GET リクエストの場合)。詳細については、IntelliJ IDEAコードエディターのHTTPクライアント(英語)を参照してください。

Opening HTTP request mappings from Services tool window

メソッドをダブルクリックして、その宣言をエディターで開きます。Springはハンドラーなどのメソッドを登録し、IntelliJ IDEAはガター内の Spring request mapping アイコンで示します。このアイコンをクリックして、対応するHTTPリクエストを実行し、リクエストファイルで、またはWebブラウザー( GET リクエストの場合)で開きます。

マッピングタブには、次のツールバーアクションがあります。

アクション

説明

The Refresh button リフレッシュ

JMXエージェントによって収集された要求マッピングをリフレッシュします。

The Open in Browser button ブラウザーで開く

WebブラウザーでルートアプリケーションのURLを開きます。

The Request Method menu 要求メソッド

表示するリクエストメソッドを選択します。

The Show Library Mappings button ライブラリマッピングを表示

ライブラリからのリクエストのマッピングを表示します。

アプリケーション更新ポリシー

spring-boot-devtools モジュールを使用すると、クラスパス上のファイルが変更されるたびにアプリケーションが再起動します。変更されたファイルを継続的にコンパイルするようにIntelliJ IDEAが構成されている場合は、トリガーファイルを設定できます。この場合、トリガーファイルを変更した後にのみ、アプリケーションが再起動します。詳細については、自動再起動を参照してください。

自動再起動を有効にする

  • プロジェクトに spring-boot-devtools モジュールの依存関係を追加します。

    pom.xml ファイルを開き、次の依存関係を dependenciesに追加します。

    <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency>

    spring-boot-devtools 依存関係を optional として設定すると、プロジェクトを使用する他のモジュールで使用されなくなります。

    build.gradle ファイルを開き、次の依存関係を dependenciesに追加します。

    developmentOnly("org.springframework.boot:spring-boot-devtools")

    spring-boot-devtools 依存関係を developmentOnly として設定すると、プロジェクトを使用する他のモジュールで使用されなくなります。

実行中のアプリケーションを更新するには、メインメニューから実行 | デバッグ・アクション | アプリケーションを更新 Ctrl+F10 を選択するか、サービスツールウィンドウでアプリケーションを選択して Update applicationをクリックします。必要に応じて、このアクションを実行したときのIDEの動作を構成できます。

アプリケーション更新ポリシーを構成する

  1. メインメニューから実行 | 構成の編集を選択します。

  2. Spring Boot実行構成を選択します。

  3. アプリケーション更新ポリシーの実行で、'更新' アクション時リストから必要なアクションを選択します。リソースのみの更新、クラスとリソースの両方の更新(アプリケーションのビルド)、トリガーファイルの更新(再起動のトリガー)、またはクラスのホットスワップの実行を試み、失敗した場合は、トリガーファイル。

フレーム切り替え時リストから、別のアプリケーションに切り替えた後にIDEが実行するアクション(リソースの更新、またはアプリケーションのビルド)を選択することもできます。

最終更新日: 2020年7月7日

関連ページ:

SDK

ソフトウェア開発キットまたはSDKは、特定のソフトウェアフレームワーク用のアプリケーションを開発するために必要なツールのコレクションです。例:Javaでアプリケーションを開発するには、Java SDK(JDK)が必要です。SDKには、バイナリ、バイナリのソースコード、およびソースコードのドキュメント...

コードの再フォーマットと再配置

IntelliJ IDEAでは、コード・スタイル設定で指定した要件に従ってコードを再フォーマットできます。ただし、プロジェクトでEditorConfigを使用する場合、ファイルで指定されたオプションは、コードを再フォーマットするときにコードスタイル設定で指定されたオプションをオーバーライドします。設...

サービスツールウィンドウ

サービスツールウィンドウには、ソフトウェア開発中に役立つさまざまなサービスが含まれます。実行/デバッグ構成、アプリケーションサーバー、データベースセッション、Docker接続など。プラグイン開発者はIntelliJプラットフォームAPIを通して他のサービスを追加することができます。メイン・ツールバー...

Spring

Spring に関してはSpring Boot 入門 (日本語訳)を参照してください。Springは、Javaプラットフォーム用のアプリケーションフレームワークです。マイクロサービスアーキテクチャ、クラウドシステム、リアクティブ処理、サーバーレスワークロードをサポートする最新のWebアプリケーション...

IntelliJ IDEAコードエディターのHTTPクライアント

Webサービスをテストするときは、IntelliJ IDEAコードエディターで直接HTTPリクエストを作成、編集、および実行できます。HTTPリクエストは.httpおよび.restファイルに保存され、アイコンでマークされています。HTTPファイルのサポートには、以下の機能が含まれます。コードの強調表...

Springダイアグラム

Spring に関してはSpring Boot 入門 (日本語訳)を参照してください。Springダイアグラムは、アプリケーションの依存関係を分析できます。ダイアグラム上のBeanまたはファイルをダブルクリックすると、エディター内の専用のタブで開くことができます。Spring Bootについては、ラ...