【Spring Boot】深入解密Spring Boot日志:最佳实践与策略解析

本文涉及的产品
全局流量管理 GTM,标准版 1个月
日志服务 SLS,月写入数据量 50GB 1个月
云解析 DNS,旗舰版 1个月
简介: 【Spring Boot】深入解密Spring Boot日志:最佳实践与策略解析

Spring Boot 日志

一. 日志的概念?

日志对我们来说并不陌⽣,通过打印日志来发现和定位问题,或者根据日志来分析程序的运行过程.

日志的用途

Spring Boot中的日志管理是非常重要的,它可以帮助开发人员在应用程序运行时跟踪问题、监控性能并记录关键信息。通过配置适当的日志级别和输出格式,开发人员可以更好地理解应用程序的行为并快速定位和解决问题。Spring Boot提供了灵活且强大的日志管理功能,使开发人员能够轻松地集成和配置各种日志框架,如Logback、Log4j2等,以满足不同项目的需求。


二. 日志

2.1 日志的格式

从上图可以看到,日志输出内容元素具体如下:

  1. 时间日期:精确到毫秒
  2. 日志级别:ERROR,WARN,INFO,DEBUG或TRACE
  3. 进程ID
  4. 线程名
  5. Logger名(通常使用源代码的类名)
  6. 日志内容
2.2 日志级别

日志级别代表着日志信息对应问题的严重性,为了更快的筛选符合⽬标的日志信息.

日志的级别从高到低依次为:FATAL、ERROR、WARN、INFO、DEBUG、TRACE

  • FATAL:致命信息,表示需要立即被处理的系统级错误.
  • ERROR:错误信息,级别较⾼的错误日志信息,但仍然不影响系统的继续运行
  • WARN:警告信息,不影响使用,但需要注意的问题
  • INFO:普通信息,用于记录应用程序正常运行时的⼀些信息,例如系统启动完成、请求处理完成等.
  • DEBUG:调试信息,需要调试时候的关键信息打印.
  • TRACE:追踪信息,比DEBUG更细粒度的信息事件(除非有特殊⽤意,否则请使用DEBUG级别替代)

日志级别的顺序:

级别越高,收到的消息越少

2.3 日志的使用

SpringBoot内置了日志框架 Slf4j ,我们可以直接调用 Slf4j 来输出日志

添加lombok依赖

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <optional>true</optional>
</dependency>

输出⽇志

lombok提供的 @Slf4j 会帮我们提供⼀个日志对象log,我们直接使用就可以.

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
  public class LogController {
    public void log(){
    log.info("--------------要输出⽇志的内容----------------");
  }
}


三. 门面模式(外观模式)

SLF4J是门面模式的典型应用(但不仅仅使⽤了门面模式).SLF4J不同于其他日志框架,它不是⼀个真正的日志实现,而是⼀个抽象层,对日志框架制定的⼀种规范,标准,接口.所有SLF4J并不能独⽴使用,需要和具体的日志框架配合使用.

门面模式定义

门面模式(FacadePattern)⼜称为外观模式,提供了⼀个统⼀的接口,用来访问子系统中的⼀群接口.

其主要特征是定义了⼀个高层接口,让子系统更容易使用.

原文:Provideaunifiedinterfacetoasetofinterfacesinasubsystem.Facadedefinesahigherlevelinterfacethatmakesthesubsystemeasiertouse.

解释:要求⼀个⼦系统的外部与其内部的通信必须通过⼀个统⼀的对象进⾏.门面模式提供⼀个⾼层 次的接⼝,使得⼦系统更易于使⽤.

门面模式主要包含2种角色: 外观角色(Facade):也称门面角色,系统对外的统⼀接口. 子系统角色(SubSystem):可以同时有⼀个或多个SubSystem.每个SubSytem都不是⼀个单独的类, 而是⼀个类的集合.SubSystem并不知道Facade的存在,对于SubSystem而⾔,Facade只是另⼀个 客户端而已(即Facade对SubSystem透明)

⽐如去医院看病,可能要去挂号,门诊,化验,取药,让患者或患者家属觉得很复杂,如果有提供接待⼈

员,只让接待⼈员来处理,就很方便.

门面模式的实现

场景:回家,我们会开各个屋的灯.离开家时,会关闭各个屋的灯 如果家⾥设置⼀个总开关,来控制整个屋的灯就会很方便.

门面模式的优点

• 减少了系统的相互依赖.实现了客户端与子系统的耦合关系,这使得子系统的变化不会影响到调⽤它

的客户端;

• 提高了灵活性,简化了客户端对子系统的使用难度,客户端无需关心子系统的具体实现方式,而只需

要和门面对象交互即可.

• 提高了安全性.可以灵活设定访问权限,不在门面对象中开通⽅法,就无法访问


四. SLF4J框架

SLF4J就是其他日志框架的门面.SLF4J可以理解为是提供日志服务的统⼀API接⼝,并不涉及到具体的

日志逻辑实现.

不引入日志门面

常见的日志框架有log4J,logback等.如果⼀个项目已经使用了log4j,而你依赖的另⼀个类库,假如是

ApacheActiveMQ,它依赖于另外⼀个日志框架logback,那么你就需要把logback也加载进去.

