首页 > 其他分享 >Spring Boot 整合 Logback 日志

Spring Boot 整合 Logback 日志

时间:2024-06-19 17:59:47浏览次数:23  
标签:xml log Spring Boot 日志 Logback

什么是 Logback?

Logback 是日志框架 SLF4J 的一个实现,它被设计用来替代 log4j。Logback 提供了更高的性能,更丰富的日志功能和更好的配置选项。

为什么要用它?

在 Spring Boot 中,Logback 是默认的日志实现,至于官方为何用它作为默认日志组件,有以下几个原因:

    1. 性能:Logback 在性能上超越了许多其他的日志实现,尤其是在高并发环境下。
    1. 灵活性:Logback 提供了高度灵活的日志配置方式,支持从 XML、Groovy 以及编程式的方式进行配置。
    1. 功能丰富:除了基本的日志功能,Logback 还提供了如日志归档、日志级别动态修改、事件监听等高级功能。
    1. 与 SLF4J 集成:SLF4J 是一个日志门面(facade),使得应用程序可以在运行时更换日志实现。Logback 作为 SLF4J 的一个原生实现,可以无缝地与其集成。
    1. 与 Spring Boot 的自动配置集成:Spring Boot 提供了对 Logback 的自动配置,这意味着开发者无需手动配置 Logback,只需提供一个简单的配置文件即可。

引入依赖

由于 Spring Boot 默认使用 Logback,所以当你在 pom.xml 中加入 spring-boot-starter-web 依赖时,它会自动包含 Logback 相关依赖,无需额外添加:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

配置文件我们统一放置在 xx-web 模块中,方便统一管理。然后在 src/main/resources 目录下,创建一个名为 logback-weblog.xml 的文件。

内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration >
    <jmxConfigurator/>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    <!-- 应用名称 -->
    <property scope="context" name="appName" value="weblog" />
    <!-- 自定义日志输出路径,以及日志名称前缀 -->
    <property name="LOG_FILE" value="/app/weblog/logs/${appName}.%d{yyyy-MM-dd}"/>
    <property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
    <!--<property name="CONSOLE_LOG_PATTERN" value="${FILE_LOG_PATTERN}"/>-->

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!-- 日志文件输出的文件名 -->
        <FileNamePattern>${LOG_FILE}-%i.log</FileNamePattern>
        <!-- 日志文件保留天数 -->
        <MaxHistory>30</MaxHistory>
        <!-- 日志文件最大的大小 -->
        <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>10MB</maxFileSize>
        </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <!-- 格式化输出:%d 表示日期,%thread 表示线程名,%-5level:级别从左显示 5 个字符宽度 %errorMessage:日志消息,%n 是换行符-->
        <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- dev 环境(仅输出到控制台) -->
    <springProfile name="dev">
        <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
        <root level="info">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>

    <!-- prod 环境(仅输出到文件中) -->
    <springProfile name="prod">
        <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
        <root level="INFO">
            <appender-ref ref="FILE" />
        </root>
    </springProfile>
</configuration>

因为打印日志到文件只需要在生产环境开启就行了,所以,使日志生效的配置放到 application-prod.yml 文件中就行了:

#=================================================================
# log 日志
#=================================================================
logging:
  config: classpath:logback-weblog.xml

打印日志

为了测试一下日志是否能够正常打印,我们在单元测试包下的 xxWebApplicationTests 类中:

新建一个 testLog() 测试方法,同时添加 Lombok 的 @Slf4j 日志注解,它可以帮助我们自动的生成日志实例,示例代码如下:

package com.example.xx.web;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
@Slf4j
class xxWebApplicationTests {

    @Test
    void contextLoads() {
    }

    @Test
    void testLog() {
        log.info("这是一行 Info 级别日志");
        log.warn("这是一行 Warn 级别日志");
        log.error("这是一行 Error 级别日志");

        // 占位符
        String author = "闫小生";
        log.info("这是一行带有占位符日志,作者:{}", author);
    }

}

控制台日志

运行该测试方法,若控制台日志输出如下,表示日志组件运行正常运行,在后续的功能开发中,我们会频繁地使用到它:

日志输出到文件中

接下来,我们再验证一下生产环境是否能够使文件输出到文件中。先将 application.yml 的环境改为 prod ,一旦激活 prod, 则日志将被输出到文件中:

