VS Codeのエージェントモードを拡張するには、を試してください！

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 コマンドの実行、ビルドライフサイクルとプラグインのゴール実行を可能にします。Extension Pack for Java のインストールをお勧めします。これには Maven サポートとその他の重要な Java 開発機能が含まれています。

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

Maven プロジェクトを探索する

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

Maven Explorer

不明な型を解決する

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

POM.xml の操作

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

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

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

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

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

Maven コマンドとゴールを実行する

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

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

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

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

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

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

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

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

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

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

  1. Maven エクスプローラーから、+ Create Maven Project ボタンを選択します。

    Create Maven Project

  2. コマンドパレット (⇧⌘P (Windows、Linux Ctrl+Shift+P)) を開き、Create Java Project コマンドを検索します。

  3. ターゲットフォルダーを右クリックし、Create Maven Project を選択します。

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 のビルド出力は、Build Server for Gradle (Build) 出力チャンネルで表示でき、VS Code と Gradle ビルドサーバー間のやり取りは、Build Server for Gradle (Log) 出力チャンネルで追跡できます。

Gradle へのテスト委任

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

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

Gradle タスクの操作

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

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

Gradle 依存関係の表示

Gradle Projects ビューでは、各 Gradle プロジェクト項目の下にDependencies項目があります。これには、指定された構成のすべての依存関係が含まれており、プロジェクトの依存関係の状態を簡単に確認できます。

Gradle Dependencies

Gradle デーモンの管理

Gradle Daemons ビューには、現在のワークスペースのデーモンの状態が表示されます。ワークスペースと同じバージョンの実行中の Gradle デーモンがすべて一覧表示されます。このビューで、特定のデーモンまたはすべてのデーモンを停止することを選択できます。

ビルドファイルの作成

この拡張機能は、Gradle ビルドファイルに関するいくつかの便利な作成機能を提供します。

Groovy Gradle ファイルを開くと、拡張機能は Gradle ファイルを分析し、セマンティックトークン情報を提供することで、より正確な強調表示結果を提供します。

Gradle Highlighting

アウトラインビューでは、拡張機能は開いている Gradle ファイルのドキュメントシンボルを提供し、ファイルの任意の場所に簡単に移動できるようにします。

Gradle Outline

開いている Gradle ファイルに構文エラー (文字の欠落、型が見つからないなど) がある場合、それらは問題ビューで見つけることができます。

Gradle Problems

この拡張機能は、Gradle ファイルの基本的なオートコンプリートをサポートしており、Gradle スクリプトで Gradle クロージャーまたはプロパティを入力しようとすると、拡張機能が利用可能なクロージャーまたはプロパティを提案します。

新しい依存関係を宣言しようとすると、拡張機能が依存関係候補リストを提供します。

追加リソース

Maven 拡張機能の GitHub リポジトリで、追加の構成とトラブルシューティングガイドをご覧ください。

Maven に加えて、Bazel を使用してプロジェクトをビルドおよびテストする場合に備えて、Bazel 拡張機能もあります。

次のステップ

詳細はこちら

  • Java の編集 - VS Code での Java の編集機能について説明します。
  • Java のデバッグ - VS Code で Java プロジェクトをデバッグする方法について説明します。
  • Java のテスト - VS Code を使用して JUnit および TestNG ケースを処理します。
  • Java拡張機能 - VS Code向けのさらに便利なJava拡張機能について学びます。
12/10/2021