SLF4J explained
Simple Logging Facade for Java (SLF4J) provides a Java logging API by means of a simple facade pattern. The underlying logging backend is determined at runtime by adding the desired binding to the classpath and may be the standard Sun Java logging package java.util.logging,[2] Log4j, Reload4j, Logback[3] or tinylog.[4] [5]
The separation of the client API from the logging backend reduces the coupling between an application and any particular logging framework. This can make it easier to integrate with existing or third-party code or to deliver code into other projects that have already made a choice of logging backend.
SLF4J was created by Ceki Gülcü as a more reliable alternative to Jakarta Commons Logging framework.[6] [7] Research in 2013 on 10,000 GitHub projects found that the most popular Java library is SLF4J, along with JUnit, with 30.7% of projects using it.[8] In January 2021, it was ranked as the second most popular project according to mvnrepository.[9]
Similarities and differences with log4j 1.x
- Five of log4j's six logging levels are used (ERROR, WARN, INFO, DEBUG, TRACE). FATAL has been dropped on the basis that inside the logging framework is not the place to decide when an application should terminate and therefore there is no difference between ERROR and FATAL from the logger's point of view. In addition, SLF4J markers offer a more general method for tagging log statements. For example, any log statement of level ERROR can be tagged with the "FATAL" marker.
- Logger instances are created via the
LoggerFactory
, which is very similar in log4j. For example,
private static final Logger LOG = LoggerFactory.getLogger(Wombat.class);
- In Logger, the logging methods are overloaded with forms that accept one, two or more values.[10] Occurrences of the simple pattern
{}
in the log message are replaced in turn with the values. This is simple to use yet provides a performance benefit when the values have expensive toString
methods. When logging is disabled at the given level, the logging framework does not need to evaluate the string representation of the values, or construct a log message string that is never actually logged. In the following example, string concatenation and toString
method for the values count
or userAccountList
are performed only when DEBUG is enabled.
LOG.debug("There are now " + count + " user accounts: " + userAccountList); // slower LOG.debug("There are now user accounts: ", count, userAccountList); // faster
- Similar methods exist in Logger for
isDebugEnabled
etc. to allow more complex logging calls to be wrapped so that they are disabled when the corresponding level is disabled, avoiding unnecessary processing.
- Unlike log4j, SLF4J offers logging methods that accept markers. These are special objects that enrich the log messages. At present time, logback is the only framework which makes use of markers.
Similarities and differences with log4j 2.x
Apache log4j 2.x supports all slf4j features.[11]
Version history
Version 2
Version 2.0.0 was released on 2022-08-20. The latest version 2 release is 2.0.9 (2023-09-03).[12]
Significant changes and feature additions:
- Support for lambda syntax in passing messages to be logged.
- Addition of a Fluent API.
- Requires Java 8 or later.
Version 1
Version details can be found in the manual.
Significant versions include:
- Version 1.7.36 and all newer releases are reproducible.
- Version 1.7.35 slf4j-log4j12 module is replaced by slf4j-reload4j.
- Version 1.7.33 adds support for reload4j via the slf4j-reload4j module. It is the latest stable release. See Download product page.
- Version 1.7.5 yielded significant improvement in logger retrieval times.
- Version 1.7.0 added support for varargs, requiring support for Java 5 or later.
- Version 1.6 brought a no-operation implementation used by default if no binding found.
- Version 1.1 releases in Maven repositories began 2006-09.
See also
Notes and References
- Web site: SLF4J News . slfj4.org . en . 2023-09-03.
- http://java.sun.com/javase/6/docs/api/java/util/logging/package-summary.html java.util.logging
- http://logback.qos.ch/ logback
- http://www.tinylog.org/ tinylog
- Web site: SLF4J binding for tinylog . 2014-12-16 . 2017-12-07 . https://web.archive.org/web/20171207070817/http://www.tinylog.org/news#29 . dead .
- http://articles.qos.ch/thinkAgain.html "Think again before adopting the commons-logging API"
- http://articles.qos.ch/classloader.html "Taxonomy of class loader problems encountered when using Jakarta Commons Logging"
- Web site: We Analyzed 30,000 GitHub Projects – Here Are The Top 100 Libraries in Java, JS and Ruby . 2014-02-09 . 2014-07-09 . https://web.archive.org/web/20140709221250/http://www.takipiblog.com/2013/11/20/we-analyzed-30000-github-projects-here-are-the-top-100-libraries-in-java-js-and-ruby/ . dead .
- Web site: Nicolas. Frenkel. "most popular" section. 2022-01-16. Twitter. en.
- https://slf4j.org/apidocs/org/slf4j/Logger.html SLF4J api docs: Logger
- https://logging.apache.org/log4j/2.x/log4j-slf4j-impl/index.html Apache log4j 2.x slf4j Binding
- Web site: SLF4J News . 2023-11-27 . www.slf4j.org.