Connexion à Spring Boot

1. Vue d'ensemble

Dans ce court didacticiel, nous allons explorer les principales options de journalisation disponibles dans Spring Boot.

Des informations plus détaillées sur Logback sont disponibles dans A Guide to Logback, tandis que Log4j2 est introduit dans Intro to Log4j2 - Appenders, Layouts and Filters.

2. Configuration initiale

Créons d'abord un module Spring Boot. La façon recommandée de le faire est d'utiliser Spring Initializr, que nous abordons dans notre didacticiel Spring Boot.

Créons maintenant notre seul fichier de classe, LoggingController :

@RestController public class LoggingController { Logger logger = LoggerFactory.getLogger(LoggingController.class); @RequestMapping("/") public String index() { logger.trace("A TRACE Message"); logger.debug("A DEBUG Message"); logger.info("An INFO Message"); logger.warn("A WARN Message"); logger.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } } 

Une fois que nous avons chargé l'application Web, nous pourrons déclencher ces lignes de journalisation en visitant simplement // localhost: 8080 / .

3. Enregistrement de configuration zéro

Spring Boot est un framework très utile. Cela nous permet d'oublier la majorité des paramètres de configuration, dont beaucoup sont automatiquement réglés.

Dans le cas de la journalisation, la seule dépendance obligatoire est Apache Commons Logging.

Nous devons l'importer uniquement lors de l'utilisation de Spring 4.x (Spring Boot 1.x) car il est fourni par le module spring-jcl de Spring Framework dans Spring 5 (Spring Boot 2.x).

Nous ne devrions pas du tout nous soucier de l'importation de spring-jcl si nous utilisons un Spring Boot Starter (ce que nous sommes presque toujours). C'est parce que chaque démarreur, comme notre spring-boot-starter-web , dépend de spring-boot-starter-logging, qui tire déjà spring-jcl pour nous.

3.1. Journalisation de connexion par défaut

Lors de l'utilisation de démarreurs, Logback est utilisé pour la journalisation par défaut.

Spring Boot le préconfigure avec des motifs et des couleurs ANSI pour rendre la sortie standard plus lisible.

Exécutons maintenant l'application et visitons la page // localhost: 8080 / , et voyons ce qui se passe dans la console:

Comme nous pouvons le voir, le niveau de journalisation par défaut du Logger est préréglé sur INFO, ce qui signifie que les messages TRACE et DEBUG ne sont pas visibles.

Afin de les activer sans changer la configuration, nous pouvons passer les arguments –debug ou –trace sur la ligne de commande :

java -jar target/spring-boot-logging-0.0.1-SNAPSHOT.jar --trace 

3.2. Niveaux de journal

Spring Boot nous donne également accès à un paramètre de niveau de journal plus fin via des variables d'environnement. Nous pouvons y parvenir de plusieurs manières.

Tout d'abord, nous pouvons définir notre niveau de journalisation dans nos options VM:

-Dlogging.level.org.springframework=TRACE -Dlogging.level.com.baeldung=TRACE

Alternativement, si nous utilisons Maven, nous pouvons définir nos paramètres de journal via la ligne de commande :

mvn spring-boot:run -Dspring-boot.run.arguments=--logging.level.org.springframework=TRACE,--logging.level.com.baeldung=TRACE

Lorsque vous travaillez avec Gradle, nous pouvons transmettre les paramètres de journal via la ligne de commande. Cela nécessitera de définir la tâche bootRun .

Une fois cela fait, nous exécutons l'application:

./gradlew bootRun -Pargs=--logging.level.org.springframework=TRACE,--logging.level.com.baeldung=TRACE

Si nous voulons modifier la verbosité de manière permanente, nous pouvons le faire dans le fichier application.properties comme décrit ici:

logging.level.root=WARN logging.level.com.baeldung=TRACE 

Enfin, nous pouvons modifier le niveau de journalisation de manière permanente en utilisant notre fichier de configuration de structure de journalisation.

