VS Code における Java ビルドツール
このドキュメントでは、Visual Studio Code で Java ビルドツールを使用する方法の概要を説明します。Maven for Java および Gradle for Java 拡張機能と、その他のツールについて説明します。
以下の機能を使用する際に問題が発生した場合は、issue を登録してご連絡ください。
Maven
Maven は、Java プロジェクトの管理とアプリケーションビルドの自動化を支援するソフトウェアツールです。Visual Studio Code 用の Maven for Java 拡張機能は、Maven を完全に統合的にサポートしており、Maven プロジェクトの探索、Maven コマンドの実行、ビルドライフサイクルとプラグインの目標の実行を可能にします。Extension Pack for Java をインストールすることをお勧めします。これには、Maven のサポートとその他の重要な Java 開発機能が含まれています。
Extension Pack for Java をインストールする
Maven プロジェクトの探索
Maven プロジェクトがロードされると、拡張機能がアクティブになり、ワークスペース内の pom.xml ファイルを自動的にスキャンし、すべての Maven プロジェクトとそのモジュールをサイドバーに表示します。
不明な型の解決
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 プロジェクトを生成することです。拡張機能は、ローカル/リモートカタログにリストされているアーキタイプをロードします。選択後、拡張機能は 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 タスクを実行するのと同じように一貫したプロジェクト出力を保証します。
- ビジュアルインターフェース: VS Code 内で Gradle タスクとプロジェクトの依存関係を表示および管理し、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 タスクの操作
VS Code で Gradle プロジェクトを開くと、Gradle サイドバー項目をクリックして、いくつかの便利な Gradle ビューを見つけることができます。[Gradle プロジェクト] ビューには、ワークスペースで見つかったすべての Gradle プロジェクトがリストされます。ここでは、Gradle タスクを表示、実行、またはデバッグできます。
ワークスペースに多数の Gradle タスクがある場合、特定のタスクを見つけるのが難しい場合があります。この拡張機能は、[ピン留めされたタスク] ビューを提供して、お気に入りのタスクをピン留めして、別のビューで簡単に見つけられるようにします。[最近実行したタスク] ビューで、最近実行したタスクを確認することもできます。
Gradle 依存関係の表示
[Gradle プロジェクト] ビューでは、各 Gradle プロジェクト項目の下に [依存関係] 項目があります。これには、指定した構成のすべての依存関係が含まれており、プロジェクトの依存関係の状態を簡単に確認できます。
Gradle デーモンの管理
[Gradle デーモン] ビューには、現在のワークスペースのデーモンの状態が表示されます。ワークスペースと同じバージョンの実行中のすべての Gradle デーモンがリストされます。このビューで、特定のデーモンまたはすべてのデーモンを停止することを選択できます。
ビルドファイルのオーサリング
この拡張機能は、Gradle ビルドファイルに関するいくつかの便利なオーサリング機能を提供します。
Groovy Gradle ファイルを開くと、拡張機能は Gradle ファイルを分析し、セマンティックトークン情報を提供し、より正確な強調表示結果を提供します。
[アウトライン] ビューでは、拡張機能は開いている Gradle ファイルのドキュメントシンボルを提供し、ファイルの任意の部分に簡単に移動するのに役立ちます。
開いている Gradle ファイルに構文エラー (文字の欠落、型が見つからないなど) がある場合は、[問題] ビューで確認できます。
拡張機能は、Gradle ファイルの基本的なオートコンプリートをサポートしています。Gradle スクリプトで Gradle クロージャーまたはプロパティを入力しようとすると、拡張機能は利用可能なクロージャーまたはプロパティを提案します。
新しい依存関係を宣言しようとすると、拡張機能は依存関係の候補リストを提供します。
追加リソース
Maven 拡張機能の GitHub リポジトリ にアクセスして、追加の 構成 と トラブルシューティングガイド を参照してください。
Maven に加えて、Bazel を使用してプロジェクトをビルドおよびテストする場合は、Bazel 拡張機能 もあります。
次のステップ
詳細については、以下をお読みください。