IntelliJ IDEA 2024.3 ヘルプ

Gradle 入門

このチュートリアルでは、Gradle プロジェクトを作成して実行およびテストし、Gradle を使用して実行可能 JAR ファイルを実行します。

このチュートリアルで使用されているプロジェクトは、GitHub(英語) にあります。パッケージ名が com.gradle.tutorial から org.mytest に変更されていることに注意してください。また、Gradle、JDK、JUnit のバージョンも異なります。

ステップ 1. プロジェクトの作成

Java で Gradle プロジェクトを作成しましょう。

IntelliJ IDEA を使用して新しい Gradle プロジェクトを作成する

  1. ウェルカム画面で、新規プロジェクトをクリックします。

    New project Gradle
  2. 開いたページで、プロジェクトの名前(FizzBuzz)と場所を指定しましょう。

  3. Gradle プロジェクトを作成しているため、プロジェクトと Gradle に必要な Java オプションを選択しましょう。

  4. IntelliJ IDEA は、JDK フィールドにプロジェクト SDK (JDK) を自動的に追加します。このチュートリアルでは、オープンな JDK 14 バージョンを使用します。

    選択した JDK を変更できます。IntelliJ IDEA は適切な Gradle バージョンをダウンロードします。必要なのはインターネット接続だけです。

    Gradle DSL のデフォルトの Groovy のままにして、サンプルコードの追加オプションの選択を解除します。これは、独自のコードを最初から追加するためです。

  5. 基本的にプロジェクトの名前であるアーティファクト ID のデフォルト情報を使用し、グループ ID フィールドにデフォルト情報を残すことができます。

    作成をクリックします。

プロジェクトを作成し、インデックス作成が完了したら、中身を見てみましょう。

  • IntelliJ IDEA は、次のコードを含む build.gradle ファイルを使用してプロジェクトを作成します。

    plugins { id 'java' } group 'org.example' version '1.0-SNAPSHOT' repositories { mavenCentral() } dependencies { testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0' testImplementation 'org.junit.jupiter:junit-jupiter' } test { useJUnitPlatform() }

    ご覧のとおり、IntelliJ IDEA はテストの依存関係を便利に追加します。IntelliJ IDEA は、build.gradle ファイル内のコード補完をサポートします。依存関係をさらに追加することにした場合、IntelliJ IDEA はそれらの名前とバージョンをすばやく見つけます。

  • IntelliJ IDEA は、プロジェクトツールウィンドウに main および test サブディレクトリを含む src フォルダーも作成します。

    Gradle project view
  • IntelliJ IDEA は、お気に入りのプロジェクトとそのデフォルトタスクを備えた専用の Gradle ツールウィンドウを有効にします。このウィンドウを使用してタスクを実行します。

    Gradle tool window

    このウィンドウを閉じた場合は、メインメニューから表示 | ツールウィンドウ | Gradle を選択することでいつでもアクセスできます。

  • プロジェクトの Gradle 設定は、リンクされたプロジェクト、Gradle JVM、ビルドアクションに関する情報を格納するために使用されます。Gradle ツールウィンドウからすばやくアクセスできます(ツールバーの をクリックします)。

    the Gradle settings

    ご覧のとおり、ビルドアクションとテストアクションは Gradle に委譲されています。また、Gradle ラッパーを使用して、プロジェクトの Gradle を決定しました。

  • プロジェクト構造Ctrl+Alt+Shift+S)には、プロジェクトの JDK およびプロジェクトで使用される言語レベルに関する情報が含まれています。

    Project Structure

ステップ 2. Java コードを追加する

次に、最初の 100 個の FizzBuzz(英語) 番号を出力する Java アプリケーションを作成します。

