Slf4j+logback的使用与配置以及详情介绍

最新推荐文章于 2024-05-09 08:30:00 发布

她在进步，你呢？

最新推荐文章于 2024-05-09 08:30:00 发布

阅读量7.1k

点赞数 4

分类专栏： Java 文章标签： maven java slf4j

本文链接：https://blog.csdn.net/weixin_43920711/article/details/120040941

版权

Java 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、几种日志的区别

commons-logging

apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC 的api 接口，具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦，不过其内部也实现了一些简单日志方案。

Log4j

Logging for Java，经典的一种日志解决方案。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。

slf4j

全称为Simple Logging Facade for Java。是对不同日志框架提供的一个门面封装。可以在部署的时候不修改任何配置即可接入一种日志实现方案。和commons-loging 类似。个人感觉设从计上更好一些，没有commons 那么多潜规则。同时有两个额外特点：①能支持多个参数，并通过{}占位符进行替换，避免老写logger.isXXXEnabled这种无奈的判断，带来性能提升见；②OSGI机制更好兼容支持。

logback

作为一个通用可靠、快速灵活的日志框架，将作为Log4j 的替代和slf4j 组成新的日志系统的完整实现。具有极佳的性能，在关键路径上执行速度是log4j 的10 倍，且内存消耗更少。

Log4j2

Log4j2是Log4j的升级版，与之前的版本Log4j 1.x相比、有重大的改进，在修正了Logback固有的架构问题的同时，改进了许多Logback所具有的功能。

总结

可以这么理解，slf4j和commons-logging是一种抽象接口，Log4j、Log4j2和logback是它们的实现，在实际使用中，一般选择slf4j+Log4j2或者slf4j+logback。

二、Slf4j+logback在Maven项目中的使用

1. 依赖的导入

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>
    
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.20</version>
      <scope>compile</scope>
    </dependency>
    
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>

这里得纠正一个错误,在百度学习了解Slf4j的过程中,大部分博客都是写的是两总方式去使用Slf4j
第一种方法：直接使用@Slf4j注解配合Lombok插件及其依赖
第二种方法：使用LoggerFactory.getLogger(当前类.class)方法
但是博客内写的依赖包只导入了前面两个依赖(slf4j-api和lombok依赖)。这样并不能实现日志输出
在前面标题一中我也总结到 : Slf4j其实是接口并非实现类,logback才是它们的实现,如果只导入Slf4j-api依赖的话,并没有实现方法,所以打印不出日志
Slf4j作为接口,Logback作为实现实际上是使用了门面模式,详情了解可以参考 : 门面模式

2.Slf4j的日志等级

slf4j的日志级别分为五种：

　	info、debug、error、warn、trane

常用的是这是三个。

        info  一般处理业务逻辑的时候使用，就跟 system.err打印一样，用于说明此处是干什么的。slf4j使用的时候是可以动态的传参的，使用占位符 {} 。后边一次加参数，会挨个对应进去。

        debug: 一般放于程序的某个关键点的地方，用于打印一个变量值或者一个方法返回的信息之类的信息

        error： 用户程序报错，必须解决的时候使用此级别打印日志。

不常用的有：

        warn：警告，不会影响程序的运行，但是值得注意。

        trane:  一般不会使用，在日志里边也不会打印出来，好像是很低的一个日志级别。

 注：异常信息不要放在最后一个参数的位置，否则会映射不进去。如果想要映射进去，就要使用getMessage()方法或者.toString()方法，这样做获取不到我们想要看到的信息，所以不建议这样使用。

3.代码中简单的使用

通过LoggerFactory.getLogger() 方法获取Logger对象
直接使用@Slf4j注解实现日志输出
使用占位符{ }替换输出

三、Logback介绍

Log4j的创始人CekiGülcü重写了Log4j的内部实现，改进后形成了Logback，相比Log4j速度更快，资源占用更少，也更稳定。（另外Log4j2.0又是在Logback基础上进行了改进，但还未广泛使用）

官方网站：http://logback.qos.ch/

Logback包括3个部分：

logback-core(基础核心模块)
logback-classic(log4j改良版，完整实现SLF4JAPI接口，可方便的与其他日志系统切换)
logback-access(与Servlet容器集成提供通过Http访问日志的功能)

特性：

Logback传统方法是使用XML保存配置，0.9.22+版本支持Groovy配置（转换工具）。配置文件中支持条件处理。

