Logback的使用

秋天code

已于 2023-05-28 20:12:17 修改

阅读量1.1k

点赞数

分类专栏：编程思想文章标签： logback log4j java

于 2023-01-05 13:26:29 首次发布

本文链接：https://blog.csdn.net/weixin_55697693/article/details/128561840

版权

编程思想专栏收录该内容

30 篇文章 0 订阅

订阅专栏

Logback

目前流行的日志使用是 slf4j + logback，项目中使用slf4j作为门面，logback作为日志实现。

项目中，直接使用日志实现也可以，但是不推荐，因为这就导致项目对日志实现的耦合性较强。

软件设计原则：依赖倒转原则，依赖的是抽象，不应该是具体的实现。

所以目前流行的是日志门面 + 日志实现

介绍一个性能非常好的日志框架——Logback

概述

Logback是一个实现了Slf4j 规范的实现框架，log4j的作者实现了Logback。

下面这是Logback官网的介绍：

logback分为三个模块:logback-core、logback-classic和logback-access。

logback-core模块是logback的基础抽象，为其他两个模块奠定了基础，必须要有。
logback-classic模块可以被认为是log4j 1.x的显著改进版本。

logback-classic直接实现了slf4j，所以使用slf4j作为门面，不需要适配层
logback-access：与web容器集成使用（tomcat、Jetty等Servlet容器），不用关心这个模块。

使用

项目中使用slf4j + logback，需要导入这三个依赖：

slf4j:日志规范
logback-core:logback基础模块
logback-classic:日志实现

因为logback-classic直接实现了slf4j，所以无需适配层

导入Logback的核心配置文件logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--
        CONSOLE ：表示当前的日志信息是可以输出到控制台的。
    -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--输出流对象 默认 System.out 改为 System.err-->
        <target>System.out</target>
        <encoder>
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度
                %msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level]  %c [%thread] : %msg%n</pattern>
        </encoder>
    </appender>

    <!-- File是输出的方向通向文件的 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--日志输出路径-->
        <file>C:/code/itheima-data.log</file>
        <!--指定日志文件拆分和压缩规则-->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--通过指定压缩文件名称，来确定分割文件方式-->
            <fileNamePattern>C:/code/itheima-data2-%d{yyyy-MMdd}.log%i.gz</fileNamePattern>
            <!--文件拆分大小-->
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
    </appender>

    <!--

    level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
   ， 默认debug
    <root>可以包含零个或多个<appender-ref>元素，标识这个输出位置将会被本日志级别控制。
    -->
    <root level="ALL">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </root>
</configuration>

创建日志对象，使用即可

// getLogger中的字符串是这个日志对象的名称，一般都是以当前的类名命名，方便日志信息快速定位

public static final Logger LOGGER = LoggerFactory.getLogger("Test.class");

LOGGER.info("main方法开始运行");

LOGGER.debug("除法运算要开始了");
try {

    int a = 10;
    int b = 0;
    LOGGER.trace("a  = " + a + ", b = " + b);
    int c = a / b;
} catch (Exception e) {
    LOGGER.error("异常信息为" + e);
}

配置文件详解

参考文章

https://www.cnblogs.com/gavincoder/p/10091757.html

logback的配置文件名称必须是logback.xml

根标签是<configuration>,所有的配置信息都写在这个标签中。

`<appender>`

使用<appender>来定义一个写日志的组件，该组**有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。**class用来指定用哪一个类来负责写这个日志

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
</appender>

ConsoleAppender

ConsoleAppender 把日志输出到控制台，有以下子节点：
<encoder>：对日志信息进行格式化
<target>：字符串System.out(默认)或者System.err，用哪种形式在控制台输出，System.out就是默认的正常的输出语句，System.err是用来打印错误信息的输出语句，打印的信息是红色的。

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <!--输出流对象 默认 System.out 改为 System.err-->
    <target>System.out</target>
    <encoder>
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度
                %msg：日志消息，%n是换行符-->
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level]  %c [%thread] : %msg%n</pattern>
    </encoder>
</appender>

FileAppender

FileAppender：把日志添加到文件，有以下子节点：
<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
<encoder>：对记录事件进行格式化。（具体参数稍后讲解）
<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

<appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
    <file>C:/testFile.log</file> 
    <append>true</append> 
    <encoder> 
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
    </encoder> 
</appender>

RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
<rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        <charset>utf-8</charset>
    </encoder>
    <!--日志输出路径-->
    <file>C:/code/itheima-data.log</file>
    <!--指定日志文件拆分和压缩规则-->
    <rollingPolicy
                   class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--通过指定压缩文件名称，来确定分割文件方式-->
        <fileNamePattern>C:/code/itheima-data2-%d{yyyy-MMdd}.log%i.gz</fileNamePattern>
        <!--文件拆分大小-->
        <maxFileSize>1MB</maxFileSize>
    </rollingPolicy>
</appender>

滚动策略

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

<2> class=“ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小，默认值是10MB。
<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。

<3> 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

`<root>`

是这个配置文件的入口，定义的日志组件要想生效，需要在这里面声明

使用<appender-ref>来指明需要引用的日志组件，引用的是组件的name属性

<root>标签的level用来指定日志的级别，

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF

<root level="ALL">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE" />
</root>

`<encoder>`

参考文章

https://blog.csdn.net/snail_bi/article/details/103496697

负责两件事：一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

使用<pattern>来指定输出信息的格式，使用%+修饰符的方式来格式化信息

关于格式化修饰符的使用，看这篇文章

https://blog.csdn.net/snail_bi/article/details/103496697

日志级别

在LogBack中，设置了5个日志级别。

TRACE < DEBUG < INFO < WARN < ERROR ; 默认级别是DEBUG

作用：当在logback.xml文件中设置了某种日志级别后，系统将只输出当前级别，以及高于当前级别的日志。

如果需要打印指定级别的日志，则在<root>标签中用level属性指定即可。

例如，我想要打印WARN级别的日志信息，则在<root>中这样写：就会打印WARN和ERROR的日志，其余级别较低的日志不会打印

<root level="WARN">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE" />
</root>

level还有两个属性值ALL和OFF，

ALL是打印所有级别的日志
OFF是关闭日志功能

在代码中打印日志信息时，直接调用对应的方法，就是对应级别的日志信息

public static final Logger LOGGER = LoggerFactory.getLogger("Test.class");

LOGGER.trace();// 打印TRACE级别的日志信息
LOGGER.debug();// 打印DEBUG级别的日志信息
LOGGER.info();// 打印info级别的日志信息
LOGGER.warn();// 打印WARN级别的日志信息
LOGGER.error();// 打印ERROR级别的日志信息