チュートリアル: Spring サポート機能を見る

JPA と H2 の依存関係を追加する

Spring Data JPA モジュールは、Java Persistence API(JPA) を使用したデータアクセスのサポートを提供します。

H2(英語) は、Java で記述された高速のインメモリ SQL データベースです。

1. プロジェクトのルートディレクトリにある pom.xml ファイルを開きます。

   

2. エディターで pom.xml ファイルを開いた状態で、 Alt+Insert を押して スターターの追加 を選択します。

3. 開いたウィンドウで、 Spring Data JPA および H2 データベース の依存関係を選択します。

   • org.springframework.boot:spring-boot-starter-data-jpa

   • com.h2database:h2

   または、これらの依存関係を pom.xml に手動で追加できます。

   <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> </dependency>

4. ポップアップで をクリックするか、 Ctrl+Shift+O を押して、更新されたプロジェクト構造を同期します。

データベースに格納される JPA エンティティを作成する

Spring アプリケーションのデータモデルを定義するには、JPA エンティティを作成します。 アプリケーションは、ID、名、姓を持つ Customer オブジェクトを作成して保存します。

1. src/main/java/com/example/springboottutorial に Customer.java ファイルを作成します。

   プロジェクト ツールウィンドウで、 src/main/java/com/example/springboottutorial ディレクトリを選択し、メインメニューから ファイル | 新規 | Java クラス を選択します（または Alt+Insert を押して Java クラス を選択します）。 クラス を選択し、クラスの名前 Customer を入力します。

2. デフォルトのテンプレートを変更するか、次の Java コードに置き換えます。

   package com.example.springboottutorial; import jakarta.persistence.Entity; import jakarta.persistence.GeneratedValue; import jakarta.persistence.GenerationType; import jakarta.persistence.Id; @Entity public class Customer { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Integer id; private String firstName; private String lastName; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getFirstName() { return firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } }

   @Entity アノテーションは、 Customer クラスがデータベース内の対応するテーブルに変換する必要がある JPA エンティティであることを示します。 IntelliJ IDEA は、ガターの でそれを指定します。

   @Id アノテーションは、 id フィールドがオブジェクトの ID であることを示しています。 IntelliJ IDEA は、ガターの でそれを指定します。 @GeneratedValue は、ID が自動的に生成されるべきであることを JPA に伝えます。

   他のすべてのエンティティ属性 (この例では firstName および lastName) は、ガター内で で指定されます。 これを使用すると、 永続ビューで属性をすばやく開くことができます。

リポジトリインターフェースを作成する

Spring Data JPA は実行時にこのインターフェースからリポジトリ実装を作成します。

1. src/main/java/com/example/springboottutorial に CustomerRepository.java ファイルを作成します。

   プロジェクト ツールウィンドウで、 src/main/java/com/example/springboottutorial ディレクトリを選択し、メインメニューから ファイル | 新規 | Java クラス を選択します（または Alt+Insert を押して Java クラス を選択します）。 インターフェース を選択し、インターフェースの名前を入力します: CustomerRepository

2. デフォルトのテンプレートを変更するか、次の Java コードに置き換えます。

   package com.example.springboottutorial; import org.springframework.data.repository.CrudRepository; public interface CustomerRepository extends CrudRepository<Customer, Integer> { Customer findCustomerById(Integer id); }

   このリポジトリは、 Customer エンティティと 整数 ID で動作します。 また、 findCustomerById() メソッドも宣言します。 Spring Data JPA はこのメソッドのシグネチャーに基づいてクエリを派生し、指定された ID の Customer オブジェクトを選択します。 他のメソッドを追加して、IntelliJ IDEA が利用可能な JPA エンティティ (この場合は Customer クラス) に基づいて補完候補をどのように提供するかを確認できます。

Web コントローラーを作成する

コントローラーは、Spring アプリケーションの HTTP リクエストを処理します。 アプリケーションは /add エンドポイントを使用してデータベースに Customer オブジェクトを追加し、 /list エンドポイントを使用してデータベースからすべての Customer オブジェクトをフェッチし、 /find/{id} エンドポイントを使用して指定された ID の顧客を見つけます。

1. /src/main/java/com/example/springboottutorial/ に DemoController.java ファイルを作成します。

   プロジェクト ツールウィンドウで、 /src/main/java/com/example/springboottutorial/ ディレクトリを選択し、メインメニューから ファイル | 新規 | Java クラス を選択します（または Alt+Insert を押して Java クラス を選択します）。 クラス を選択し、クラスの名前 DemoController を入力します。