Nous avons mentionné que Spring Boot Starter utilise Logback par défaut. Voyons comment définir un fragment d'un fichier de configuration Logback dans lequel nous définissons le niveau de deux packages distincts:

N'oubliez pas que si le niveau de journalisation d'un package est défini plusieurs fois à l'aide des différentes options mentionnées ci-dessus, mais avec des niveaux de journalisation différents, le niveau le plus bas sera utilisé.

Ainsi, si nous définissons les niveaux de journalisation à l'aide de Logback, Spring Boot et des variables d'environnement en même temps, le niveau de journalisation sera TRACE , car il est le plus bas parmi les niveaux demandés.

4. Journalisation de la configuration de la connexion

Même si la configuration par défaut est utile (par exemple, pour démarrer en un rien de temps pendant les POC ou les expériences rapides), elle n'est probablement pas suffisante pour nos besoins quotidiens.

Voyons comment inclure une configuration Logback avec une couleur et un modèle de journalisation différents, avec des spécifications distinctes pour la console et la sortie de fichier , et avec une politique de roulement décente pour éviter de générer d'énormes fichiers journaux.

Tout d'abord, nous devons trouver une solution qui permet de gérer nos paramètres de journalisation seuls au lieu de polluer application.properties, qui est couramment utilisé pour de nombreux autres paramètres d'application.

Lorsqu'un fichier dans le classpath a l'un des noms suivants, Spring Boot le chargera automatiquement sur la configuration par défaut:

  • logback-spring.xml
  • logback.xml
  • logback-spring.groovy
  • logback.groovy

Spring recommends using the -spring variant over the plain ones whenever possible, as described here.

Let's write a simple logback-spring.xml:

      %black(%d{ISO8601}) %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable     ${LOGS}/spring-boot-logger.log  %d %p %C{1.} [%t] %m%n    ${LOGS}/archived/spring-boot-logger-%d{yyyy-MM-dd}.%i.log   10MB               

And when we run the application, here's the output:

As we can see, it now logs TRACE and DEBUG messages, and the overall console pattern is both textually and chromatically different than before.

It also now logs on a file in a /logs folder created under the current path and archives it through a rolling policy.

5. Log4j2 Configuration Logging

While Apache Commons Logging is at the core, and Logback is the reference implementation provided, all the routings to the other logging libraries are already included to make it easy to switch to them.

In order to use any logging library other than Logback, though, we need to exclude it from our dependencies.

