当前位置：首页 > article >正文

Logback日志技术

article 2025/1/15 12:30:33

Logback日志技术

日志

日志（Logging）是软件开发和运维中用于记录系统或应用程序运行期间发生的运行信息、状态变化、错误信息等的一种机制，这种记录的方式就好像我们日常生活中写日记一样。它提供了一种持久化的方式，使得开发者和运维人员可以回顾系统过去运行时发生的事情，了解系统的运行情况，诊断问题，并进行优化。

sout的局限

在Java程序运行时，我们可以通过标准输出：System.out.println对程序运行过程进行监视，通过sout将程序运行过程输出在控制台中，方便观察和调试，sout输出也可以达到类似于“记录日志”的效果，并且通过sout输出十分简单、方便，但也十分局限：sout只能在控制台中输出，不能输出到其他地方（如本地文件或者数据库中），假如程序停止或清空控制台，就再也无法看到程序运行的过程了。并且使用sout在代码中记录日志，不便于项目的扩展和维护（假如说不需要记录日志了，那么必须去代码中sout的地方一行一行的更改），由于这些局限，所以说在实际开发中，我们一般是通过日志技术将项目运行的日志记录到本地文件中保存。

日志技术迭代

JUL

这是JavaSE平台提供的官方日志框架，配置相对简单，年代久远，不够灵活且性能较差，所以说现在已经基本上不再使用。

Log4j

这是一个流行的日志框架，其提供了灵活的配置选项，支持多种输出目标（比如控制台，本地文件，数据库等），是一个比较强大的日志框架。

Logback

是Log4j的设计者根据Log4j升级的日志框架，其提供了更多的功能和配置选项，其性能也优于Log4j，是现在最受欢迎的日志框架。本文主要讲解的是Logback框架。

Slf4j

Simple Logging Facade for Java，其翻译成中文是简单日志门面，其提供了一套日志操作的标准接口及抽象类，允许应用程序使用不同的底层日志框架。相当于可以在代码中直接使用Slf4j提供的API，但是真正干活的是底层日志框架的实现方法。

Logback快速入门

Logback使用十分简单，当使用springboot框架构建项目时，更是事半功倍。

1.首先需要引入Logback的依赖，但是当我们使用springboot框架时，该依赖已经传递，无需手动引入：

如果不是使用springboot框架构建项目，就需要引入其依赖（至少得用maven构建项目吧...）：

2.配置文件logback.xml，需要使用logback.xml配置文件配置logback框架的相关设置（比如日志级别、输出位置、日志格式等），假如是springboot项目，就需要将这个配置文件放在resource文件夹中。

3.定义日志记录对象Logger，这一步是固定的，想要记录日志，就需要一个日志记录对象Logger，我们是通过操作Logger对象中的方法记录日志的，其定义方式是固定的：

private static final Logger log = LoggerFactory.getLogger(当前类的字节码文件)

注意：要使用Slf4j中的Logger对象和LoggerFactory！

假如使用了Lombok，那么可以直接使用注解@Slf4j，这个注解就会自动帮助我们创建一个名为log的Logger对象。

做好这些准备工作之后，就可以记录日志了：

@SpringBootTest
class JavaWeb12LogbackApplicationTests {

    private static final Logger log = LoggerFactory.getLogger(JavaWeb12LogbackApplicationTests.class);

    @Test
    public void testLogback() {
        log.info("开始计算");
        int sum = 0;
        for (int i = 0; i < 100; i++) {
            sum += i;
        }
        log.info("计算结果为{}", sum);
        log.info("{}结束计算", LocalDateTime.now());
    }
}

观察控制台输出日志：

如图所示，说明使用Logback日志框架记录日志成功，成功在控制台中记录了日志。但是仅仅是在控制台中输出日志，这和sout并无区别，反而显得更加复杂，这个时候我们就需要在logback.xml中进行设置，设置Logback的细节了。

logback.xml配置文件

logback.xml配置文件是对日志框架输出的日志进行控制的，可以用于配置日志输出的格式、位置、开关日志输出等，我们先来看这样一份常见的logback.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度  %msg：日志消息，%n是换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- 系统文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件输出的文件名，%i表示序号，从0开始-->
            <FileNamePattern>D:/log/web_study-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
            <!--最多保存的历史日志文件数量-->
            <MaxHistory>100</MaxHistory>
            <!--每个日志文件的最大大小，超过这个大小会自动记录到新文件，默认为10MB-->
            <MaxFileSize>10MB</MaxFileSize>
        </rollingPolicy>


        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度  %msg：日志消息，%n是换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

日志输出级别

    <!-- 日志输出级别 -->
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

这段配置文件中的代码规定了日志的输出级别，level="info"，则意味着必须级别≥info的日志才能被输出，级别＜info的日志就不会被输出了；可以根据需求，设置不同的级别。appender-ref ref="STDOUT"是将日志输出到控制台，appender-ref ref="FILE"是将日志输出到系统文件。这段代码的意思可以理解为：将级别≥info的日志输出到控制台和系统文件。

控制台输出

<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度  %msg：日志消息，%n是换行符 -->
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
    </encoder>
</appender>

这段配置文件主要是配置控制台输出，需要在appender中指定name属性为STDOUT（便于输出级别引用），class属性指定为ch.qos.logback.core.ConsoleAppender，代表这是控制台输出。在encoder中设置输出格式，%d表示需要输出时间，然后在{}中指定时间的格式；%thread表示需要输出是哪个线程输出该日志的；由于日志级别一般是4-5个字符，所以说使用%-5level，输出日志级别，通过指定宽度，可以让日志输出更加美观；%msg就是日志输出的消息内容；%n是换行符，这个一般来说都会加，便于日志观察。

系统文件输出

<!-- 系统文件输出 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--日志文件输出的文件名，%i表示序号，从0开始-->
        <FileNamePattern>D:/log/web_study-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
        <!--最多保存的历史日志文件数量-->
        <MaxHistory>100</MaxHistory>
        <!--每个日志文件的最大大小，超过这个大小会自动记录到新文件，默认为10MB-->
        <MaxFileSize>10MB</MaxFileSize>
    </rollingPolicy>


    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度  %msg：日志消息，%n是换行符 -->
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
    </encoder>
</appender>

这段配置文件主要是配置系统文件输出，需要在appender中指定name属性为FILE（便于输出级别引用），class属性指定为ch.qos.logback.core.rolling.RollingFileAppender，代表这是文件输出。在rollingPolicy中设置输出系统文件的设置：FileNamePattern用于设置日志输出的文件名%d用于表示时间，和上面一样、%i是序号，从0开始，日志文件的后缀名一般是.log;MaxHistory表示系统最多保存的历史日志文件数量，此处设置为100；MaxFileSize表示每个日志文件的最大大小，超过这个大小会自动记录到新文件，默认是10MB。encoder中的内容和控制台输出一致，此处不做赘述。