IntelliJ IDEA 2020.1ヘルプ

Gradle プロジェクト

IntelliJ IDEAでは、Gradle(英語)プロジェクトを管理できます。リンク、プロジェクトの無視、プロファイルの操作、GradleプロジェクトとIntelliJ IDEAプロジェクトの変更の同期を行うことができます。Gradleコンポジットビルド、Gradleソースセット、ビルドおよび実行アクションを構成することもできます。

  1. Gradleツールウィンドウで、リンクされたプロジェクトを右クリックします。

  2. コンテキストメニューからGradle 構成を開く F4を選択します。

    IntelliJ IDEAが適切なGradle設定ファイルにナビゲートし、関連する build.gradle ファイルがエディターで開きます。

リンクされたGradleプロジェクトのリンクを解除する

Gradleプロジェクトのリンクを解除すると、IntelliJ IDEAは関連するすべてのモジュールとコンテンツ・ルートを削除し、GradleツールウィンドウからGradleプロジェクトを削除してその同期を停止します。現在のIntelliJ IDEAプロジェクトから以前にリンクされたGradleプロジェクトを完全に削除する必要がある場合、役に立つかもしれません。

  1. Gradleツールウィンドウで、リンクされたプロジェクトを右クリックします。

  2. コンテキストメニューからGradle プロジェクトのリンク解除Delete )を選択します。あるいは、リンクされたプロジェクトを選択してツールウィンドウのツールバーの the Remove icon をクリックすることもできます。

  3. IntelliJ IDEA プロジェクトツールウィンドウからプロジェクトを削除したくない場合は、Gradle プロジェクトのインポートポップアップで、モジュールに対するチェックボックスをオフにします。

  4. OKをクリックします。

    プロジェクトをリンクバックする必要がある場合は、プロジェクトツールウィンドウでプロジェクトの build.gradle ファイルを右クリックするか、Kotlinプロジェクトの場合は build.gradle.kts を選択し、Gradle プロジェクトのインポートを選択します。

Gradleプロジェクトを無視する

Gradle プロジェクトを無視オプションを使用してGradleプロジェクトを無効にすることができます。この場合、IntelliJ IDEAは無視されたGradleプロジェクトとサブプロジェクトをGradleツールウィンドウに保持しますが、プロジェクトへのインポート(モジュール、コンテンツ・ルート、タスクなど)を停止します。ただし、IntelliJ IDEAは無視されたプロジェクトを現在のプロジェクトと同期します。 buildSrcのような無関係なサブプロジェクトをスキップする必要がある場合に役立ちます。

  1. Gradleツールウィンドウで、無視するプロジェクトを右クリックします。

  2. コンテキストメニューから、Gradle プロジェクトを無視を選択します。

  3. 開いたウィンドウで、非アクティブ化するプロジェクトとモジュールを選択し、OKをクリックします。

Gradleプロジェクトまたはモジュールをアクティブにする場合は、コンテキストメニューからGradleプロジェクトを無視するを選択します。

非階層モジュール

孤立モジュールは、次の場合にインポートプロセス中に削除されたIDEモジュールです。

  • build.gradle ファイルのモジュールを手動で削除してから、プロジェクトを再インポートしたとき。

  • Gradleツールウィンドウのモジュールでプロジェクトを無視アクションを使用してから、プロジェクトを再インポートしたとき。

これらのすべての場合において、IntelliJ IDEAは削除されたモジュールを復元するようプロンプトを出します。

Orphan modules notification

非階層モジュールダイアログで復元したいものを選択できます。

Orphan modules dialog

通常、これらはIDEモジュール設定を含む .iml ファイルのみであるため、モジュールを復元する必要はありません。内部で指定されたユーザー定義の設定がある場合にのみ、復元することができます。

リンクされたGradleプロジェクトを再インポートする

Gradleプロジェクトを開くと、同期は自動的に行われます。また、IntelliJ IDEAがVCSの更新やIDEの外部で行われた一部の編集など、ビルドスクリプトに対する外部の変更を検出すると、関連するプロジェクトが自動的に再インポートされます。