For every starter like this one (it's the only one in our example, but we could have many of them):

 org.springframework.boot spring-boot-starter-web  

we need to turn it into a skinny version, and (only once) add our alternative library, here through a starter itself:

 org.springframework.boot spring-boot-starter-web   org.springframework.boot spring-boot-starter-logging     org.springframework.boot spring-boot-starter-log4j2  

At this point, we need to place in the classpath a file named one of the following:

  • log4j2-spring.xml
  • log4j2.xml

We'll print through Log4j2 (over SLF4J) without further modifications.

Let's write a simple log4j2-spring.xml:

        %d %p %C{1.} [%t] %m%n                    

And when we run the application, here's the output:

As we can see, the output is quite different from the Logback one — a proof that we're fully using Log4j2 now.

In addition to the XML configuration, Log4j2 allows us to use also a YAML or JSON configuration, described here.

6. Log4j2 Without SLF4J

We can also use Log4j2 natively, without passing through SLF4J.

In order to do that, we simply use the native classes:

import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.LogManager; // [...] Logger logger = LogManager.getLogger(LoggingController.class); 

We don't need to perform any other modification to the standard Log4j2 Spring Boot configuration.

We can now exploit the brand-new features of Log4j2 without getting stuck with the old SLF4J interface. But we're also tied to this implementation, and we'll need to rewrite our code when switching to another logging framework.

7. Logging With Lombok

In the examples we've seen so far, we've had to declare an instance of a logger from our logging framework.

This boilerplate code can be annoying. We can avoid it using various annotations introduced by Lombok.

We'll first need to add the Lombok dependency in our build script to work with it:

 org.projectlombok lombok 1.18.4 provided 

7.1. @Slf4j and @CommonsLog

SLF4J and Apache Commons Logging APIs allow us the flexibility to change our logging framework with no impact on our code.

And we can use Lombok's @Slf4j and @CommonsLog annotations to add the right logger instance into our class: org.slf4j.Logger for SLF4J and org.apache.commons.logging.Log for Apache Commons Logging.

To see these annotations in action, let's create a class similar to LoggingController but without a logger instance. We name it as LombokLoggingController and annotate it with @Slf4j:

@RestController @Slf4j public class LombokLoggingController { @RequestMapping("/lombok") public String index() { log.trace("A TRACE Message"); log.debug("A DEBUG Message"); log.info("An INFO Message"); log.warn("A WARN Message"); log.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } }

Note that we've adjusted the snippet just a bit, using log as our logger instance. This is because adding the annotation @Slf4j automatically adds a field named log.

With Zero-Configuration Logging, the application will use underlying logging implementation Logback for logging. Similarly, Log4j2 implementation is used for logging with Log4j2-Configuration Logging.

We get the same behavior when we replace the annotation @Slf4j with @CommonsLog.

7.2. @Log4j2

We can use the annotation @Log4j2 to use Log4j2 directly. So, we make a simple change to LombokLoggingController to use @Log4j2 instead of @Slf4j or @CommonsLog:

@RestController @Log4j2 public class LombokLoggingController { @RequestMapping("/lombok") public String index() { log.trace("A TRACE Message"); log.debug("A DEBUG Message"); log.info("An INFO Message"); log.warn("A WARN Message"); log.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } } 

Other than logging, there are other annotations from Lombok that help in keeping our code clean and tidy. More information about them is available in Introduction to Project Lombok, and we also have a tutorial on Setting Up Lombok With Eclipse and IntelliJ.

8. Beware of Java Util Logging

Spring Boot also supports JDK logging, through the logging.properties configuration file.

There are cases when it's not a good idea to use it, though. From the documentation:

There are known classloading issues with Java Util Logging that cause problems when running from an ‘executable jar'. We recommend that you avoid it when running from an ‘executable jar' if at all possible.

It's also a good practice when using Spring 4 to manually exclude commons-logging in pom.xml, to avoid potential clashes between the logging libraries. Spring 5 instead handles it automatically, so we don't need to do anything when using Spring Boot 2.

9. JANSI on Windows

While Unix-based operating systems such as Linux and Mac OS X support ANSI color codes by default, on a Windows console, everything will be sadly monochromatic.

Windows can obtain ANSI colors through a library called JANSI.

We should pay attention to the possible class loading drawbacks, though.

We must import and explicitly activate it in the configuration as follows:

Logback:

  true  [%thread] %highlight(%-5level) %cyan(%logger{15}) - %msg %n     

Log4j2:

ANSI escape sequences are supported natively on many platforms but are not by default on Windows. To enable ANSI support, add the Jansi jar to our application and set property log4j.skipJansi to false. This allows Log4j to use Jansi to add ANSI escape codes when writing to the console.

Note: Prior to Log4j 2.10, Jansi was enabled by default. The fact that Jansi requires native code means that Jansi can only be loaded by a single class loader. For web applications, this means the Jansi jar has to be in the web container's classpath. To avoid causing problems for web applications, Log4j no longer automatically tries to load Jansi without explicit configuration from Log4j 2.10 onward.

It's also worth noting:

  • The layout documentation page contains useful Log4j2 JANSI informations in the highlight{pattern}{style} section.
  • While JANSI can color the output, Spring Boot's Banner (native or customized through the banner.txt file) will stay monochromatic.

10. Conclusion

Nous avons vu les principales façons d'interagir avec les principaux cadres de journalisation à partir d'un projet Spring Boot.

Nous avons également exploré les principaux avantages et pièges de chaque solution.

Comme toujours, le code source complet est disponible à l'adresse over sur GitHub.