存在问题:

  1. 不同日志框架的API接⼝和配置⽂件不同,如果多个日志框架共存,那么不得不维护多套配置⽂件(这
    个配置⽂件是指用户⾃定义的配置⽂件).
  2. 如果要更换日志框架,应用程序将不得不修改代码,并且修改过程中可能会存在⼀些代码冲突.
  3. 如果引⼊的第三⽅框架,使用了多套,那就不得不维护多套配置.
    引入日志门面
    引⼊门面日志框架之后,应⽤程序和日志框架(框架的具体实现)之间有了统⼀的API接⼝(门面日志框架
    实现),此时应⽤程序只需要维护⼀套日志⽂件配置,且当底层实现框架改变时,也不需要更改应⽤程序代

    SLF4J就是这个日志门面.
    总的来说,SLF4J使你的代码独立于任意⼀个特定的日志API,这是⼀个对于开发API的开发者很好的思
    想.


总结

  1. 日志是程序中的重要组成部分,使用日志可以快速的发现和定位问题,SpringBoot内容了日志框
    架,默认情况下使用的是info日志级别将日志输出到控制台的,我们可以通过lombok提供的
    @Slf4j 注解和 log 对象快速的打印自定义日志.
  2. 日志包含6个级别,日志级别越高,收到的日志信息也就越少,我们可以通过配置日志的保存名称
    或保存目录来将日志持久化
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
5天前
|
监控 Java 应用服务中间件
SpringBoot是如何简化Spring开发的,以及SpringBoot的特性以及源码分析
Spring Boot 通过简化配置、自动配置和嵌入式服务器等特性,大大简化了 Spring 应用的开发过程。它通过提供一系列 `starter` 依赖和开箱即用的默认配置,使开发者能够更专注于业务逻辑而非繁琐的配置。Spring Boot 的自动配置机制和强大的 Actuator 功能进一步提升了开发效率和应用的可维护性。通过对其源码的分析,可以更深入地理解其内部工作机制,从而更好地利用其特性进行开发。
19 6
|
17天前
|
缓存 安全 Java
Spring Boot 3 集成 Spring Security + JWT
本文详细介绍了如何使用Spring Boot 3和Spring Security集成JWT,实现前后端分离的安全认证概述了从入门到引入数据库,再到使用JWT的完整流程。列举了项目中用到的关键依赖,如MyBatis-Plus、Hutool等。简要提及了系统配置表、部门表、字典表等表结构。使用Hutool-jwt工具类进行JWT校验。配置忽略路径、禁用CSRF、添加JWT校验过滤器等。实现登录接口,返回token等信息。
200 12
|
16天前
|
负载均衡 IDE Java
SpringBoot整合XXL-JOB【04】- 以GLUE模式运行与执行器负载均衡策略
在本节中,我们将介绍XXL-JOB的GLUE模式和集群模式下的路由策略。GLUE模式允许直接在线上改造方法为定时任务,无需重新部署。通过一个测试方法,展示了如何在调度中心配置并使用GLUE模式执行定时任务。接着,我们探讨了多实例环境下的负载均衡策略,确保任务不会重复执行,并可通过修改路由策略(如轮训)实现任务在多个实例间的均衡分配。最后,总结了GLUE模式和负载均衡策略的应用,帮助读者更深入理解XXL-JOB的使用。
29 9
|
15天前
|
开发框架 运维 监控
Spring Boot中的日志框架选择
在Spring Boot开发中,日志管理至关重要。常见的日志框架有Logback、Log4j2、Java Util Logging和Slf4j。选择合适的日志框架需考虑性能、灵活性、社区支持及集成配置。本文以Logback为例,演示了如何记录不同级别的日志消息,并强调合理配置日志框架对提升系统可靠性和开发效率的重要性。
|
23天前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
72 8
|
1月前
|
存储 安全 Java
Spring Boot 编写 API 的 10条最佳实践
本文总结了 10 个编写 Spring Boot API 的最佳实践,包括 RESTful API 设计原则、注解使用、依赖注入、异常处理、数据传输对象(DTO)建模、安全措施、版本控制、文档生成、测试策略以及监控和日志记录。每个实践都配有详细的编码示例和解释,帮助开发者像专业人士一样构建高质量的 API。
|
1月前
|
负载均衡 Java 开发者
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
184 5
|
2月前
|
前端开发 Java Maven
深入解析:如何用 Spring Boot 实现分页和排序
深入解析:如何用 Spring Boot 实现分页和排序
115 2
|
2月前
|
安全 JavaScript Java
SpringBoot解决跨域最佳实践
本文介绍了跨域问题的起因及最佳实践,重点讲解了SpringBoot中如何利用`CorsFilter`解决跨域问题。首先解释了由于浏览器的同源策略限制导致的跨域现象,然后提出了在服务端入口处解决跨域问题的建议,最后详细展示了三种SpringBoot中配置跨域的方法:使用默认配置、自定义配置规则以及通过配置文件管理跨域设置,以适应不同的应用场景。
|
2月前
|
Java 测试技术 数据库连接
使用Spring Boot编写测试用例:实践与最佳实践
使用Spring Boot编写测试用例:实践与最佳实践
155 0