SpringBoot 整合日志框架(SLF4j、log4j、log4j2、logback)

JAVA herman 109浏览 0评论

在不同的公司,不同的项目,选择的日志框架可能都不一样。Spring Boot 支持多种日志框架。本文将详细介绍使用 SpringBoot 如何整合 SLF4j 日志框架。

市面上的日志框架有很多,如:JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j….等等。甚至每个框架用的日志框架都不一样。Spring Boot在框架内容部使用JCL, spring-boot-starter-logging采用了slf4j+logback的形式, Spring Boot也能自动适配( jul、 log4j2、 logback) 并简化配置。Hibernate默认用的是slf4j-nop.jar日志实现方式。而 Mybatis 则默认使用的是 Apache Commons Logging 日志框架。

所以,当我们在整合各个框架的时候,最终使用哪个日志框架,怎么除去各框架的默认日志框架就显得很重要。这些内容请看本文的详细讲解。

如何在系统中使用SLF4j

日常开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;给系统里面导入slf4j的jar和  logback的实现jar。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

关于 slf4j 的更多使用说明,也可以参考它的官方网站:https://www.slf4j.org

各框架如何选择日志框架

这是 slf4j 官网上提供的一张图片。这张图告诉我们如何适配各种框架,最终使用你喜欢的日志框架来记录日志。

SpringBoot 的 starter 默认引入了 spring-boot-starter-logging 日志框架。因此当我们想使用 slf4j 的日志实现时,我们就需要把 spring-boot-starter-logging 干掉,从而引入自己的日志框架。

<dependency>
<groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

SpringBoot 默认引入的日志框架

根据上图中的 Maven 的依赖关系可以看到,spring-boot-starter 引入了 spring-boot-starter-logging 相关的依赖。

下面以使用 log4j2 日志框架为例,看看我们完整的 pom.xml 的配置。

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

其他的日志框架,做法都类似。我就不在一一举例了。

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!

本文原文出处:业余草: » SpringBoot 整合日志框架(SLF4j、log4j、log4j2、logback)