Влизане в Spring Boot

1. Общ преглед

В този кратък урок ще разгледаме основните опции за регистриране, налични в Spring Boot.

По-задълбочена информация за Logback е налична в Ръководство за Logback, докато Log4j2 е представен в Intro to Log4j2 - Appenders, Layouts and Filters.

2. Първоначална настройка

Нека първо създадем модул Spring Boot. Препоръчителният начин да го направите е да използвате Spring Initializr, който разглеждаме в нашия урок за пролетно стартиране.

Сега нека създадем единствения ни файл с класа, 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..."; } } 

След като заредим уеб приложението, ще можем да задействаме тези линии за регистриране, като просто посетим // localhost: 8080 / .

3. Регистрация на нулева конфигурация

Spring Boot е много полезна рамка. Позволява ни да забравим за по-голямата част от конфигурационните настройки, много от които самоуверено се настройва автоматично.

В случай на регистриране, единствената задължителна зависимост е регистрирането на Apache Commons.

Трябва да го импортираме само когато използваме Spring 4.x (Spring Boot 1.x), тъй като е предоставен от Spring -jcl модула на Spring Framework през Spring 5 (Spring Boot 2.x).

Не бива да се притесняваме да импортираме spring-jcl, ако използваме Spring Boot Starter (какъвто почти винаги сме). Това е така, защото всеки стартер, подобно на нашия spring-boot-starter-web , зависи от spring-boot-starter-logging, който вече дърпа spring-jcl за нас.

3.1. Регистрация по подразбиране

Когато използвате стартери, Logback се използва за регистриране по подразбиране.

Spring Boot го конфигурира предварително с шарки и ANSI цветове, за да направи стандартната продукция по-четлива.

Нека сега стартираме приложението и посетим // localhost: 8080 / страница и да видим какво се случва в конзолата:

Както виждаме, нивото на регистрация по подразбиране на Logger е предварително зададено на INFO, което означава, че съобщенията TRACE и DEBUG не се виждат.

За да ги активираме, без да променяме конфигурацията, можем да предадем аргументите –debug или –trace в командния ред :

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

3.2. Входни нива

Spring Boot също ни дава достъп до по-фина настройка на нивото на дневника чрез променливи на средата. Има няколко начина да постигнем това.

Първо, можем да зададем нивото си на регистриране в нашите VM Options:

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

Като алтернатива, ако използваме Maven, можем да дефинираме настройките на дневника си чрез командния ред :

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

Когато работим с Gradle, можем да предадем настройките на дневника през командния ред. Това ще изисква настройка на задачата bootRun .

След като приключим, стартираме приложението:

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

Ако искаме да променим многословието за постоянно, можем да го направим във файла application.properties, както е описано тук:

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

И накрая, можем да променим нивото на регистриране за постоянно, като използваме нашия конфигурационен файл на рамката за регистриране.

Споменахме, че Spring Boot Starter използва Logback по подразбиране. Нека видим как да дефинираме фрагмент от конфигурационен файл на Logback, в който задаваме нивото за два отделни пакета:

Не забравяйте, че ако нивото на регистрационния файл за даден пакет се дефинира няколко пъти, като се използват различните опции, споменати по-горе, но с различни нива на дневника, ще се използва най-ниското ниво.

Така че, ако зададем едновременно нивата на регистриране, като използваме Logback, Spring Boot и променливи на средата, нивото на дневника ще бъде TRACE , тъй като е най-ниското сред заявените нива.

4. Logging Configuration Logging

Въпреки че конфигурацията по подразбиране е полезна (например, за да започнем за нула време по време на POC или бързи експерименти), най-вероятно това не е достатъчно за ежедневните ни нужди.

Нека да видим как да включим конфигурация на Logback с различен цвят и модел на регистриране, с отделни спецификации за извеждане на конзола и файл и с прилична политика на търкаляне, за да избегнем генерирането на огромни регистрационни файлове.

Първо, трябва да намерим решение, което позволява да се справяме самостоятелно с настройките си за регистриране, вместо да замърсяваме application.properties, което обикновено се използва за много други настройки на приложението.

Когато файл в пътя на класа има едно от следните имена, Spring Boot автоматично ще го зареди над конфигурацията по подразбиране:

  • 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

Видяхме основните начини за взаимодействие с основните рамки за регистриране в рамките на проект Spring Boot.

Също така проучихме основните предимства и клопки на всяко решение.

Както винаги, пълният изходен код е достъпен в GitHub.