IntelliJ IDEA 2020.3 ヘルプ

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+Alt+Shift+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 を介して公開されたアクチュエーターエンドポイントにアクセスできるようになります。例: アプリケーションがローカルホストポート番号 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 が実行するアクション(リソースの更新、またはアプリケーションのビルド)を選択することもできます。

関連ページ:

SDK

ソフトウェア開発キットまたは SDK は、特定のソフトウェアフレームワーク用のアプリケーションを開発するために必要なツールのコレクションです。例: Java でアプリケーションを開発するには、Java SDK(JDK)が必要です。SDK には、バイナリ、バイナリのソースコード、およびソースコードのドキュメントが含まれています。JDK ビルドにはアノテーションも含まれています。一般に、SDK はグローバルです。つまり、1 つの SDK を複数のプロジェクトやモジュールで使用できます。新しいプロジェクト...

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

IntelliJ IDEA では、コードスタイル設定で指定した要件に従ってコードを再フォーマットできます。ただし、プロジェクトで EditorConfig を使用する場合、ファイルで指定されたオプションは、コードを再フォーマットするときにコードスタイル設定で指定されたオプションをオーバーライドします。設定にアクセスするには、設定 / 環境設定ダイアログでに移動します。詳細については、コードスタイルの構成を参照してください。コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを再...

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

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

Spring

Spring に関しては Spring Boot 入門を参照してください。Spring は、Java プラットフォーム用のアプリケーションフレームワークです。マイクロサービスアーキテクチャ、クラウドシステム、リアクティブ処理、サーバーレスワークロードをサポートする最新の Web アプリケーションを構築できます。IntelliJ IDEA は、専用のプロジェクトウィザード、コードのハイライト、インテリジェントコンテキストアクション、埋め込みドキュメント、ナビゲーション、高度にカスタマイズ可能な実行構成...

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

Web サービスをテストする場合、IntelliJ IDEA コードエディターで直接 HTTP リクエストを作成、編集、実行できます。HTTP リクエストは .http および .rest ファイルに保存され、アイコンでマークされています。HTTP ファイルのサポートには、以下の機能が含まれます。コードのハイライト、ホスト、メソッドタイプ、ヘッダーフィールド、OpenAPI を介して定義されたエンドポイントのコード補完。リクエスト、そのパーツ、応答ハンドラースクリプト用のコードの折りたたみ、リクエストヘッダー...

Spring ダイアグラム

Spring に関しては Spring Boot 入門を参照してください。Spring ダイアグラムは、アプリケーションの依存関係を分析できます。ダイアグラム上の Bean またはファイルをダブルクリックすると、エディター内の専用のタブで開くことができます。Spring Boot については、ランタイム Bean の図を構築することもできます。Spring Bean の依存関係図:Spring Bean 依存関係図を使用して、プロジェクト内の Bean 間の依存関係を表示および分析します。ダイア...