Gradle プロジェクトに Java クラスを追加する

  1. プロジェクトツールウィンドウで、src フォルダーを開きます。

  2. main ディレクトリをクリックしてから、java サブディレクトリを右クリックし、リストから新規 | パッケージを選択します。

  3. 新規パッケージダイアログで、パッケージの名前 com.gradle.tutorial を入力しましょう。

  4. 次に、パッケージを右クリックして、新規 | Java クラスを選択します。

  5. 新規 Java クラスダイアログで、Java クラスの名前を指定して、OK をクリックします。この例では、FizzBuzzProcessor です。

    Create a new class dialog
  6. 次のコードをメイン FizzBuzzProcessor クラスに追加します。

    package org.mytest; public class FizzBuzzProcessor { public static void main(String[] args) { for (int i = 1; i <= 100; i++) { System.out.println(convert(i)); } } public static String convert(int fizzBuzz) { if (fizzBuzz % 15 == 0) { return "FizzBuzz"; } if (fizzBuzz % 3 == 0) { return "Fizz"; } if (fizzBuzz % 5 == 0) { return "Buzz"; } return String.valueOf(fizzBuzz); } }

アプリケーションの準備が整いました。それでは、それに必要なテストを作成しましょう。

テストクラスを作成する

  1. エディターでメインクラス FizzBuzzProcessor を開き、クラス名にキャレットを配置して Ctrl+Shift+T を押します。

  2. 開いたダイアログで、テストライブラリが JUnit5 であり、宛先パッケージが com.gradle.tutorial であることを確認しましょう。FizzBuzzTest という名前を追加し、残りのデフォルトオプションをそのままにして、OK をクリックします。

  3. 次に、作成したテストクラスを開き、次のコードを追加します。

    package org.mytest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.*; public class FizzBuzzTest { @Test public void FizzBuzzNormalNumbers() { FizzBuzzProcessor fb = new FizzBuzzProcessor(); Assertions.assertEquals("1", fb.convert(1)); Assertions.assertEquals("2", fb.convert(2)); } @Test public void FizzBuzzThreeNumbers() { FizzBuzzProcessor fb = new FizzBuzzProcessor(); Assertions.assertEquals("Fizz", fb.convert(3)); } @Test public void FizzBuzzFiveNumbers() { FizzBuzzProcessor fb = new FizzBuzzProcessor(); Assertions.assertEquals("Buzz", fb.convert(5)); } @Test public void FizzBuzzThreeAndFiveNumbers() { FizzBuzzProcessor fb = new FizzBuzzProcessor(); Assertions.assertEquals("FizzBuzz", fb.convert(15)); } }

ステップ 3. Gradle でアプリケーションを実行する

すぐにアプリケーションを実行して、機能するかどうか確認してみましょう。

エディターからメインクラスを実行する

  1. エディターでメインクラス FizzBuzzProcessor を開きます。

  2. ガターで、 をクリックし、実行 'FizzBuzzProcessor.main()' を選択します。

    Run application in Gradle
  3. 実行ツールウィンドウで結果を確認してください。

    Run tool window

ステップ 4. テストの実行

次に、作成したテストを実行してみましょう。

Gradle プロジェクトでテストを実行する

エディターから、または test タスクを使用して Gradle ツールウィンドウからテストを実行できます。エディターを使用します。

  • エディターのガターで をクリックします。

    Gradle Run test from the gutter

テストの結果は、実行ツールウィンドウに表示されます。

Run tool window /test passed

いずれかのテストでデフォルトの数を変更すると、失敗します。

Run tool window / test failed

ご覧のように、実行ツールウィンドウには、エラーが発生したコードの特定の行を含む、失敗したテストに関する情報が表示されます。

ステップ 5. 実行可能な JAR ファイルを作成する

次に、アプリケーションをビルドして、実行可能な JAR ファイルを作成します。

  1. プロジェクトツールウィンドウで、build.gradle ファイルをダブルクリックしてエディターで開きます。

  2. 次のコードを追加します。

    jar { manifest { attributes "Main-Class": "org.mytest.FizzBuzzProcessor" } from { configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } } }
  3. エディターで をクリックして、プロジェクトへの変更を同期します。

  4. Gradle ツールウィンドウでプロジェクトのノードを開き、次にタスクノードを開き、ビルドタスクをダブルクリックして実行します。

    Gradle tool window: build task

    IntelliJ IDEA は、JAR ファイルを含む build ディレクトリを作成します。

    Project tool window: build directory

    作成した JAR ファイルは、java -jar コマンドを使用してコマンドラインで実行できます。

  5. 実行ツールウィンドウで結果を確認します。

    Run tool window: build task

    ビルドタスクには、Gradle が実行するテストタスクが含まれていることに注意してください。テストの 1 つでミスをすると、テストタスクが失敗し、ビルドタスクも失敗します。

    Run tool window: build with failed test