2. デフォルトのテンプレートを変更するか、次の Java コードに置き換えます。

   package com.example.springboottutorial; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*; @RestController public class DemoController { @Autowired private CustomerRepository customerRepository; @PostMapping("/add") public String addCustomer(@RequestParam String first, @RequestParam String last) { Customer customer = new Customer(); customer.setFirstName(first); customer.setLastName(last); customerRepository.save(customer); return "Added new customer to repo!"; } @GetMapping("/list") public Iterable<Customer> getCustomers() { return customerRepository.findAll(); } @GetMapping("/find/{id}") public Customer findCustomerById(@PathVariable Integer id) { return customerRepository.findCustomerById(id); } }

   各 Spring アノテーションの意味は次のとおりです。

   • @RestController アノテーションは、 DemoController クラスをリクエストハンドラー（REST コントローラー）としてマークします。 IntelliJ IDEA は、ガター内の でこれを示します。クリックすると、対応する Spring bean 宣言へ移動できます。

   • @Autowired アノテーションは Spring に customerRepository bean の注入を指示します。これは リポジトリ インターフェース から実装されています。 IntelliJ IDEA は、ガター内の でこれを示します。クリックすると、対応する自動注入された依存関係へ移動できます。

   • @PostMapping("/add") アノテーションは、 addCustomer() メソッドを /add の POST リクエストにマップします。

   • @RequestParam アノテーションは、メソッドパラメーターを対応する Web リクエストパラメーターにマップします。

   • @GetMapping("/list") アノテーションは、 getCustomers() メソッドを /list の GET リクエストにマップします。

   • @GetMapping("/find/{id}") アノテーションは、 findCustomerById() メソッドを /find/{id} の GET リクエストにマップします。

   • @PathVariable アノテーションは、 id 変数の代わりに、URL から対応するメソッドパラメーターに値をマッピングします。

   IntelliJ IDEA は、ガター内の で Web リクエストメソッドを示します。これをクリックすると、組み込みの HTTP クライアント で対応するリクエストを実行できます。

アプリケーションを実行してリクエストを実行する

1. Shift+F10 を押すか、 SpringBootTutorialApplication.java ファイルのガターにある アイコンを使用してアプリケーションを実行します。

   デフォルトでは、IntelliJ IDEA は実行中の Spring Boot アプリケーションを 実行ツールウィンドウに表示します。

   

   コンソール タブには、Spring ログメッセージの出力が表示されます。 デフォルトでは、組み込みの Apache Tomcat サーバーはポート 8080 でリッスンしています。

2. Web ブラウザーを開き、 http://localhost:8080/list に移動します。 データベースに顧客がいないため、アプリケーションが空のリスト [ ] で応答するはずです。

   顧客を追加するには、姓と名を指定するリクエストパラメーターを使用して、 /add エンドポイントに POST リクエストを送信する必要があります。 IntelliJ IDEA には、HTTP リクエストを作成および実行するための HTTP クライアントがエディターに組み込まれています。

3. DemoController.java を開き、 addCustomer() メソッドの横のガターで をクリックします。

4. リクエストファイルで、次の POST リクエストを作成します。

   ### POST http://localhost:8080/add?first=Homer&last=Simpson

5. ガターで をクリックして、リクエストを実行します。

   IntelliJ IDEA は 実行 ツールウィンドウを開き、要求と応答の両方を出力します。

   POST http://localhost:8080/add?first=Homer&last=Simpson HTTP/1.1 200 Content-Type: text/plain;charset=UTF-8 Content-Length: 19 Date: Thu, 28 May 2020 08:10:30 GMT Keep-Alive: timeout=60 Connection: keep-alive Added new customer to repo! Response code: 200; Time: 217ms; Content length: 19 bytes

6. HTTP リクエストファイルを再度開き、GET リクエストを作成してすべての顧客を取得します。

   ### GET http://localhost:8080/list

   IntelliJ IDEA は、リクエストメソッドと本文、場所、利用可能なエンドポイントの補完候補を提供します。

   

7. GET リクエストを実行して、すべての顧客を取得します。

   GET http://localhost:8080/list HTTP/1.1 200 Content-Type: application/json Transfer-Encoding: chunked Date: Thu, 28 May 2020 08:23:05 GMT Keep-Alive: timeout=60 Connection: keep-alive [ { "id": 1, "firstName": "Homer", "lastName": "Simpson" } ] Response code: 200; Time: 171ms; Content length: 51 bytes

他の顧客を追加するには、より多くの POST リクエストを実行してみてください。 それぞれが一意の ID を取得します。 次に、GET リクエストを作成して実行し、特定の ID を持つ顧客を返します。 例:

Spring Boot アクチュエーターを追加

Spring Boot アクチュエーターは、アプリケーションの監視と管理に役立ついくつかのエンドポイントを追加します。 これにより、IntelliJ IDEA はアプリケーションのヘルス情報と実行時に利用可能なすべてのリクエストマッピングを公開できます。

