アプリケーション開発

Duet AI アシスタントを使用して IntelliJ で Java Spring Boot アプリを構築

2023年11月28日

Google Cloud Japan Team

※この投稿は米国時間 2023 年 11 月 11 日に、Google Cloud blog に投稿されたものの抄訳です。

Google Cloud の Duet AI は、デベロッパー、オペレーター、セキュリティ専門家、データ専門家などに有用な AI アシスタントです。IDE 統合を備えており、Visual Studio Code や、IntelliJ IDEA を含む JetBrains IDE での利用が可能です。

この記事では、JetBrains IntelliJ IDEA 内で Duet AI を使用し、シンプルな Java Spring Boot ウェブアプリケーションをゼロから作成する方法を説明します。

Spring Initializr で作成した空のプロジェクトから始め、Duet AI 支援のコード生成を使ってアプリケーションを作成して、単体テストを追加する方法を実験します。

以下に紹介する手順に加えて、こちらの解説動画も参考にしてただけたら幸いです。

https://storage.googleapis.com/gweb-cloudblog-publish/images/maxresdefault_3Qv8H1E.max-1300x1300.jpg

必要なもの

Duet AI を有効にした、次の条件を満たす Google Cloud プロジェクト。
a. Duet AI へのアクセス権が自身に付与されている
b. Duet AI API が有効になっている
c. 課金が有効になっている
IntelliJ IDEA Community エディションまたは Ultimate エディションがインストールされたパソコン。
Cloud Code for IntelliJ プラグインがインストールされていること。

IDE から Google Cloud にログインしていること。IntelliJ に [Tools] メニューが表示されない場合は、Ctrl+Shift+A（Windows）または Cmd+Shift+A（Mac）で操作メニューを開き、検索バーに「main menu」と入力して、[Main Menu] を選択します。そこから、[Tools] > [Google Cloud Code] > [Sign in to Google Cloud Platform] を選択します。

https://storage.googleapis.com/gweb-cloudblog-publish/images/1_Duet_AI_assistance.max-1100x1100.png

Cloud Code で Duet AI が有効になっていること。

最初の Spring Boot プロジェクトを構築する

アプリケーションの作成は、Spring Initializr で作成したサンプル Spring Boot プロジェクトから始める必要があります。IntelliJ IDEA Ultimate エディションをお持ちの場合は、IDE の [New] > [Project] フローから、同じオプションを選択して Spring Boot プロジェクトを直接作成できます。

https://start.spring.io/ にアクセスします。
Spring Initializer ページの [Project] で、[Maven] を選択します。
[Project Metadata] で以下を行います。
a.[Artifact] と [Name] を「greeting-app」に変更します。
b. [Description] を「Greeting App made with Duet AI assistance」（Duet AI のアシスト機能を使用して作成されたグリーティングアプリ）に変更します。
他のオプションはそのままにします。

https://storage.googleapis.com/gweb-cloudblog-publish/images/image3_NMVo3rj.max-1200x1200.png

5. ページの右上隅にある [ADD DEPENDENCIES] をクリックします。

6. リストから [Spring Web] を選択します。

7. ページの下部にある [GENERATE] をクリックすると、greeting-app.zip ファイルをダウンロードできます。

8. ファイルを最適な場所（終了後にプロジェクトを削除する場合は一時的な場所）に保存し、ファイルを解凍します。

Duet AI のコード生成アシスト機能を使用してコードを構築する

IntelliJ で [File] > [Open] に移動します（またはウェルカム画面で [Open] をクリックします）。
ファイルを解凍したフォルダを選択し、[Open] をクリックします。
IntelliJ でプロジェクトフォルダを開いたら、GreetingAppApplication クラスをダブルクリックしてコンテンツを表示します。
src/main/java/com.example.greetingapp の下に HomeController.java という名前の新しいファイルを作成します。

https://storage.googleapis.com/gweb-cloudblog-publish/images/3_Duet_AI_assistance.max-1300x1300.png

5. HomeController.java ファイルの先頭に、次のコメントを入力します。

読み込んでいます...

6. Enter を押し、Alt+\（Windows / Linux）または Option+\（macOS）を押してコードを生成します。または、魔法の杖をクリックします。

7. ゴーストテキスト形式でコードが生成されます。コードの機能は次のようになります。@GetMapping("/hello") アノテーションと hello() メソッドにより、リクエスト内の name 変数の値に基づいてユーザーへの挨拶が生成されます。変数に値がない場合は値「World」が使用されます。

読み込んでいます...

