編集

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 を検索することもサポートしています。これは、ホバー時に表示される Resolve unknown type リンクを選択することで実行できます。

POM.xml の操作

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

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

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

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

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

Maven コマンドとゴールの実行

エクスプローラーで各 Maven プロジェクトを右クリックすることで、Maven のゴールを簡単に実行できます。

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

ゴールを再実行するには 2 つの方法があります

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

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

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

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

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

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

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

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

Gradle

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

Gradle Build Server: Gradle Build Server は、Gradle プロジェクトをインポートし、ビルドタスクを Gradle デーモンに委譲するために使用され、コマンドラインから Gradle タスクを実行した場合と同じように一貫したプロジェクト出力を保証します。
ビジュアルインターフェイス: Gradle タスクとプロジェクトの依存関係を表示および管理し、VS Code 内で直接 Gradle タスクを実行できます。
Gradle Language Server: 構文のハイライト、エラー報告、オートコンプリートなど、Gradle ビルドファイルの作成エクスペリエンスを向上させます。

Gradle Build Server

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

Gradle ビルドの出力は Build Server for Gradle (Build) 出力チャネルで確認でき、VS Code と Gradle Build Server 間のやり取りは Build Server for Gradle (Log) 出力チャネルでトレースできます。

テストを Gradle に委譲する

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

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

Gradle タスクの操作

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

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