Konfiguracja

Zależności

Dodajemy log4j-core w wersji 2.x (1.x jest niewspierana)

<dependencies>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.8.2</version>
    </dependency>
</dependencies>

<groupId>org.apache.logging.log4j</groupId>

</dependency>

</dependencies>

Ustawiamy odpowiednią wersję kompilatora:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

<build>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-compiler-plugin</artifactId>

</configuration>

</plugin>

</plugins>

</build>

Plik konfiguracyjny

W katologu Resources umieszczamy log4j2.xml

Jest skonfigurowany tak by wyświetlał informacje w konsoli oraz zapisywał je do pliku (to są dwa oddzielnie skonfigurowane zadania).

&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;Configuration status="WARN"&gt;
    &lt;Appenders&gt; //zdefiniowanie nowych loggerów
        &lt;Console name="Console" target="SYSTEM_OUT"&gt; //wyświetlanie logów w konsoli
            &lt;PatternLayout pattern="%d{HH:mm:ss.SSS} [%t]
      %highlight{%level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green, DEBUG=blue} - %msg%n" /&gt;
        &lt;/Console&gt;
         &lt;RollingFile name="RollingFileAppender" fileName="logs/app.log" //zapisywanie logów do pliku
                     filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log"&gt;
            &lt;PatternLayout&gt;
                &lt;Pattern&gt;%d [%t] %p %c - %m%n&lt;/Pattern&gt;
            &lt;/PatternLayout&gt;
            &lt;Policies&gt;
                &lt;OnStartupTriggeringPolicy /&gt;
                &lt;TimeBasedTriggeringPolicy /&gt;
                &lt;SizeBasedTriggeringPolicy size="50 MB" /&gt;
            &lt;/Policies&gt;
            &lt;DefaultRolloverStrategy max="20" /&gt;
        &lt;/RollingFile&gt;
    &lt;/Appenders&gt;

    &lt;Loggers&gt; //lista włączonych loggerów
        &lt;Root level="DEBUG"&gt;  //określamy poziom logowania
            &lt;AppenderRef ref="RollingFileAppender"/&gt;  //podajemy id zdefiniowane w sekcji Appenders
        &lt;/Root&gt;
        &lt;Root level="DEBUG"&gt;
            &lt;AppenderRef ref="Console"/&gt;
        &lt;/Root&gt;
    &lt;/Loggers&gt;
&lt;/Configuration&gt;

<?xml version="1.0" encoding="UTF-8"?>

<Appenders> //zdefiniowanie nowych loggerów

<Console name="Console" target="SYSTEM_OUT"> //wyświetlanie logów w konsoli

<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t]

%highlight{%level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green, DEBUG=blue} - %msg%n" />

</Console>

<RollingFile name="RollingFileAppender" fileName="logs/app.log" //zapisywanie logów do pliku

filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log">

</PatternLayout>

</Policies>

</RollingFile>

</Appenders>

<Loggers> //lista włączonych loggerów

<Root level="DEBUG"> //określamy poziom logowania

<AppenderRef ref="RollingFileAppender"/> //podajemy id zdefiniowane w sekcji Appenders

</Root>

</Root>

</Loggers>

</Configuration>

Ważne: Logowanie nie będzie działało dopóki nie umieścisz Appendera w sekcji Loggers!

Praktyka

Przykład

public class main {
    public static void main(String[] args) {
        User janek = new User();
        janek.getImie();
    }
}

public class main {

public static void main(String[] args) {

User janek = new User();

janek.getImie();

}

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

public class User {
    private String imie;
    private static Logger logger = LogManager.getLogger(User.class);

    public String getImie(){
        logger.error("Getting imie");
        return imie;
    }
}

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

public class User {

private String imie;

private static Logger logger = LogManager.getLogger(User.class);

public String getImie(){

logger.error("Getting imie");

return imie;

}

Rezultat

Stworzyliśmy, więc folder logs, z plikiem .log. Ponadto -co na załączniku nie jest widoczne – po spełnieniu warunku (tutaj 50MB) tworzy się nowy folder zawierający datę oraz plik z nazwą wg. wzorca.

src: https://stackify.com/log4j2-java/ – how it works

Dobre praktyki

Polecam artykuł Najlepsze praktyki. Zrobiłem też mega krótką ściągę https://wilamowski.it/blog/?p=345

Java Best Practices for Smarter Application Logging & Exception Handling

Logowanie w Javie z Log4j cz.2