💻 6月3日の MS Build で開催される VS Code Live に参加しましょう。

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 コマンドの実行、ビルドライフサイクルとプラグインの目標の実行を可能にします。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 に新しい依存関係を追加するのがいかに簡単かをご覧ください。

この拡張機能は、Effective POM の生成も可能にします。

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

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

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

Maven コマンドと目標を実行する

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

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

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

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

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

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

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

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

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

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

  1. Maven エクスプローラーから、+ Maven プロジェクトの作成 ボタンを選択します。

    Create Maven Project

  2. コマンドパレット (⇧⌘P (Windows、Linux Ctrl+Shift+P)) を開き、Java プロジェクトの作成 コマンドを検索します。

  3. ターゲットフォルダーを右クリックし、Maven プロジェクトの作成 を選択します。

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 に委任することをサポートしています。Testing Explorer で使用するテストプロファイルを構成できます。

注: この機能を使用するには、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

Outline ビューでは、この拡張機能は開いている Gradle ファイルのドキュメントシンボルを提供し、ファイルの任意の部分に簡単に移動するのに役立ちます。

Gradle Outline

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

Gradle Problems

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

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

追加リソース

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

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

次のステップ

詳細については、以下をご覧ください

  • Java の編集 - VS Code での Java の編集機能について説明します。
  • Java のデバッグ - VS Code で Java プロジェクトをデバッグする方法について説明します。
  • Java のテスト - JUnit および TestNG ケースに VS Code を使用します。
  • Java 拡張機能 - VS Code 用のその他の便利な Java 拡張機能について学びます。
12/10/2021
© . This site is unofficial and not affiliated with Microsoft.