SLF4J处理日志

SLF4J是什么

The Simple Logging Facade for Java，笼统的讲就是slf4j是一系列的日志接口。

The Simple Logging Facade for Java (SLF4J) serves as a simple facade or abstraction for various logging frameworks, such as java.util.logging, logback and log4j. SLF4J allows the end-user to plug in the desired logging framework at deployment time. Note that SLF4J-enabling your library/application implies the addition of only a single mandatory dependency, namely slf4j-api-1.7.21.jar.

由此可见slf4j译为简单日志门面，是日志框架的抽象。而其具体实现有多种多样，这里提到的logback、log4j都是其不同的实现方式。

这里写了几行简单的代码来验证一下。

public class Program {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(Program.class);
        logger.info("hello world");
    }
}

从运行结果可以看到，由于没有给出具体的logger实现，无法在控制台输出日志。也就是说我们在具体开发中，需要绑定一个日志框架，才能正常的使用slf4j。

上图可以看到应用程序对日志框架的调用关系。应用程序调用slf4j api，而日志的输出最终是由底层的日志框架来实现的。同时这张图也提现了log4j和logback的不同。

官方文档对logback的描述

NATIVE IMPLEMENTATION There are also SLF4J bindings external to the SLF4J project, e.g. logback which implements SLF4J natively. Logback’s ch.qos.logback.classic.Logger class is a direct implementation of SLF4J’s org.slf4j.Logger interface. Thus, using SLF4J in conjunction with logback involves strictly zero memory and computational overhead.

可以看到logback是直接实现了slf4j的接口，是不消耗内存和计算开销的。而log4j不是对slf4j的原生实现，所以slf4j api在调用log4j时需要一个适配层。
总结：

1. slf4j是java的一个日志门面，实现了日志框架一些通用的api，log4j和logback是具体的日志框架。
2. 他们可以单独的使用，也可以绑定slf4j一起使用。

单独使用。分别调用框架自己的方法来输出日志信息。
绑定slf4j一起使用。调用slf4j的api来输入日志信息，具体使用与底层日志框架无关（需要底层框架的配置文件）
显然这里我们不推荐单独使用日志框架。假设项目中已经使用了log4j，而我们此时加载了一个类库，而这个类库依赖另一个日志框架。这个时候我们就需要维护两个日志框架，这是一个非常麻烦的事情。而使用了slf4j就不同了，由于应用调用的抽象层的api，与底层日志框架是无关的，因此可以任意更换日志框架。

使用slf4j绑定日志系统的优势

• 软件工程的角度。抽象，解耦，便于维护。可以参考一下上面的例子。
• 语法设计角度。slf4j有{}占位符，而log4j需要用“+”来连接字符串，既不利于阅读，同时消耗了内存（heap memory）。

log4j与logback

它们两个都是开源的日志框架，而logback相对于log4j来说，更新一点，是由log4j的作者设计实现的，第一个版本是2011推出的。无论从设计上还是实现上，Logback相对log4j而言有了相对多的改进。但是两者的用法几乎差别不大。下面是logback的优势：

• 更快的执行速度
• 充分的测试
• logback-classic 非常自然的实现了SLF4J
• 丰富的扩展文档
• 可以使用使用XML配置文件或者Groovy
• 自动重新载入配置文件
• 优雅地从I/O错误中恢复
• 自动清除旧的日志归档文件
• 自动压缩归档日志文件
  以上，从性能的角度，可以尽快从log4j迁移到logback上来。

slf4j绑定log4j的用法

由于现在log4j使用的还比较多，所以介绍下他的基本用法。

在pom.xml添加相关依赖。

<dependency>
    <groupId>org.slf4jgroupId>
    <artifactId>slf4j-log4j12artifactId>
    <version>1.7.21version>
dependency>

此时会自动添加三个jar包。

log4j的正常运行需要配置文件，配置文件类型：log4j配置文件可以是log4j.xml也可以是log4j.properties。需要为其配置root、appender、layout等信息。
下面给出配置文件。

<log4j:configuration>

    
    
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        layout>
    appender>

    
    <appender name="myFile" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="output.log"/>
        <param name="Append" value="true"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        layout>
    appender>

    
    

    
    
    <category name="com.zjut.a1">
        <priority value="debug"/>
        <appender-ref ref="myFile"/>
    category>


    
    <root>
        
        <priority value="debug"/>
        
        
        
        

        
        <appender-ref ref="myConsole"/>
        <appender-ref ref="myFile"/>
    root>
log4j:configuration>

控制台输出日志的配置文件（复制可以直接用）

<log4j:configuration>
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        layout>
    appender>
    <root>
        <priority value="debug"/>
        <appender-ref ref="myConsole"/>
    root>
log4j:configuration>

应用调用

// 类名.class
Logger logger = LoggerFactory.getLogger(Program.class);
// 输出字符串
logger.debug("this is a debug msg");
// 占位符
logger.debug("hi，welcome {}，today is {}","admin","Sunday");

slf4j绑定logback的用法

pom.xml添加依赖

<dependency>
    <groupId>ch.qos.logbackgroupId>
    <artifactId>logback-classicartifactId>
    <version>1.1.7version>
dependency>

网上教程添加了很多，其实只要添加这一个，其他的依赖jar都会被下载下来。

配置文件几乎和log4j差不多，如下。选择需要的appender就可以了。

<configuration>


    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %npattern>
        encoder>
    appender>

    
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>testFile-${bySecond}.logfile>
        <append>trueappend>
        
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>
        encoder>
    appender>

    <appender name="DAYFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logFile.logfile>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>logFile.%d{yyyy-MM-dd}.logfileNamePattern>

            
            <maxHistory>30maxHistory>
            <totalSizeCap>3GBtotalSizeCap>

        rollingPolicy>

        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>
        encoder>
    appender>

    <root level="debug">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DAYFILE"/>
        <appender-ref ref="FILE"/>
    root>
configuration>

程序调用
同为slf4j的api，代码相同。

// 类名.class
Logger logger = LoggerFactory.getLogger(Program.class);
// 输出字符串
logger.debug("this is a debug msg");
// 占位符
logger.debug("hi，welcome {}，today is {}","admin","Sunday");

与旧的日志体系结合

很多项目可能已经在用之前选择的日志框架，比如说独立使用log4j等，这时，想要迁移到slf4j上，则需要用到以下几个包。

• jcl-over-slf4j.jar/jcl104-over-slf4j：apache commons logging 1.1.1/1.0.4，直接替换即可。
• log4j-over-slf4j.jar：log4j，直接替换即可。
• jul-to-slf4j：jdk logging，需要在程序开始时调用SLF4JBridgeHandler.install()来注册listener参考JulOverSlf4jProcessor，可在applicationContext.xml中定义该bean来实现初始化。注意原有的log4j.properites将失效，logback网站上提供转换器，支持从log4j.properties 转换到logback.xml 。