1. プロジェクトのルートディレクトリにある pom.xml ファイルを開きます。

2. エディターで pom.xml ファイルを開いた状態で、 Alt+Insert を押して スターターの追加 を選択します。

3. 開いた スターターの追加 ウィンドウで、 Spring Boot アクチュエーター 依存関係を選択します。

   

   または、依存関係を手動で追加できます。

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

4. ポップアップで をクリックするか、 Ctrl+Shift+O を押して、更新されたプロジェクト構造を同期します。

5. または Ctrl+F5 を使用して Spring アプリケーションを再起動します。

6. ヘルス タブを開いて、アプリケーションのステータスを監視します。

   

7. マッピング タブを開いて、リクエストマッピングエンドポイントを操作します。

   

   ライブラリによって提供されるエンドポイント (Spring Boot アクチュエーター自体など) を表示するには、 をクリックします。 エンドポイントパスをクリックして対応するリクエストを直接実行するか、HTTP リクエストファイルで生成して開き、必要に応じて変更して実行するか、GET リクエストの場合は Web ブラウザーでエンドポイント URL を開きます。

8. 環境 タブを開いて、Spring 環境を表示します。 /actuator/env エンドポイントから取得されるこの情報には、アプリケーションプロパティや環境変数など、さまざまな構成ソースから利用可能なすべてのプロパティが含まれます。

   

   詳細については、 環境 を参照してください。

Spring Boot 開発者ツールを追加

コードに変更を加えた場合、プロジェクト全体を再実行する必要があります。すべての依存関係を含めたアプリケーションを停止し、コードを再ビルドして新しいコードでアプリケーションを開始してください。 IntelliJ IDEA では、すべての外部ライブラリ コンテキストを再起動しなくても、Spring アプリケーションコンテキストだけを再起動する方法が提供されています。 これは、多くの依存関係を持つ大規模なプロジェクトで特に、デバッグやコードの微調整時に時間を節約できます。 実行中のアプリケーション内で静的リソースやテンプレート リソースも更新できます。

この機能は、 spring-boot-devtools モジュールに基づいています。

1. プロジェクトのルートディレクトリにある pom.xml ファイルを開きます。

2. エディターで pom.xml ファイルを開いた状態で、 Alt+Insert を押して スターターの追加 を選択します。

3. 開いた スターターの追加 ウィンドウで、 Spring Boot DevTools 依存関係を選択します。

   または、依存関係を手動で追加できます。

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

4. ポップアップで をクリックするか、 Ctrl+Shift+O を押して、更新されたプロジェクト構造を同期します。

5. メインメニューで、 実行(U) | 実行構成の編集(E) に移動し、 SpringBootTutorialApplication 構成を選択します。

6. オプションを変更(M) で、 '更新' アクション時(U) と フレーム切り替え時(F) の両方のオプションを クラスとリソースの更新 に設定し、 OK(O) をクリックして変更を適用します。

7. Spring アプリケーションを再起動します。

アプリケーションは同じように機能しますが、ソースコードまたはリソースに変更を加えるたびに、更新をトリガーできるようになりました。 メインメニューから 実行(U) | デバッグアクション | ''{0}'' アプリケーションの更新 Ctrl+F10 を選択するか、フォーカスを IntelliJ IDEA から別のアプリケーション（Web ブラウザーなど）に変更します。 これにより、アプリケーションのすべてのクラスとリソースが更新され、必要に応じてアプリケーションが再起動されます。

ホームページを変更する

アプリケーションの更新がどのように機能するかを示すために、ホームページで /add および /list HTTP エンドポイントを公開してみましょう。 ホームページの追加の詳細については、「ホームページを追加 」を参照してください。

1. /src/main/resources/static/index.html ファイルを開いて変更するか、次の HTML コードに置き換えます。

   <!DOCTYPE HTML> <html> <head> <title>You first Spring application</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> </head> <body> <form action="/add" method="POST"> <p>Let's add a customer.</p> <div> <label for="firstName">First name:</label> <input name="first" id="firstName" value="Homer"> </div> <div> <label for="lastName">Last name:</label> <input name="last" id="lastName" value="Simpson"> </div> <div> <button>Add customer</button> </div> </form> <form action="/list" method="GET"> <button>List customers</button> </form> </body> </html>

2. Web ブラウザーを開き、 http://localhost:8080/ に移動します。 必要に応じて、ページをリフレッシュして新しいホームページを表示します。

   

   一部の顧客を追加してリストします。 http://localhost:8080/find/2 に HTTP リクエストを送信して、ID 2 の顧客を見つけることもできます。

3. index.html で HTML コードを変更してから、Web ブラウザーに切り替えて、ページをリフレッシュした後に変更を確認できます。

   さらに進んで LiveReload をインストールすると、ブラウザーが自動的にリフレッシュされます。