spring:
  profiles:
    # 默认激活 dev 环境
    active: prod

因为小生用的 Windows 系统做的演示,还需要修改 logback-weblog.xml , 将日志输出路径自定义为 Windows 路径:

测试完成后,记得将 profile 重新改回 dev 环境,以及路径改回 Linux 格式路径。

标签:xml,log,Spring,Boot,日志,Logback
From: https://blog.csdn.net/m0_68207804/article/details/139797508

相关文章

  • 【SpringBoot】Spring Boot 如何实现接口防刷
    目录什么是接口防刷常见的接口防刷策略Redis实现接口防刷代码示例拦截器实现接口防刷代码示例总结什么是接口防刷接口被刷指的是同一接口被频繁调用,可能是由于以下原因导致:恶意攻击:攻击者利用自动化脚本或工具对接口进行大量请求,以消耗系统资源、拖慢系统响应速......
  • springboot dependencyManagement的作用
    一 dependencyManagement的用处在创建springboot多模块的项目中,为了保持各模块的相同依赖保持一致,通常会在项目级的POM.XML中使用 dependencyManagement节点来实现这个一致性。项目级pom.xml<!--依赖声明--><dependencyManagement><dependencies>......
  • 【Ubuntu开发入门之“悟空派wukongpi/香橙派orangepi H3 linux开发②u-boot移植“】
    Ubuntu开发入门之"orangepiH3linux开发@u-boot移植"问题描述解决方法获取u-boot源码编译配置u-boot制作并烧录TF卡结束语郑重声明:本人原创博文,都是实战,均经过实际项目验证出货的转载请标明出处:攻城狮2015Platform:AllwinnerH3OS:Linuxubunt......
  • Spring Boot应用中添加定时任务
    下面是一个使用@EnableScheduling的完整解决方案,包括了如何在SpringBoot应用中设置定时任务以及如何编写和管理这些任务。步骤1:添加依赖确保你的pom.xml或build.gradle中包含了SpringBootStarterWeb和SpringBootStarterAOP的依赖,因为@Scheduled注解的执行依赖于AOP......
  • Spring WebSocket中关于WebSocket配置类的注意事项
    情况1:如果只需要进行简单的通信,不需要消息代理和STOMP协议支持,那么只需要实现WebSocketConfigurer接口注意:实现的接口是WebSocketConfigurer,使用的注解是@EnableWebSocketimportorg.springframework.context.annotation.Configuration;importorg.springframework.web.socke......
  • spring 使用 事件机制
    概述在编写代码的时候,比如我删除一篇文章,这个时候,如果我想做些额外的逻辑,这是就需要修改删除部分的代码。spring提供了事件机制更优雅的实现这个,用户只需要实现事件监听即可。代码实现注入发布者publicclassKnowledgeBaseServiceimplementsApplicationEventPublisherAwar......
  • [com.t.extend.SpringContextLoaderListener] - generate index.html sucess,ERROR or
    错误:2024-06-1913:23:09,873INFO[com.t.extend.SpringContextLoaderListener]-generateindex.htmlsucess13:23:10.159[RMITCPConnection(3)-127.0.0.1]ERRORorg.apache.struts2.dispatcher.Dispatcher-Dispatcherinitializationfailedcom.opensymphony.xwor......
  • Springboot 集成 Shardingsphere-JDBC
    Springboot集成Shardingsphere-JDBCShardingsphere系列目录:背景调研前提新增依赖分表策略简单分库分表策略垂直分库广播表水平分库(单表)水平分库(多表)水平分表HINT配置逻辑代码自定义分库分表(精准定位+范围查询)配置代码精准定位数据库精准定位+范围查询表代码仓......
  • SpringData初步学习-连接MySQL数据库
    1.添加mysql驱动和spring-data-jpa依赖<dependencies><!--SpringDataJPA--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId><......
  • java spring-data-jpa 使用方法
    SpringDataJPA是Spring生态系统的一部分,它提供了对JPA(JavaPersistenceAPI)的抽象,简化了数据访问层的开发。以下是使用SpringDataJPA的基本步骤和一些核心概念:1.添加依赖        在Maven项目的pom.xml文件中添加SpringDataJPA和相关数据库驱......