springboot使用logback日志框架超详细教程

已于 2022-08-25 17:13:08 修改
阅读量2.1w 收藏 69
点赞数 14
分类专栏： SpringBoot 文章标签： java spring boot logback slf4j
于 2022-06-08 15:16:32 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41239465/article/details/125185148
版权

看完必会的Logback日志框架

现在很多项目都基于springBoot框架来进行开发，但是日志框架繁而杂乱，本文为你介绍一下Logback的日志框架详细作用，看完必会。

  • 引入依赖：
 <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.10</version>
        </dependency>

首先我们要在application.xml设置开发环境，因为针对开发环境和生产环境有不同的日志策略

在这里插入图片描述

一、Logback日志

1、什么是日志

通过日志查看程序的运行过程，运行信息，异常信息等

2、日志级别

日志记录器（Logger）的行为是分等级的。如下表所示：

分为：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF

默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别

# 设置日志级别
logging:
  level:
    root: ERROR

这种方式能将ERROR级别以及以上级别的日志输出到控制台上，其他级别将不会输出

3、创建日志文件

spring boot内部使用Logback作为日志实现的框架。

先删除前面在application.yml中的日志级别配置

resources 中创建 logback-spring.xml （默认日志文件的名字）

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
</configuration>

4、创建测试日志输出

将以下日志输出到任意controller的方法中即可，例如list方法中

@ApiOperation("积分等级列表")
@GetMapping("/list")
public R listAll(){

    log.info("hi i'm helen");
    log.warn("warning!!!");
    log.error("it's a error");

    List<IntegralGrade> list = integrationService.list();
    return R.ok().data("list", list);
}

二、基本配置说明

1、configuration

日志配置的根节点

<configuration></configuration>

2、contextName

<contextName>是<configuration>的子节点。

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用<contextName>设置成其他名字，用于区分不同的应用程序。

<contextName>atguiguSrb</contextName>

3、property

<property>是<configuration>的子节点，用来定义变量。

<property> 有两个属性，name和value：name的值是变量的名称，value是变量的值。

通过<property>定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

<!-- 日志的输出目录 -->
<property name="log.path" value="D:/project/finance/srb_log/core" />

<!--控制台日志格式：彩色日志-->
<!-- magenta:洋红 -->
<!-- boldMagenta:粗红-->
<!-- cyan:青色 -->
<!-- white:白色 -->
<!-- magenta:洋红 -->
<property name="CONSOLE_LOG_PATTERN"
          value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) %highlight([%-5level]) %green(%logger) %msg%n"/>

<!--文件日志格式-->
<property name="FILE_LOG_PATTERN"
          value="%date{yyyy-MM-dd HH:mm:ss} [%-5level] %thread %file:%line %logger %msg%n" />

<!--编码-->
<property name="ENCODING"
          value="UTF-8" />

4、appender

<appender>是<configuration>的子节点，是负责写日志的组件

<appender>有两个必要属性name和class：name指定appender名称，class指定appender的全限定名

<encoder>对日志进行格式化

<pattern>定义日志的具体输出格式

<charset>编码方式

控制台日志配置

<!-- 控制台日志 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        <charset>${ENCODING}</charset>
    </encoder>
</appender>

文件日志配置

<file>表示日志文件的位置，如果上级目录不存在会自动创建，没有默认值。

<append>默认 true，日志被追加到文件结尾，如果是 false，服务重启后清空现存文件。

<!-- 文件日志 -->
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>${log.path}/log.log</file>
    <append>true</append>
    <encoder>
        <pattern>${FILE_LOG_PATTERN}</pattern>
        <charset>${ENCODING}</charset>
    </encoder>
</appender>

5、logger

<logger>可以是<configuration>的子节点，用来设置某一个包或具体某一个类的日志打印级别、指定<appender>

name：用来指定受此logger约束的某一个包或者具体的某一个类

level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF。默认继承上级的级别

<logger>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger

<!-- 日志记录器  -->
<logger name="com.atguigu" level="INFO">
    <appender-ref ref="CONSOLE" />
    <appender-ref ref="FILE" />
</logger>

6、测试