Logback-classic可以在配置修改后自动重新载入。

FileAppender和它的子类，包括RollingFileAppender，可以优雅的从I/O错误中恢复。

通过设置TimeBasedRollingPolicy 或者 SizeAndTimeBasedFNATP的 maxHistory 属性，你就可以控制日志归档文件的最大数量，清除旧的日志。

RollingFileAppender可以在回滚操作中，自动压缩归档日志文件。

Lilith是logback的一个记录和访问事件查看器。它相当于log4j的 chainsaw。强大的日志过滤功能

SiftingAppender全能追加器日志中堆栈信息包含依赖包名和版本

谨慎模式下，多个JVM的多个FileAppender可以安全写入统一的日志文件。

Logback的核心对象和用法与Log4j是相承的，主要对象有：

Logger
Appender
Layout
Filter：Logback-classic提供两种类型的过滤器：常规过滤器和TuroboFilter过滤器。

Logback整体流程：

Logger 产生日志信息；
Layout修饰这条msg的显示格式；
Filter过滤显示的内容；
Appender具体的显示，即保存这日志信息的地方。

四、Logback的配置

1.logback的默认配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。
　1、Logback的配置文件：
Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。
　2、Logback默认配置的步骤：
　　(1). 尝试在 classpath下查找文件logback-test.xml；
　　(2). 如果文件不存在，则查找文件logback.xml；
　　(3). 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

2.logback.xml常用配置详解

1.根节点<configuration>包含三个属性：   

        scan:默认为true。作用：当设置为true时，如果配置文件发生改变，将会被重新加载。

        scanPeriod：默认时间间隔为1分钟，默认单位是毫秒，当scan为true时，此属性生效。作用：检测配置文件是否有修改时间间隔。

        debug：默认为false。作用：当此属性为true时，将打印出logback内部日志信息，实时查看logback运行状态。
　　　例如：
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                   <!--其他配置省略--> 
           </configuration>

2.子节点<contextName>:用来设置上下文名称。
          每个logger都关联到logger上下文，默认上下文名称为default。
          可以使用<contextName>设置成其他名字，用于区分不同的应用程序的记录。一旦设置，不能修改。
          例如：
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                  <contextName>myAppName</contextName>
                  <!--其他配置省略-->
　        </configuration>

3.子节点<property>:用来定义变量值，有两个属性name和value。
          通过<property>定义的值被插入到logger上下文中，可以使"${}"来使用变量。
          name:变量的名字
          value：变量名字对应的数值
          例如:
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                  <property name="APP_Name" value="myAppName"></property>
                  <contextName>${APP_Name}</contextName>
                  <!--其他配置省略-->
          </configuration>

 4.子节点<timestamp>:获取时间戳字符串，有两个属性key和datePattern。
          key：标识此<timestamp>的名字
          datePattern：设置将当前时间（即解析配置文件的时间）转换为字符串，遵循java.txt.SimpleDateFormat的格式。
             例如：
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"></timestamp>
                <contextName>${bySecond}</contextName>
           </configuration>

 5.子节点<appender>:负责写日志的组件，有两个必要属性name和class。
         name：指定appender名称
         class：指定appender的全限定名

5.1 class="ch.qos.logback.core.ConsoleAppender"：把日志输出到控制台，有以下子节点。
          <encoder>:对日志进行格式化。（具体参数稍后讲~~~~~~~~~~~~~） 
          <target>：字符串System.out（默认）或者System.err
            例如：
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
                       <encoder>
                            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
                       </encoder>
               </appender>
               <root level="DEBUG">
                     <appender-ref ref="STDOUT"></appender-ref>
               </root>
         </configuration>	
         上述配置表示把>=DEBUG级别的日志都输出到控制台

 5.2 class="ch.qos.logback.core.FileAppender"：把日志添加到文件，有以下子节点：
          <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
          <append>：默认为true。如果是true，日志被追加到文件结尾，如果是false，清空现存文件。
          <encoder>：对记录事件进行格式化。（具体参数稍后讲~~~~~~~~~~~）
          <prudent>：默认为false。如果是true，日志会被安全的写入文件，即其他的FileAppender也在向此文件做写入操作，效率低。
            例如：
           <configuration scan="true" scanPeriod="60 seconds" debug="false">
                  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
                         <file>testFile.log</file>
                         <append>true</append>
                         <encoder>
                                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
                         </encoder>
                 </appender>
                <root level="DEBUG">
                     <appender-ref ref="FILE"/>
                </root>
           </configuration>
           上述配置表示把>=DEBUG级别的日志都输出到testFile.log

 5.3 class="ch.qos.logback.core.rolling.RollingFileAppender"：滚动记录文件，先将日志文件指定到文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
  　　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