ステップ 6. Gradle で JAR ファイルを実行する

次に、build.gradle ファイルをもう少し調整して、なんでも実行ウィンドウで JAR ファイルを実行できるようにします。

JAR ファイルを実行する

  1. プロジェクトツールウィンドウで、build.gradle ファイルをダブルクリックしてエディターで開きます。

  2. plugins セクションと次のコードに id 'application' を追加しましょう:

    application { mainClassName = 'org.mytest.FizzBuzzProcessor' }
  3. エディターで をクリックして、変更をプロジェクトにロードします。

  4. Gradle ツールウィンドウで、プロジェクトのノードを開き、次にタスクノードを開きます。Gradle がディストリビューションノードを追加したことがわかります。ノードを開き、assembleDist タスクをダブルクリックして実行します。

    ここで build ディレクトリを確認すると、IntelliJ IDEA が追加のディレクトリを作成したことがわかります。

    Project tool window: build directory
  5. Gradle ツールウィンドウで、ツールバーの Run anything をクリックします。

  6. 開いたウィンドウで、gradlew run コマンドを入力します。

    Run anything: gradlew run

    IntelliJ IDEA エディターでアプリケーションを実行したときと同じ結果になるはずです。

    Run tool window: run task output

    または、アプリケーションノードで実行タスクを実行することもできます。

    Gradle tool window: run task

関連ページ:

Gradle 設定

このページを使用して、作成、オープン、またはリンクされた Gradle プロジェクトの設定を構成します。Gradle ユーザーホームこのフィールドを使用して、Gradle のグローバル構成プロパティ、初期化スクリプト、キャッシュ、ログファイルなどを保存する場所を指定します。詳細については、Gradle のドキュメントを参照してください。デフォルトは $USER_HOME/.gradle に設定されています。次のいずれかの方法でオーバーライドできます。環境変数(たとえば、)を設定できます。詳細について...

プロジェクト構成設定

プロジェクト構造の設定は、他のプロジェクトファイルと共に .idea ディレクトリに .xml 形式で保存されます。これらの設定には、SDK、プロジェクトコンパイラーの出力パス、プロジェクト内のすべてのモジュールで使用可能なライブラリが含まれます。プロジェクト構造の設定を変更するには、ツールバーのをクリックし、プロジェクト構造を選択します。あるいは、に移動するか、を押します。プロジェクト SDK:SDK は、特定のソフトウェアフレームワーク用のアプリケーションを開発するために必要なツールのコレクション...

Gradle JVM の選択

Gradle プロジェクトを作成または開いたときに、プロジェクト内の Gradle JVM のバージョンが期待したものではない場合は、次の手順を確認して、IntelliJ IDEA が特定の Gradle JVM バージョンを選択する方法を確認できます。プロジェクトを作成しているとします。新しいプロジェクトの Gradle JVM バージョンを解決する JDK であるプロジェクト SDK を使用する場合、Gradle JVM はプロジェクトの SDK と同じになります。基本的に、Gradle JVM...

Java ライブラリを Maven リポジトリに公開する

このチュートリアルの目的は、Gradle プロジェクトで作成された Java ライブラリをローカル Maven リポジトリに公開し、次に IntelliJ IDEA を使用してリモートリポジトリに公開する方法を示すことです。Gradle プロジェクトの作成から始めましょう。新規 Gradle プロジェクトを作成するウェルカム画面で、新規プロジェクトを選択します。開始点が IntelliJ IDEA ですでに開かれているプロジェクトである場合は、メインメニューのに移動します。開いたページで、Gra...