测试日志记录的控制台输出、文件输出、以及日志级别

 @ApiOperation("积分等级列表")
    @GetMapping(value = "/list")
    public R list(){
        log.info("this is a info log");
        log.warn("this is a warn log");
        log.error("this is a error log");
        List<IntegralGrade> list = integralGradeService.list();
        return R.ok().data("list",list);
    }

image-20220608150026194

三、多环境配置

springProfile

在一个基于Spring boot开发的项目里，常常需要有多套环境的配置：开发，测试以及产品。使用springProfile 可以分别配置开发（dev），测试（test）以及生产（prod）等不同的环境

<!-- 开发环境和测试环境 -->
<springProfile name="dev,test">
    <logger name="com.atguigu" level="INFO">
        <appender-ref ref="CONSOLE" />
    </logger>
</springProfile>
<!-- 生产环境 -->
<springProfile name="prod">
    <logger name="com.atguigu" level="ERROR">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </logger>
</springProfile>

四、滚动日志

问题：生产环境下，如果系统长时间运行，那么日志文件会变得越来越大，系统读取和写入日志的时间会越来越慢，严重的情况会耗尽系统内存，导致系统宕机。

解决方案：可以设置滚动日志。

1、设置时间滚动策略

RollingFileAppender是Appender的另一个实现，表示滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将旧日志备份到其他文件

<rollingPolicy>是<appender>的子节点，用来定义滚动策略。

TimeBasedRollingPolicy：最常用的滚动策略，根据时间来制定滚动策略。

<fileNamePattern>：包含文件名及转换符， “%d”可以包含指定的时间格式，如：%d{yyyy-MM-dd}。如果直接使用 %d，默认格式是 yyyy-MM-dd。<maxHistory>：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--  要区别于其他的appender中的文件名字  -->
    <file>${log.path}/log-rolling.log</file>
    <encoder>
        <pattern>${FILE_LOG_PATTERN}</pattern>
        <charset>${ENCODING}</charset>
    </encoder>
    <!-- 设置滚动日志记录的滚动策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!-- 日志归档路径以及格式 -->
        <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.log</fileNamePattern>
        <!--归档日志文件保留的最大数量-->
        <maxHistory>15</maxHistory>
    </rollingPolicy>
</appender>

2、设置触发滚动时机

放在<rollingPolicy>的子节点的位置，基于实践策略的触发滚动策略

<maxFileSize>设置触发滚动条件：单个文件大于100M时生成新的文件

注意：修改日志文件名 此时 <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.log</fileNamePattern>

<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    <maxFileSize>1KB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>

五、完整的日志配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <contextName>atguiguSrb</contextName>

    <!-- 日志的输出目录 -->
    <property name="log.path" value="D:/project_log/srb_log/220608" />

    <!--控制台日志格式：彩色日志-->
    <!-- magenta:洋红 -->
    <!-- boldMagenta:粗红-->
    <!-- cyan:青色 -->
    <!-- white:白色 -->
    <!-- magenta:洋红 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) %highlight([%-5level]) %green(%logger) %msg%n"/>

    <!--文件日志格式-->
    <property name="FILE_LOG_PATTERN"
              value="%date{yyyy-MM-dd HH:mm:ss} [%-5level] %thread %file:%line %logger %msg%n" />

    <!--编码-->
    <property name="ENCODING"
              value="UTF-8" />


    <!-- 控制台日志 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>${ENCODING}</charset>
        </encoder>
    </appender>

    <!-- 文件日志 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>${log.path}/log.log</file>
        <append>true</append>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>${ENCODING}</charset>
        </encoder>
    </appender>

    <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <!--  要区别于其他的appender中的文件名字  -->
        <file>${log.path}/log-rolling.log</file>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>${ENCODING}</charset>
        </encoder>


        <!-- 设置滚动日志记录的滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志归档路径以及格式 -->
            <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--归档日志文件保留的最大数量-->
            <maxHistory>15</maxHistory>

            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>1KB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

    </appender>

    <!-- 日志记录器  -->
    <!--    <logger name="com.atguigu" level="INFO">-->
    <!--        <appender-ref ref="CONSOLE" />-->
    <!--        <appender-ref ref="FILE" />-->
    <!--    </logger>-->

    <!-- 开发环境和测试环境 -->
    <springProfile name="dev,test">
        <logger name="com.atguigu" level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="ROLLING_FILE" />
        </logger>
    </springProfile>

    <!-- 生产环境 -->
    <springProfile name="prod">
        <logger name="com.atguigu" level="ERROR">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="FILE" />
        </logger>
    </springProfile>