　　<append>：默认为true。如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件。

　　<rollingPolicy>：当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。　　

　　<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。

　　<encoder>：对记录事件进行格式化。负责两件事：1）是把日志信息转换成字节数组，2）是把字节数组写入到输出流。

　　PatternLayoutEncoder 是唯一有用的且默认的encoder。有一个节点：

　　<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。

 			class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
            <fileNamePattern>：必要节点，包含文件名及"%d"转换符，"%d"可以包含一个java.text.SimpleDateFormat指定的时间格式，默认格式是 yyyy-MM-dd。也可以设置其他格 式，如：%d{yyyy-MM}。
            <maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。
           注:删除旧文件时，那些为了归档而创建的目录也会被删除。
			注：（RollingFileAppender的<file>子节点可有可无，通过设置<file>，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变； 如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。）
           
          	 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
　　　  <maxFileSize>:活动文件的大小，默认值是10MB。
　　　  <prudent>：当为true时，不支持FixedWindowRollingPolicy，支持TimeBasedRollingPolicy。但是有两个限制：1）不支持也不允许文件压缩，2）不能设置file属性，必须留空。	
　　　  


　      class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" ：根据固定窗口算法重命名文件的滚动策略。有以下子节点：
　　      <minIndex>:窗口索引最小值
　　      <maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
　　      <fileNamePattern>:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip
　　例如：	
　　<configuration scan="true" scanPeriod="60 seconds" debug="false">
　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
　　　　　　<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
　　　　　　　　<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
　　　　　　　　<maxHistory>30</maxHistory>
　　　　　　</rollingPolicy>
　　　　　　<encoder>
　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
　　　　　　</encoder>
　　　　</appender>
　　　　<root level="DEBUG">
　　　　　　<appender-ref ref="FILE"/>
　　　　</root>
　　</configuration>
      上述配置表示每天生成一个日志文件，保存30天的日志文件。

　　<configuration scan="true" scanPeriod="60 seconds" debug="false">

　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
　　　　　　<file>test.log</file>

　　　　　　<roollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
　　　　　　　　<fileNamePattern>tests.%i.log.zip</fileNamePattern>
　　　　　　　　<minIndex>1</minIndex>
　　　　　　　　<maxIndex>3</maxIndex>
　　　　　　</roollingPolicy>

　　　　　　<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
　　　　　　　　<maxFileSize>5MB</maxFileSize>
　　　　　　</triggeringPolicy>

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

　　　　<root level="DEBUG">
　　　　　<appender-ref ref="FILE" />
　　　　</root>
　　</configuration>
     上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

 5.4 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。

6. 子节点<logger>：用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。
        <logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。

　　 name: 用来指定受此logger约束的某一个包或者具体的某一个类。
　　 level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前logger将会继承上级的级别。
　　 addtivity: 是否向上级logger传递打印信息。默认是true。同<logger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。

7. 子节点<root>：它也是<logger>元素，但是它是根logger,是所有<logger>的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。有一个属性：
　　  level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

五、参考博客

作者：maxwellyue
链接：https://www.jianshu.com/p/696444e1a352
来源：简书
标题: slf4j+logback的配置及使用
作者：娜娜娜娜小姐姐
链接:https://www.cnblogs.com/nananana/p/8371805.html
来源:博客园
标题:logback配置详解和使用
作者: XRacoon
链接:https://www.cnblogs.com/pixy/p/4980603.html
来源:博客园
标题:logback使用总结
作者: 筱荣荣
链接:https://www.cnblogs.com/rrong/p/9712623.html
来源:博客园
标题:注解slf4j的日志该用哪个级别

她在进步，你呢？

关注

4
点赞
踩
31

收藏

觉得还不错? 一键收藏
0
评论
Slf4j+logback的使用与配置以及详情介绍

一、几种日志的区别commons-loggingapache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC 的api 接口，具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦，不过其内部也实现了一些简单日志方案。Log4jLogging for Java，经典的一种日志解决方案。内部把日志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。slf4j
复制链接

扫一扫