必要に応じて、プロジェクトの同期を手動でトリガーできます。

  1. Gradleツールウィンドウで、リンクされたプロジェクトを右クリックします。

  2. コンテキストメニューからGradle プロジェクトの再インポート the Reimport iconを選択します。

    このアクションを呼び出すと、IntelliJ IDEAはGradleツールウィンドウのプロジェクト構造を解析します。

    IntelliJ IDEAはあなたのプロジェクトの一部だけを再インポートすることはできません。それはモジュールと依存関係を含むプロジェクト全体を再インポートします。

    プロジェクト構造ダイアログ(メインメニューから the Project Structure buttonをクリック)で依存関係を設定した場合、依存関係はGradleツールウィンドウではなく、IntelliJ IDEA プロジェクトツールウィンドウにのみ表示されます。次回プロジェクトを再インポートするとき、IntelliJ IDEAはGradle構成を唯一の実態源と見なすため、IntelliJ IDEAは追加された依存関係を削除します。

  3. ステータスバーの the Build icon をクリックして、ビルドツールウィンドウに同期の結果を表示します。

エディターでGradleビルドスクリプトを手動で変更するたびに、変更をロードする必要があります。IntelliJ IDEAは、プロジェクトのGradleの変更をロードCtrl+Shift+O)を提案する通知アイコンをエディターの右側に表示します。

Editor: build.gradle

VCSの変更とIDE外のビルドファイルに加えられた変更は、自動的に再ロードされます。これらの変更のリロードプロセスを手動で制御する必要がある場合は、Gradleツールウィンドウにある Auto-reload external changes オプションを無効にします。

Gradleコンポジットビルドの構成

コンポジットビルドの設定を始める前に、Gradleバージョン3.1以降がプロジェクト用に設定されていることを確認してください。

settings.gradle ファイルを使用して、Gradleコンポジットビルド(英語)にGradleビルドを含めることができます。

  1. エディターで settings.gradle ファイルを開きます。

  2. includeBuild コマンドを使用して、依存関係としてプロジェクトに追加するビルドの場所を指定します。

Gradleツールウィンドウを使用してコンポジットビルドを構成することもできます。

  1. Gradleプロジェクトを開きます。

  2. リンク複合ビルドに使用したい他のGradleプロジェクト。

  3. Gradleツールウィンドウでメインプロジェクトを右クリックし、コンテキストメニューからコンポジット・ビルド構成を選択します。

  4. Gradle プロジェクト・ビルド・コンポジットダイアログで、Gradleコンポジットビルドに含めるプロジェクトを選択します。

  5. 再インポートあなたのメインGradleプロジェクト。

    IntelliJ IDEAは、付属のGradleプロジェクトを見つけ、IntelliJ IDEAモジュールとして扱います。

Gradleソースセットを使用する

IntelliJ IDEAでは、Gradleプロジェクトの解決にGradleソースセット(英語)を使用できます。ソースセットは、IntelliJ IDEAプロジェクトのモジュールとして扱われます。カスタムソースセットを宣言すると、IntelliJ IDEAはモジュールをプロジェクトに追加します。

Gradleプロジェクトを作成すると、IntelliJ IDEAは自動的にメインテストの 2つのソースセットを含むメインソース・セットディレクトリを作成します。テストソースをコンパイルするためには、メインソースセットへの依存関係があります。

Gradle tool window: source set

カスタムソースセットを追加する

  1. エディターで gradle.build ファイルを開きます。

  2. カスタムソースセットを宣言します(この例ではapiです)。

    sourceSets { api } dependencies { compile sourceSets.api.output }
    (このソースセットには、実装のないインターフェースが含まれています。インターフェースの実装は、デフォルトのメインソースセットにあります。)

  3. Gradleツールウィンドウを開いて、IntelliJ IDEAが api ソースセットを追加したことを確認します。

    Gradle tool window: api Source Set
    テストソースセットには適切な依存関係が含まれています。デフォルトのメインソースセットは、apiソースセットの出力にコンパイル依存関係があることに注意してください。メインソースセットのソースをコンパイルすると、Gradleは自動的に apiClasses タスクを起動します。
    Gradle tool window: compile dependency

  4. メインメニューから、ファイル、プロジェクト構造を開くには、プロジェクト構造 Ctrl+Shift+Alt+S。すべてのソースセットは、単一のモジュールにグループ化された個別のモジュールとして表されることに注意してください。

    Project Structure dialog / Module page
    テストモジュールをクリックして依存関係タブを選択すると、ソースセットの依存関係のリストが表示されます。
    Project Structure dialog / Dependencies tab

