編集

VS Code の Java ビルドツール

このドキュメントは、Visual Studio Code で Java ビルドツールを操作する方法の概要です。これには、Maven for Java および Gradle for Java 拡張機能、およびその他のツールが含まれます。

以下の機能の使用中に問題が発生した場合は、イシューを登録してご連絡ください。

Maven

Maven は、Java プロジェクトの管理とアプリケーションビルドの自動化に役立つソフトウェアツールです。Visual Studio Code 用の Maven for Java 拡張機能は、完全に統合された Maven サポートを提供し、Maven プロジェクトの探索、Maven コマンドの実行、ビルドライフサイクルとプラグインの目標の実行を可能にします。Maven サポートおよびその他の重要な Java 開発機能を含む Extension Pack for Java のインストールをお勧めします。

Extension Pack for Javaをインストールする

Maven プロジェクトの探索

Maven プロジェクトが読み込まれると、拡張機能がアクティブ化され、ワークスペース内の pom.xml ファイルが自動的にスキャンされ、すべての Maven プロジェクトとそのモジュールがサイドバーに表示されます。

Maven Explorer

不明な型の解決

Maven 拡張機能は、ソースコード内の不明な型を解決するために Maven Central の検索もサポートしています。これは、ホバー時に表示される不明な型を解決リンクを選択することで実行できます。

POM.xml の操作

この拡張機能は、ローカルの Maven リポジトリに基づいて Maven 依存関係を追加するためのコードスニペットと自動補完を提供します。これらの便利な機能で pom.xml に新しい依存関係を簡単に追加できる方法をご覧ください。

この拡張機能は、有効な POM を生成することもできます。

コマンド Maven: 依存関係を追加 (または maven.project.addDependency) を使用して、pom.xml に新しい依存関係を追加することもできます。プロセスは対話型です。

プロジェクトビューから依存関係を追加することもでき、同じ Maven コマンドが呼び出されます。

さらに、VS Code は依存関係をツリービューで表示することもサポートしており、プロジェクト内のすべての依存関係を 1 か所で検査し、潜在的な問題を確認することができます。

Maven コマンドと目標の実行

エクスプローラーで各 Maven プロジェクトを右クリックすると、Maven の目標を便利に実行できます。

この拡張機能は、各プロジェクトの目標の履歴も保持するため、以前のコマンドをすばやく再実行できます。これは、長いカスタム目標を実行している場合に便利です。

目標を再実行する方法は 2 つあります

コマンドパレットで、Maven: 履歴を実行し、プロジェクトとその履歴からコマンドを選択します。
プロジェクトを右クリックし、履歴を選択します。次に、履歴から以前のコマンドを選択できます。

今後の実行のために、設定でお気に入りのコマンドを指定することもできます。

プロジェクトで使用する各プラグインについて、この拡張機能は、各プラグイン内の目標に簡単にアクセスする方法も提供します。

Maven の目標をデバッグするには、目標を右クリックしてデバッグを開始します。Maven 拡張機能は、適切なパラメーターで Java デバッガーを呼び出します。これは、時間を節約できる便利な機能です。

Maven Archetype からプロジェクトを生成

この拡張機能が提供するもう 1 つの便利な機能は、Archetype から Maven プロジェクトを生成することです。この拡張機能は、ローカル/リモートカタログにリストされている Archetype を読み込みます。選択後、拡張機能は mvn archetype:generate -D... をターミナルに送信します。

Maven プロジェクトを作成する方法はいくつかあります。

Maven エクスプローラーから、+ Maven プロジェクトを作成ボタンを選択します。
コマンドパレット (⇧⌘P (Windows, Linux Ctrl+Shift+P)) を開き、Java プロジェクトを作成コマンドを検索します。
ターゲットフォルダーを右クリックし、Maven プロジェクトを作成を選択します。

Gradle

VS Code は、Gradle for Java 拡張機能を通じて Gradle Java プロジェクト (Android を除く) をサポートしています。この拡張機能は、Gradle Java プロジェクトのエクスペリエンスを向上させるためのいくつかのコンポーネントを提供します。

Gradle ビルドサーバー: Gradle ビルドサーバーは、Gradle プロジェクトをインポートし、ビルドタスクを Gradle デーモンに委任するために使用されます。これにより、コマンドラインから Gradle タスクを実行した場合と同じように、一貫したプロジェクト出力が保証されます。
視覚インターフェイス: Gradle タスクとプロジェクトの依存関係を表示および管理し、VS Code 内で直接 Gradle タスクを実行できます。
Gradle 言語サーバー: 構文の強調表示、エラー報告、自動補完など、Gradle ビルドファイルの作成エクスペリエンスを向上させます。

Gradle ビルドサーバー

既定では、Gradle for Java 拡張機能をインストールしている場合、Gradle ビルドサーバーを使用して Gradle プロジェクトをインポートします。java.gradle.buildServer.enabled を設定することで、Gradle ビルドサーバーのオン/オフを切り替えることができます。

Gradle ビルド出力は Gradle 用ビルドサーバー (ビルド) 出力チャネルで表示でき、VS Code と Gradle ビルドサーバー間の相互作用は Gradle 用ビルドサーバー (ログ) 出力チャネルでトレースできます。

テストを Gradle に委任

この拡張機能は、テスト実行を Gradle に委任することをサポートしています。テストエクスプローラーで使用したいテストプロファイルを構成できます。

注: この機能を使用するには、Test Runner for Java 拡張機能をインストールしていることを確認してください。

Gradle タスクの操作

VSCode で Gradle プロジェクトを開くと、Gradle サイドバー項目をクリックすることで、いくつかの便利な Gradle ビューを見つけることができます。Gradle プロジェクト ビューには、ワークスペースで見つかったすべての Gradle プロジェクトが一覧表示されます。ここで Gradle タスクを表示、実行、またはデバッグできます。

ワークスペースに多数の Gradle タスクがある場合、特定のタスクを見つけるのは難しいかもしれません。この拡張機能は、お気に入りのタスクをピン留めできるピン留めされたタスク ビューを提供し、別のビューで簡単に見つけられるようにします。最近のタスク ビューで最近実行されたタスクも確認できます。