8. 上記と同じコードが生成された場合は、Tab キーを押して提案を受け入れます。異なるコードが生成された場合は、意図したとおりに動作するかどうかを評価し、変更を加えるか、上記のコード例を使用するかを決定します。

9. おそらくここで、提案されたコードの一部がハイライトされ、IntelliJ に警告（[problems] ペインで確認可能）が表示されます。生成されたコードはトレーニングデータ内のサンプルの一つから取得されたものであるため、ライセンスの対象になる可能性があることが、Duet AI のライセンスチェックによって警告されます。警告メッセージにはトレーニングデータのソースが含まれ、ユーザーが確認できるようになっています。

https://storage.googleapis.com/gweb-cloudblog-publish/images/4_Duet_AI_assistance.max-500x500.png

10. それでは、生成されたコードが機能するかどうかを確認してみましょう。IntelliJ ターミナルで次のように入力します。

読み込んでいます...

11. ターミナルに Spring ログメッセージの出力が表示されます。

https://storage.googleapis.com/gweb-cloudblog-publish/images/5_Duet_AI_assistance.max-1400x1400.png

12. デフォルトでは、組み込みの Apache Tomcat サーバーはポート 8080 でリッスンしています。ウェブブラウザを開き、http://localhost:8080/hello に移動します。Duet AI が生成したコードが機能すれば、アプリケーションが「Hello World!」と応答することを確認できます。

13. ウェブリクエストに名前を指定することでも、挨拶に含める名前をアプリケーションに伝えることができます。たとえば、次のように指定します。http://localhost:8080/hello?name=John

14. IntelliJ に戻り、ターミナルで Ctrl+C を押してアプリケーションを停止します。

15. 次に、このアプリを少し改良してみましょう。resources/static フォルダ内に index.html ファイルを作成します。

https://storage.googleapis.com/gweb-cloudblog-publish/images/6_Duet_AI_assistance.max-400x400.png

16. ファイルの先頭に次のコメントを入力します。

読み込んでいます...

17. Enter を押し、Alt+\（Windows / Linux）または Option+\（macOS）を押してコードを生成します。または、魔法の杖をクリックします。

18. 下の例と同等の機能を持つコードがゴーストテキスト形式で生成されます。

読み込んでいます...

19. 上記と同じコードが生成された場合は、Tab キーを押して提案を受け入れます。異なるコードが生成された場合は、意図したとおりに動作するかどうかを評価し、変更を加えるか、上記のコード例を使用するかを決定します。

20. 以下のコマンドで、アプリケーションを再度実行します。

読み込んでいます...

21. ここで、index.html ファイルを追加したので、ブラウザからルートにあるアプリケーションにアクセスします（http://localhost:8080/）。Greetings Form が表示されます。

https://storage.googleapis.com/gweb-cloudblog-publish/images/7_Duet_AI_assistance.max-800x800.png

22. 名前を入力して [Greet me] をクリックすると、挨拶が表示されます。

23. IntelliJ に戻り、ターミナルで Ctrl+C を押してアプリケーションを停止します。

アプリケーションに単体テストを追加する

src/test/java/com.example.greetingapp の下に HomeControllerTest.java という新しいファイルを作成します。

https://storage.googleapis.com/gweb-cloudblog-publish/images/8_Duet_AI_assistance.max-800x800.png

2. ファイルの先頭に次のコメントを入力します。

読み込んでいます...

3. Enter を押し、Alt+\（Windows / Linux）または Option+\（macOS）を押してコードを生成します。または、魔法の杖をクリックします。

4. 下の例と同等の機能を持つコードがゴーストテキスト形式で生成されます。このコードで、デフォルトの「Hello World!」文字列と name 変数のカスタム値の両方をテストできます。

読み込んでいます...

package com.example.greetingapp;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(HomeController.class)
public class HomeControllerTest {

@Autowired
    private MockMvc mockMvc;

@Test
    public void testHello() throws Exception {
        mockMvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string("Hello World!"));
    }

@Test
    public void testHelloWithName() throws Exception {
        mockMvc.perform(get("/hello?name=John"))
                .andExpect(status().isOk())
                .andExpect(content().string("Hello John!"));
    }
}

5. 上記と同じコードが生成された場合は、Tab キーを押して提案を受け入れます。異なるコードが生成された場合は、想定したテストケースに適用できるかどうかを評価し、変更を加えるか、上記のコード例を使用するかを決定します。

6. ターミナルで次のコマンドを実行します。

読み込んでいます...