カスタムテストにソースセットを使用する

カスタムテストを追加して、ソースセット機能を使用してメインテストとは別に実行することができます。

  1. カスタムソースセットを宣言するのと同じ方法でソースセットを宣言します。ソースセットの名前のほかに、宣言されたテストを実行する出力ディレクトリとタスクを指定します。例:統合テスト integrationTestを宣言します。

    sourceSets { integrationTest { java { srcDir 'src/integrationtest/java' } resources { srcDir 'src/integrationtest/resources' } compileClasspath += sourceSets.main.runtimeClasspath } } task integrationTest(type: Test) { description = "Runs Integration Tests" testClassesDirs = sourceSets.integrationTest.output.classesDirs classpath += sourceSets.integrationTest.runtimeClasspath }

  2. Gradleツールウィンドウで、タスク | その他をクリックします。

  3. 表示されたリストで、integrationTest をダブルクリックして実行します。

    Gradle tool window: tasks

Gradleプロジェクトにパッケージプレフィックスを追加する

Gradleプロジェクトでパッケージプレフィックスを使用する場合は、build.gradle ファイルで指定します。そうすれば、プロジェクトを再インポートしたときにすべてが保存されます。

詳しくは、https://github.com/JetBrains/gradle-idea-ext-plugin(英語)を参照してください。

  1. build.gradle ファイルを開きます。

  2. パッケージの接頭辞をサポートするために次のプラグインを追加します。

    plugins { id "org.jetbrains.gradle.plugin.idea-ext" version "0.5" }

  3. パッケージプレフィックスを追加します。例:次の一連のソースセットがあります。

    sourceSets { main.java.srcDirs = [] main.java.srcDirs += "src" main.java.srcDirs += "src/main/java" main.java.srcDirs += "../other-root/src/main/java" }
    次のコードを使用して、パッケージ接頭辞(この場合は「org.example」)を追加します。
    idea { module { settings { packagePrefix["src"] = "org.example" packagePrefix["src/main/java"] = "org.example" packagePrefix["../other-root/src/main/java"] = "org.example" } } }

  4. 変更を再インポートするか、auto-importを使用してください。

build.gradleファイルでIDE固有の設定を指定する

gradle-idea-ext(英語)プラグインを使用すると、プロジェクトのエンコーディングなどのプロジェクト設定、および build.gradle ファイル内のプロパティファイルのエンコーディングを記述できます。

  1. build.gradle ファイルを開きます。

  2. エンコーディング設定をサポートするために次のプラグインを追加します。

    plugins { id "org.jetbrains.gradle.plugin.idea-ext" version "0.5" }

  3. 次のコードでプロジェクトのエンコーディングを記述してください。
    import org.jetbrains.gradle.ext.EncodingConfiguration.BomPolicy idea { project { settings { encodings { encoding = 'windows-1251' bomPolicy = BomPolicy.WITH_NO_BOM properties { encoding = '<System Default>' transparentNativeToAsciiConversion = false } mapping['../sample-gradle-free/module'] = 'windows-1251' mapping['module'] = 'windows-1251' mapping['module2/src/main/java'] = 'windows-1251' } } } }
  4. 変更を再インポートするか、auto-importを使用してください。

buildSrcを使用する

複数のJava、Groovy、またはKotlinクラスを含む大きなGradleスクリプトがある場合、そのようなクラスをbuildSrc(英語)ディレクトリに移動し、メインGradleスクリプトから参照できます。この場合、build.gradle ファイルの可読性を確保します。

  1. buildSrcがない場合は、それをGradle モジュールとしてメインプロジェクトに追加します。

    Project tool window: buildSrc module

  2. エディターでメインの build.gradle ファイルを開き、必要なクラスをbuildSrcディレクトリのメインサブディレクトリに移動します。

    Project tool window: buildSrc

  3. プロジェクトの build.gradle ファイルからタスクを実行します。

    gradle main build file

ビルドおよび実行アクションを構成する

