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

BoldExplorer

已于 2024-06-17 11:37:27 修改

阅读量695

点赞数 5

文章标签： logback java

于 2024-06-17 11:12:14 首次发布

本文链接：https://blog.csdn.net/YLXCA/article/details/139737132

版权

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

1 导入依赖

2 代码中使用

2.1 直接使用@Slf4j注解实现日志输出

2.2 通过LoggerFactory.getLogger() 方法获取Logger对象输出

二、日志持久化配置

三、Logback的配置

1、Logback默认配置步骤　　

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

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

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

2、logback.xml常用配置详解

一、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>

2 代码中使用

2.1 直接使用@Slf4j注解实现日志输出

@RestController
@Slf4j
public class TestController {


    @GetMapping("test1")
    public String test1(){
        String str="hello word 1";
        log.info("测试使用@Slf4j日志输出,{}",str);
        return "test1";
    }

}

输出效果

2.2 通过LoggerFactory.getLogger() 方法获取Logger对象输出

@RestController
@Slf4j
public class TestController {

    private static final Logger logger= (Logger) LoggerFactory.getLogger(TestController.class);

    @GetMapping("test1")
    public String test1(){
        String str="hello word 1";
        log.info("测试使用@Slf4j日志输出,{}",str);
        return "test1";
    }

    @GetMapping("test2")
    public String test2(){
        String str="hello word 2";
        logger.info("测试通过LoggerFactory.getLogger()方法获取Logger对象输出,{}",str);
        return "test2";
    }
}

输出效果

注意：

Slf4j其实是接口并非实现类,logback才是它们的实现,如果只导入Slf4j-api依赖的话,并没有实现方法,所以打印不出日志
Slf4j作为接口,Logback作为实现实际上是使用了门面模式,详情了解可以参考 : 门面模式

二、日志持久化配置

<?xml version="1.0" encoding="UTF-8" ?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- 日志输出规则 根据当前ROOT 级别，日志输出时，级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration>
    <!--日志文件路径-->
    <springProperty scope="context" name="applicationName" source="spring.application.name"/>
    <property name="log_path" value="D:/zzh/java/logs/${applicationName}"/>
    <!--0、日志格式和颜色渲染 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />

    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <!--1、输出到控制台-->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <!--%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n-->
                ${CONSOLE_LOG_PATTERN}
            </pattern>
        </layout>
        <encoder>
            <pattern>
                ${CONSOLE_LOG_PATTERN}
            </pattern>
            <!--设置字符集-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--日志输出到文档的级别root-level的影响-->
    <!--输出DEBUG日志到文档, 时间滚动输出-->
    <appender name = "DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <!--<file>${log_path}/debug.log</file>-->
        <!--日志文档输出格式-->
        <!-- 定义时间格式，
            [%thead]定义使用的是哪个线程，
            %-5level输出是哪个级别日志，
            %logger{50}
            -%msg输出哪个package中的哪个类的信息，
            %n换行
        -->
        <!--类似layout,但是 encoder既负责将日志文件转换成字符串也负责将日志信息写到对应的文件当中-->
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <!--设置字符集-->
            <charset>
                UTF-8
            </charset>
        </encoder>

        <!--日志记录器的滚动策略，按日期，按大小记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路径-->
            <fileNamePattern>
                ${log_path}/debug/debug.%d-%i.log
            </fileNamePattern>
            <!--单个log文件超过该大小就会重新建一个log文件-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数？-->
            <maxHistory>90</maxHistory>
        </rollingPolicy>

        <!--此日志只记录debug级别日志-->
        <!--日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name = "INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>
                UTF-8
            </charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>
                ${log_path}/info/info.%d-%i.log
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>90</maxHistory>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name = "WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>
                UTF-8
            </charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>
                ${log_path}/warn/warn.%d-%i.log
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>90</maxHistory>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name = "ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>
                UTF-8
            </charset>
        </encoder>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>
                ${log_path}/error/error.%d-%i.log
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>90</maxHistory>
        </rollingPolicy>

        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!--root 级别-->
    <root level="info">
        <appender-ref ref="consoleLog"/>
        <!--<appender-ref ref="DEBUG_FILE"/>-->
        <appender-ref ref="INFO_FILE"/>
        <appender-ref ref="WARN_FILE"/>
        <appender-ref ref="ERROR_FILE"/>
    </root>

</configuration>

启动项目成功生成日志文件：

三、Logback的配置

1、Logback默认配置步骤
　　(1). 尝试在 classpath下查找文件logback-test.xml；
　　(2). 如果文件不存在，则查找文件logback.xml；
　　(3). 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

2、logback.xml常用配置详解

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。

参考博客：Slf4j+logback的使用与配置以及详情介绍_slf4j logback-CSDN博客