vscodeでJava Mavenを設定

はじめに

Java環境を手軽に構築したいと思ったので、vscodeでmavenを設定しました。
Javaを触りたいけど環境構築がわからず、挫折しかけている人の助けになればと思います。

また、pom.xmlにlog4j2ライブラリを設定して、ログを出力する方法も記載しています。
せっかく環境を構築したのに動かさないのはもったいないと思うので、ぜひログ出力して構築した環境を試してみてください。

※ 本記事はmacOSでの手順となります。Windowsの方は若干手順が異なるためご注意ください。

mavenのインストール手順

• 以下にアクセスをして、ファイルをダウンロードしてください
  https://maven.apache.org/

• ~/.zshrcに以下を追記して、PATHを通します

% cat << EOF >> ~/.zshrc
heredoc> export PATH=$PATH:~/apache-maven-3.9.2/bin
heredoc> EOF
% . ~/.zshrc

• 以下でmavenがインストールされていることを確認してください

% mvn -version
Apache Maven 3.9.2 (c9616018c7a021c1c39be70fb2843d6f5f9b8a1c)
Maven home: /Users/***/apache-maven-3.9.2
Java version: 17.0.7, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
Default locale: ja_JP, platform encoding: UTF-8
OS name: "mac os x", version: "13.4", arch: "aarch64", family: "mac"

vscodeの設定手順

vscodeの拡張機能で「Extension Pack for Java」をインストールしてください。

mavenプロジェクトの作成

• 以下を実行してmavenプロジェクトを作成します。

mvn archetype:generate

• vscodeで作成したプロジェクトを開けば、すでにmavenが設定されています。
  

pom.xmlにlog4j2を設定する

• 以下をpom.xmlに追加します。

  <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.20.0</version>
  </dependency>
  <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.20.0</version>
  </dependency>

• 以下のコードでログを出力してみます。

package com.example;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class App {    
    public static void main(String[] args) {
        Logger logger = LogManager.getLogger();
        // ログメッセージの出力
        logger.info("info message.");
        logger.trace("trace message.");
        logger.debug("debug message.");
        logger.warn("warning message.");
        logger.error("error message.");

        // 変数をログに埋め込む例
        String greeting = "hello";
        String world = "world";
        logger.info("'{}', '{}'", greeting, world);
    }
}

• 実行結果

23:58:13.368 [main] INFO  com.example.App - info message.
23:58:13.369 [main] DEBUG com.example.App - debug message.
23:58:13.369 [main] WARN  com.example.App - warning message.
23:58:13.369 [main] ERROR com.example.App - error message.
23:58:13.372 [main] INFO  com.example.App - 'hello', 'world'

※ log4j2.xmlを適切に設定して、src/main/resourcesに配置してください