Java中的日志(log4j,SLF4J,SLF4J2都是什么玩意儿)

Java中的日志

Java中的日志对于一个应用来说有着至关重要的作用。

日志中的抽象层

日志中的抽象层的作用是提供一个日志接口,具体的日志实现交给其他日志类去实现(如log4j,logback等),日志抽象层有名的当属SLF4J(Simple Logging for Java), JCL(Jakarta Commons Logging,also called Apache Comming Logging),这些日志抽象层都会在程序运行时动态去查找日志实现类,并使用这些实现类去输出日志。

为什么会出现日志抽象层这个产物?

对于一些中间件来说(例如Spring),他们也需要打印日志。一个应用中常常需要集成多个中间件,如果这些中间件使用的日志不统一,那么就会对开发者开发应用造成很大的困扰,常常需要找到A中间件使用了哪些日志实现类,B中间件使用了哪些日志依赖...日志抽象层的出现解决了这个问题,中间件开发者只需要专注于日志真正要输出的内容,而不需要关心我需要使用哪些日志实现类去输出日志。

另外,值的一提的是Spring4.x版本中使用的日志抽象层都是JCL,具体原因如下:

The nice thing about commons-logging is that you don’t need anything else to make your application work. It has a runtime discovery algorithm that looks for other logging frameworks in well known places on the classpath and uses one that it thinks is appropriate (or you can tell it which one if you need to). If nothing else is available you get pretty nice looking logs just from the JDK (java.util.logging or JUL for short). You should find that your Spring application works and logs happily to the console out of the box in most situations, and that’s important.

此时,日志导向为:Application -> JCL -> Others Logs Implementations

但是,同样的事情,SLF4J同样做的很好,不但避免了JCL中的类加载问题并且具有更大的灵活性。因此Spring提供了如下措施替换JCL, origin: https://docs.spring.io/spring/docs/4.1.x/spring-framework-reference/htmlsingle/

为确保SLF4J正常工作,需要添加静态绑定,这就意味着SLF4J不会在程序运行时动态查找日志实现类,而是在编译时期与日志实现类进行绑定。

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>4.1.9.RELEASE</version>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>jcl-over-slf4j</artifactId>
        <version>1.5.8</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.5.8</version>
    </dependency>
    <dependency>
        <!--静态绑定-->
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.5.8</version>
    </dependency>
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.14</version>
    </dependency>
</dependencies>

此时,日志导向为:Application -> JCL -> JCL Adapter -> SLF4J -> SLF4J Bridge -> log4j

如果需要使用log4j2,应使用如下依赖(origin: https://www.slf4j.org/faq.html):

        <!--排除JCL-->
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>99-empty</version>
        </dependency>
        <!--排除log4j1-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>99-empty</version>
        </dependency>
        <!--排除slf4j到log4j1的启动-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>empty-version</version>
        </dependency>

        <!--log4j2 开始-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.9.1</version>
        </dependency>
        <!-- 后向兼容:使用Log4j2实现log2j1.x的接口 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-1.2-api</artifactId>
            <version>2.9.1</version>
        </dependency>
        <!--需要使用log4j2的AsyncLogger需要包含disruptor-->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.3.5</version>
        </dependency>
        <!--log4j2 结束-->
        <!--解决JCL适配,spring4.x版本强制使用jcl(Jakarta Commons Logging)作为日志的抽象层-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.25</version>
        </dependency>

如上配置最终日志导向如下 Application -> JCL -> JCL Adapter -> SLF4J -> SLF4J Bridge -> log4j2,这样做的意义在于整个应用使用SLF4J作为日志的抽象层,其他的依赖(使用JCL作为日志抽象层)不用再一个一个进行单独排包,如上例中的Spring就单独进行了排包操作

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>4.1.9.RELEASE</version>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

日志的实现类

Java中有着很多优秀的日志实现类,如log4j2,log4j,logback,java.util.logging等。以下将会简单介绍每个实现类的优缺点。

  • java.util.logging
    JDK源生

  • log4j
    优点:配置简单,基本不会遇到什么奇怪问题

  • logback
    为了提升log4j的性能,原作者又开发出了logback,并且SpringBoot中默认的日志实现类就是logback
    优点:

    • 天生与SLF4J兼容
  • log4j2
    优点:

    • 异步日志?如上的disruptor就是给log4j2的异步日志服务的
    • 自定义日志级别
    • 热加载日志级别配置(修改日志级别之后立即生效)
    • 支持Java8 Lambda
    • 更少的垃圾回收
    • 日志过滤
    • 并发性能提升
    • 支持xml,json,yaml以及程序式配置

    缺点:

    • 配置繁琐,至少需要log4j2-api,log4j-core这两个依赖
    • 不兼容log4j,如果有兼容需要,还需要加log4j-1.2-api依赖

日志的结构

Architecture in log.png

推荐阅读更多精彩内容