</configuration>

测试结果：

由于设置每2KB就进行归档存储，所以在没满2KB的文档记录如下：

image-20220608150444402

日志记录满2KB时，归档储存：

image-20220608150549246

image-20220608150601407

程序员阿红
关注
专栏目录
SpringBoot Logback配置，SpringBoot日志配置
04-27
NULL 博文链接：https://fanshuyao.iteye.com/blog/2414522
Spring Boot干货系列：（七）默认日志框架配置
热门推荐
AndyLizh的专栏
04-12 4万+
后端编程嘟 2017-04-05 21:53 前言 今天来介绍下Spring Boot如何配置日志logback,我刚学习的时候，是带着下面几个问题来查资料的，你呢 如何引入日志？ 日志输出格式以及输出方式如何配置？ 代码中如何使用？ 正文 Spring Boot在所有内部日志中使用Commons Logging，但是默认配置也
SpringBoot集成Logback日志框架全攻略
最新发布
lucky_fd的博客
08-11 678
Logback是SLF4J（Simple Logging Facade for Java）的一个实现，由同一个作者开发。它被认为是Log4j的继任者，提供了更快的速度和更好的功能。Logback包括三个主要组件：Logger、Appender和Layout。Logger负责记录日志信息，Appender负责将日志信息输出到目的地（如控制台、文件等），而Layout则负责定义日志的格式。Spring Boot在创建新项目时，如果未指定其他日志框架，则默认使用Logback作为日志实现。
springboot 日志管理之 logback
zwl2220943286的博客
10-12 3664
logback的使用详解，一文教你学会使用logback日志
Springboot中使用logback
qq_32740259的博客
03-07 1万+
Springboot中使用logback
Springboot使用logback
qq_55648724的博客
01-07 922
Logback 是log4j 框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持 SLF4J。Logback 的定制性更加灵活，同时也是 SpringBoot 的内置日志框架。
＜11＞springboot使用logback
做一个有信仰de人的博客
10-31 156
此次，使用之前集成Mybatis的项目 导入所需依赖，配置资源文件信息 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <depend.
SpringBoot使用logback日志框架超详细教程
2301_81937891的博客
12-15 1454
项目中日志系统是必不可少的，目前比较流行的日志框架有 log4j、logback 等，可能大家还不知道，这两个框架的作者是同一个人，Logback 旨在作为流行的 log4j 项目的后续版本，从而恢复 log4j 离开的位置。level 属性的值可以是不区分大小写的字符串 TRACE，DEBUG，INFO，WARN，ERROR，ALL 或 OFF 之一。level 属性的值允许一个不区分大小写的字符串值 TRACE，DEBUG，INFO，WARN，ERROR，ALL 或 OFF。
SpringBoot中logback日志保存到mongoDB的方法
08-28
SpringBoot中logback日志保存到mongoDB的方法是指在SpringBoot项目中使用logback日志框架将日志保存到mongoDB数据库中的方法。logback是 SpringBoot默认集成的日志框架，它相对来说是优秀于log4j的。 在logback中，...
SpringBoot整合logback日志框架详解（提供Gitee源码）
黄团团的个人博客
07-01 753
本篇博客主要介绍如何把主流的日志框架快速整合到目前的SpringBoot框架中，对六种日志等级进行介绍以及使用方法。目前常用的就四个级别，由高到低分别是ERROR、WARN、INFO、DEBUG，在SpringBoot框架中可以控制打印输出的日志级别，例如配置成了INFO级别的日志，那么在INFO级别以下的日志将不会被打印出来。
SpringBoot logback日志框架使用过程解析
08-24
SpringBoot logback日志框架... SpringBoot logback日志框架使用过程解析主要介绍了SpringBoot logback日志框架的使用过程，通过示例代码详细介绍了日志框架的使用过程，对大家的学习或者工作具有一定的参考学习价值。
SpringBoot使用logback
liushaoming
01-06 2875
在src/main/resources下面添加一个logback.xml 内容如下 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n ${LOG_HOME}/springboot-demo.log.%d{yyyyMMdd} 30 --> %d{yyyy-MM-dd HH:m
SpringBoot_logback使用
Myron_007的博客
02-18 733
文章目录前言一 Logback默认配置Logback默认配置步骤：指定文件方式二 logback_idea日志输出颜色支持示例logback.xml参考文档 前言 springboot logback使用总结 一 Logback默认配置 参考附录1 Logback默认配置步骤： 尝试在 classpath 下查找文件 logback-test.xml； 如果文件不存在，则查找文件 logback.xml； 如果两个文件都不存在，logback 用 BasicConfigurator 自动对自己进行配置，这
SpringBoot使用LogBack日志系统
weixin_40598838的博客
12-14 98
demo 引入pom <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </dependency> 在类中引入日志，并使用它 private static final Logger log = LoggerFactor
SpringBoot Logback的使用
黑卡米的专栏
01-27 357
介绍 springboot引入logback jar以后，自动的会在资源根目录找logback.xml 或 logback-spring.xml文件。 标签定义 configuration 属性 作用 scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为 truescanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 debug 当此属性设置为true
Spring Boot - 日志文件配置，logback 配置（超详细）
CYK_byte的博客
02-20 9007
我们的Java程序在IDEA中执行完后，都会编译生成一个target文件，这个文件就是项目最终执行的代码（去掉注释等一系列工作后的文件），那么想要知道lombok的实现原理，就需要去观察这个文件~在生产环境下需要将日志信息保留下来，便于出现问题以后容易追溯问题，将日志保存下来这个活动叫做日志持久化。我们只需要在配置文件中指定日志的存储目录或者是指定日志保存文件名即可，如下。Ps：在没有指定文件名两次保存或者指定相同文件名进行两次保存的情况下，Ps：logger 对象是属于 org.slf4j 包下！
Spring Boot使用logback
bobozai86的博客
12-18 667
默认情况下Spring boot使用Logback作为日志框架。当我们加入stater-web时： org.springframework.boot spring-boot-starter-web 默认的已经添加了logback依赖了。Spring Boot已为当前使用日志框架的控制台输出以及文件的输出做好了配置。如果我们想修改，可以在Spring Boot的配置文件app
springboot logback
08-06
Spring Boot 是一个用于快速构建基于 Spring 框架的应用程序的开发框架。而 Logback 是一个功能强大的日志管理框架，它是由 Log4j作者设计的下一代日志库。 在 Spring Boot 中使用 Logback作为日志管理框架非常简单。首先，你需要在项目的依赖中添加 Logback 的相关库。通常情况下，只需要添加以下依赖即可： ```xml<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> ``` 接下来，你可以在项目的配置文件（例如 application.properties 或 application.yml）中配置 Logback 的相关选项。以下是一些常用的配置选项示例： ```properties# 设置日志输出级别logging.level.root=infologging.level.com.example=debug# 配置日志输出格式logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%nlogging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n# 配置日志文件路径logging.file.name=myapp.loglogging.file.path=/var/log/myapp``` 以上示例中，我们设置了日志的输出级别、输出格式以及日志文件的路径和名称。 当配置完成后，你可以在应用程序中直接使用 Spring Boot 提供的日志接口（如 `org.slf4j.Logger`）进行日志记录。例如： ```javaimport org.slf4j.Logger; import org.slf4j.LoggerFactory; @Controllerpublic class MyController { private final Logger logger = LoggerFactory.getLogger(MyController.class); @GetMapping("/hello") public String hello() { logger.info("Hello, Spring Boot!"); return "hello"; } } ``` 在上述代码中，我们使用了 `LoggerFactory.getLogger()` 方法获取一个 Logger 实例，并使用 `logger.info()` 方法记录了一条日志。 这就是在 Spring Boot 中使用 Logback 进行日志管理的基本步骤。当然，你还可以根据项目的需求进行更高级的日志配置，如异步记录、日志滚动等。希望对你有所帮助！如果还有其他问题，请随时提问。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

程序员阿红

你的鼓励是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值