デフォルトでは、IntelliJ IDEAはプロジェクトの構築と実行にGradleを使用します。

プロジェクト(ビルド | プロジェクトのビルド)をビルドすると、IntelliJ IDEAはGradleを使用して対応するタスクを呼び出します。Gradleは、実行メニューから実行およびデバッグアクションも実行します。ホットスワップもトリガされ、デバッグプロセス中にクラスがリロードされます。

リンクプロジェクトがある場合は、各リンクプロジェクトのビルド方法を設定できます。

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、ビルド、実行、デプロイ | Gradleに移動します。

  2. Gradle設定ページのGradle プロジェクトセクションで、必要なGradleプロジェクトを選択します。

  3. ビルドおよび実行に使用リストで適切なオプションを選択し、OKをクリックして変更を保存します。

IntelliJ IDEAを使用してGradleプロジェクトをビルドする場合は、明示的に指定する必要があります。

IntelliJ IDEAにビルドを委譲する

純粋なJavaまたはKotlinプロジェクトを構築するためにIntelliJ IDEAを使用すると便利かもしれません。IntelliJ IDEAはインクリメンタルビルドをサポートしているため、ビルドプロセスをスピードアップできます。ただし、IntelliJ IDEAコンパイラはGradleプロジェクトビルド処理の一部をサポートしていないため、プロジェクトを正しくビルドする際に問題が生じる可能性があります。

  1. Gradleツールウィンドウで Gradle settings をクリックします。あるいは、メインメニューからファイル | 設定/環境設定 | ビルド、実行、デプロイ | ビルド・ツール | Gradleを選択します。

  2. Gradleページで、ビルドおよび実行に使用リストからIntellij IDEAを選択します。

    the Gradle settings
    テストを使用して実行するオプションはアクティブのままであり、すべてのビルドおよび実行アクションをIntelliJ IDEAに委譲した場合でも、テストの実行方法を選択できることに注意してください。

  3. OKをクリックします。

Gradleプロジェクトをビルドすると、IntelliJ IDEAでビルドされます。

最終更新日: 2020年6月29日

関連ページ:

Gradle

IntelliJ IDEAは、構築プロセスの自動化に役立つGradleとの完全な機能統合をサポートしています。新しいGradleプロジェクトを簡単に作成し、既存のプロジェクトを開いて同期し、複数のリンクされたプロジェクトを同時に操作し、管理できます。新規 Gradle プロジェクトを作成します新規プ...

Maven プロファイル

IntelliJ IDEAでは、本番や開発などの特定の環境のビルドをカスタマイズするのに役立つMavenビルドプロファイルを使用できます。Mavenプロファイルを宣言する:IntelliJ IDEAでは、プロジェクトのPOMでプロファイルを明示的に宣言できます。コード補完を使用すると、タグ内にいくつ...

ビルドツールウィンドウ

ビルドツールウィンドウは、MavenまたはGradleに委譲されたビルドの出力、およびプロジェクトの同期の結果を表示できます。ビルド出力タブ:IntelliJ IDEAはビルドの結果をビルド出力タブに表示します。プロジェクトに応じて、ビルド出力には、実行されたタスク、ゴール、コマンド、および生成され...

Gradleツールウィンドウ

Gradleプロジェクトを作成または開くと、Gradleツールウィンドウが自動的に有効になります。右側のサイドバーのGradleをクリックして、ツールウィンドウを開きます。ツールウィンドウには、Gradleリンクプロジェクト、そのタスク、依存関係、および基になるbuild.gradleファイルに加え...

ホットスワップ

このタブを使用して、ホットスワップメカニズムの動作を管理します。Java:このセクションでは、HotSwap for Javaの動作を指定します。クラスをリロードする前にプロジェクトを作るこのオプションは、の動作の動作を制御します。これが有効になっている場合、変更されたクラスを検索して再ロードする前...

注釈プロセッサを構成する

コンパイル時にカスタム注釈を処理するようにIntelliJ IDEAを構成できます。注釈を処理するためにコンパイル時にコードを生成するプロセスは、注釈処理と呼ばれます。注釈プロセッサは、注釈に基づいてコードを検証、生成、および変更できます。これにより、記述する必要のあるコードの量を大幅に削減できます...