Iniciar sesión en Spring Boot

Programación

1. Información general

En este breve tutorial, exploraremos las principales opciones de registro disponibles en Spring Boot.

La información más detallada sobre Logback está disponible en A Guide to Logback, mientras que Log4j2 se presenta en Introducción a Log4j2 - Appenders, Layouts and Filters.

2. Configuración inicial

Primero creemos un módulo Spring Boot. La forma recomendada de hacerlo es utilizando Spring Initializr, que cubrimos en nuestro Spring Boot Tutorial.

Ahora creemos nuestro único archivo de clase, 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..."; } }

Una vez que hayamos cargado la aplicación web, podremos activar esas líneas de registro simplemente visitando // localhost: 8080 / .

3. Registro de configuración cero

Spring Boot es un marco muy útil. Nos permite olvidarnos de la mayoría de los ajustes de configuración, muchos de los cuales se autoajustan obstinadamente.

En el caso del registro, la única dependencia obligatoria es Apache Commons Logging.

Necesitamos importarlo solo cuando usamos Spring 4.x (Spring Boot 1.x) ya que es proporcionado por el módulo spring-jcl de Spring Framework en Spring 5 (Spring Boot 2.x).

No deberíamos preocuparnos por importar spring-jcl en absoluto si estamos usando un Spring Boot Starter (que casi siempre lo hacemos). Esto se debe a que cada iniciador, como nuestro spring-boot-starter-web , depende de spring-boot-starter-logging, que ya utiliza spring-jcl para nosotros.

3.1. Registro de logback predeterminado

Cuando se utilizan arrancadores, Logback se utiliza para el registro de forma predeterminada.

Spring Boot lo preconfigura con patrones y colores ANSI para que la salida estándar sea más legible.

Ahora ejecutemos la aplicación y visitemos la página // localhost: 8080 / , y veamos qué sucede en la consola:

Como podemos ver, el nivel de registro predeterminado del Logger está preestablecido en INFO, lo que significa que los mensajes TRACE y DEBUG no son visibles.

Para activarlos sin cambiar la configuración, podemos pasar los argumentos –debug o –trace en la línea de comando :

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

3.2. Niveles de registro

Spring Boot también nos da acceso a una configuración de nivel de registro más detallada a través de variables de entorno. Hay varias formas de lograrlo.

Primero, podemos configurar nuestro nivel de registro dentro de nuestras Opciones de VM:

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

Alternativamente, si estamos usando Maven, podemos definir nuestra configuración de registro a través de la línea de comando :

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

Cuando trabajamos con Gradle, podemos pasar la configuración del registro a través de la línea de comando. Esto requerirá configurar la tarea bootRun .

Una vez hecho esto, ejecutamos la aplicación:

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

Si queremos cambiar la verbosidad de forma permanente, podemos hacerlo en el archivo application.properties como se describe aquí:

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

Finalmente, podemos cambiar el nivel de registro de forma permanente utilizando nuestro archivo de configuración del marco de registro.

Mencionamos que Spring Boot Starter usa Logback de forma predeterminada. Veamos cómo definir un fragmento de un archivo de configuración de Logback en el que establecemos el nivel para dos paquetes separados:

Recuerde que si el nivel de registro de un paquete se define varias veces utilizando las diferentes opciones mencionadas anteriormente, pero con diferentes niveles de registro, se utilizará el nivel más bajo.

Por lo tanto, si configuramos los niveles de registro utilizando Logback, Spring Boot y las variables de entorno al mismo tiempo, el nivel de registro será TRACE , ya que es el más bajo entre los niveles solicitados.

4. Registro de configuración de logback

Aunque la configuración predeterminada es útil (por ejemplo, para comenzar en tiempo cero durante los POC o experimentos rápidos), lo más probable es que no sea suficiente para nuestras necesidades diarias.

Veamos cómo incluir una configuración de Logback con un color y patrón de registro diferente, con especificaciones separadas para la salida de la consola y el archivo , y con una política de rotación decente para evitar generar archivos de registro enormes.

Primero, deberíamos encontrar una solución que permita manejar nuestra configuración de registro solo en lugar de contaminar application.properties, que se usa comúnmente para muchas otras configuraciones de aplicaciones.

Cuando un archivo en la ruta de clases tiene uno de los siguientes nombres, Spring Boot lo cargará automáticamente sobre la configuración predeterminada:

  • 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

Hemos visto las principales formas de interactuar con los principales marcos de registro desde dentro de un proyecto Spring Boot.

También exploramos las principales ventajas y desventajas de cada solución.

Como siempre, el código fuente completo está disponible en GitHub.