slf4 + logback日志组件的介绍，以及在javaWeb工程中的详细应用

Bertha 。 2021-12-03 22:01 298阅读 0赞

### slf4 + logback日志组件的介绍，以及在javaWeb工程中的详细应用 ###

*  1. slf4 与 logback 的简单介绍
 *  2. logback相对于log4j的优点
 *  3. 应该在什么地方写日志
 *  4. 在java项目中的具体应用
 *   *  4.1 基于maven的slf4j+logback pom.xml配置
     *  4.2 配置logback.xml文件对日志组件进行初始化
     *   *  4.2.1 默认配置步骤
         *  4.2.2 自定义配置步骤
     *  4.3 在java工程中如何使用Logback

# 1. slf4 与 logback 的简单介绍 #

*  slf4j： slf4j是一个日志系统的封装，对外提供统一的API，不提供日志具体实现。
 *  logback：和log4j同为日志的一种具体实现。（Logback是由log4j创始人设计的又一个开源日志组件）

# 2. logback相对于log4j的优点 #

*  1、**更快的实现** Logback的内核重写了，在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了，初始化内存加载也更小了。
 *  2、**非常充分的测试** Logback经过了几年，数不清小时的测试。Logback的测试完全不同级别的。在作者的观点，这是简单重要的原因选择logback而不是log4j。
 *  3、**Logback-classic非常自然实现了SLF4j** Logback-classic实现了 SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J， 所 以切换到log4j或者其他，非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。
 *  4、**非常充分的文档** 官方网站有两百多页的文档。
 *  5、**自动重新加载配置文件** 当配置文件修改了，Logback-classic能自动重新加载配置文件。扫描过程快且安全，它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。
 *  6、**Lilith** Lilith是log事件的观察者，和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。
 *  7、**谨慎的模式和非常友好的恢复** 在谨慎模式下，多个FileAppender实例跑在多个JVM下，能 够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender能够非常友好地从I/O异常中恢复。
 *  8、**配置文件可以处理不同的情况** 开发人员经常需要判断不同的Logback配置文件在不同的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不同，可以通过,和来实现，这样一个配置文件就可以适应多个环境。
 *  9、**Filters（过滤器）** 有些时候，需要诊断一个问题，需要打出日志。在log4j，只有降低日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你可以继续 保持那个日志级别而除掉某种特殊情况，如alice这个用户登录，她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需 加4行XML配置。可以参考MDCFIlter 。
 *  10、**SiftingAppender（一个非常多功能的Appender）** 它可以用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender能够区别日志事件跟进用户的Session，然后每个用户会有一个日志文件。
 *  11、**自动压缩已经打出来的log** RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任何影响。
 *  12、**堆栈树带有包版本** Logback在打出堆栈树日志时，会带上包的数据。
 *  13、**自动去除旧的日志文件** 通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

# 3. 应该在什么地方写日志 #

*  当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定位的；
 *  当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支；
 *  经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程；

# 4. 在java项目中的具体应用 #

## 4.1 基于maven的slf4j+logback pom.xml配置 ##

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.10</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.1.2</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.1.2</version>
    </dependency>

## 4.2 配置logback.xml文件对日志组件进行初始化 ##

### 4.2.1 默认配置步骤 ###

(1). 尝试在 classpath 下查找文件 logback-test.xml；

(2). 如果文件不存在，则查找文件 logback.xml；

(3). 如果两个文件都不存在，logback 用 Bas icConfigurator 自动对自己进行配置，这会导致记录输出到控制台。

### 4.2.2 自定义配置步骤 ###

*  在java项目工程目录中找到“ src --> main --> resources”目录，并在此目录下新建 logback.xml 文件。
 *  logback.xml文件的模板及详细注释如下：
    
        <?xml version="1.0" encoding="UTF-8"?>
        
        <configuration scan="false" scanPeriod="60 seconds" debug="false">
            
            <property name="LOG_HOME" value="/app/log" />
            
            <property name="appName" value="netty"></property>
            
            <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
                <Encoding>UTF-8</Encoding>
                
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                </layout>
            </appender>
            
              
            <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <Encoding>UTF-8</Encoding>
                  
                <file>${LOG_HOME}/${appName}.log</file>
                
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    
                    <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
                    
                    <MaxHistory>365</MaxHistory>
                    
                    <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                        <maxFileSize>100MB</maxFileSize>
                    </timeBasedFileNamingAndTriggeringPolicy>
                </rollingPolicy>
                     
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
                </layout>
            </appender>
        
            
            
            <logger name="org.hibernate" level="error" />
            
            <logger name="org.springframework" level="error" additivity="false"></logger>
        
            <logger name="com.creditease" level="info" additivity="true">
                <appender-ref ref="appLogAppender" />
            </logger>
        
            
            <root level="info">
                <appender-ref ref="stdout" />
                <appender-ref ref="appLogAppender" />
            </root>
        </configuration>

## 4.3 在java工程中如何使用Logback ##

1.  首先导入依赖包

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

1.  初始化Logger对象

// 或者 Logger logger = LoggerFactory.getLogger(getClass());
    static final Logger logger = LoggerFactory.getLogger(MyClassName.class);

1.  执行log操作

logger.debug("debug");
    logger.info("info");

参考文献：  
[https://mp.weixin.qq.com/s/37VOP-iWrWgvbftt5UPj0g][https_mp.weixin.qq.com_s_37VOP-iWrWgvbftt5UPj0g]  
[https://blog.csdn.net/zgmzyr/article/details/8267072][https_blog.csdn.net_zgmzyr_article_details_8267072]  
[https://www.jianshu.com/p/09b9b50f32ef][https_www.jianshu.com_p_09b9b50f32ef]

[https_mp.weixin.qq.com_s_37VOP-iWrWgvbftt5UPj0g]: https://mp.weixin.qq.com/s/37VOP-iWrWgvbftt5UPj0g
[https_blog.csdn.net_zgmzyr_article_details_8267072]: https://blog.csdn.net/zgmzyr/article/details/8267072
[https_www.jianshu.com_p_09b9b50f32ef]: https://www.jianshu.com/p/09b9b50f32ef