百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

一文带你搞懂SpringBoot日志如何配置?

off999 2025-01-21 20:36 21 浏览 0 评论

日志服务通常在产品设计的时候,不会被单独作为一个模块来说明,但是在很多系统架构中我们都会看到架构师在构建系统架构的时候,会将日志服务考虑在其中,当然,在现在这样的大数据背景下,很多的用户业务逻辑操作都是体现在日志中,例如在Nginx日志中可以看到请求接口访问情况,在MySQL的日志中可以分析出那些SQL执行的时间过长等等的。

那么既然这样,下面我们就来看看在Spring Boot中我们如何来处理业务日志吧?

这里需要说明 Spring Boot 的版本是 2.7.5 版本,不是最新版本,但原理都是一样。

日志级别

在讨论日志处理之前,首先我们先来了解一下什么是日志级别,常见的日志级别从低到高依次为 TRACE,DEBUG,INFO,WARN,ERROR,FATAL。

那么如何理解这个日志级别呢?一般来讲,我们在业务中处理中设置的日志级别都是INFO级别的日志,也就是说,当我们将日志设置成了INFO级别之后,比它级别更低的日志就看不到了,为什么这么做呢?

首先,日志分级别的话可以帮助开发者能够快速的定位到一些程序中出现的问题。不同级别的问题也就是代表着问题的严重性。

其次,在开发中不可能我们将所有的日志都进行收集,我们可以通过设置日志级别来排除一些在正常运行过程中其实不是那么重要的日志。

第三,通过日志的采集和分析,能够帮助我们监控应用程序的运行状态。

当然了在实际开发中日志级别的控制还可以用来做很多很多的事情,这里是笔者认为的日志分级别的几个关键点。

常见的日志框架

在日常开发中,常用到的日志框架有Log4j、LogBack、Log4j2。当然还有一些老的框架中还有一些其他的日志框架。

在这些框架中,可能听过最多的就是Log4j了吧,因为在Spring开发中我们会经常性的听到这个框架,而在Spring Boot中默认使用的是LogBack。

LogBack这个框架是基于Log4j框架开发出来的另一个开源的日志框架,与LogBack相比,性能不知道提升了多少倍,并且LogBack初始化加载的内存也变小了,或许这也是Spring Boot将其作为默认的日志框架的原因之一吧。

而Log4j2 是要比LogBack出现要晚,据官网的介绍,性能要比LogBack要更好,但是具体咱也没试过,所以这个就不需要再纠结了。因为日志框架太多了,那么如何找到一款适合项目的日志框架才是关键。下面我们就先来研究一下Spring Boot默认日志框架LogBack。

Spring Boot的默认日志框架

在上文中我们介绍了在SpringBoot中的默认的日志框架是LogBack,既然能够作为Spring Boot的默认日志框架,那么在实际的性能上,一定是经过了认证的研究的。所以在一般的开发过程中,建议先不要更换。

实际上,在Spring Boot应用创建好之后,框架就默认的将日志的相关引用也给加进去了,这就是Spring Boot的自动化配置所带来的高效之处,想想在Spring项目中还需要自己去配置依赖,引用日志组件等操作,Spring Boot框架确实是提供了很多便捷的操作。

在我们启动了Spring Boot项目之后,默认日志的级别是INFO,并且我们可以在日志中看到如下的一些内容。

  • 日志时间,精确到了毫秒级别
  • 日志级别,默认是INFO
  • 进程ID
  • 打印了日志分隔符
  • 线程名称
  • Logger的名称
  • 具体的日志内容

如何在代码中去使用日志呢?

首先在代码中添加日志,第一个目的就是为了能够追溯到业务操作流程相关信息,例如在一个IF条件判断的时候,在异常捕获的时候,都是为了能够更好的帮助我们定位问题,解决问题。那么我们如何在代码中添加日志操作呢?

在代码中添加日志操作的方式,一般来说有两种,一种是代码的方式,一种是通过Lombok注解的方式。

代码的方式

可以在业务逻辑代码中添加如下的内容。

private final Logger logger  = LoggerFactory.getLogger(TestController.class);

通过Lombok方式

想要在项目中使用Lombok,就需要先添加Lombok的相关依赖。如下所示,当然对于Lombok在开发过程中使用者对于它的评价是褒贬不一的。

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

添加完成依赖之后,就可以通过如下的方式来使用日志了。

@RestController
@Slf4j
public class TestController {   
    @GetMapping("/test")
    public String test(){
        log.info("这个是一个INFO级别的日志");
        return "Hello World!";
    }
}

看上去非常简单。使用起来也是非常方便。

如何调整日志级别呢?

既然Spring Boot提供了自动配置,那么就一定提供了日志级别的修改方式,我们可以通过如下的配置来调整SpringBoot应用的默认日志级别。

logging:
 level:
   root:DEBUG

如图所示,在我们输入调整日志级别之后,在配置文件中有如下的提示。也就是说,我们可以将整个项目的级别给设置成DEBUG级别,或者是我们可以将某个模块设置成对应的级别。

  • root:表示整个项目的日志级别
  • sql:数据库操作的日志级别
  • web:Web层日志操作级别
  • 其他包名,就是包名下的内容日志操作级别

我们可以根据自己的需要来为不同的包,不同的模块来设置合适的日志级别。

如何修改日志输出文件?

在Spring Boot中日志默认是输出到控制台中的,显然这种方式在生产环境中是不被允许的,所以我们需要去配置日志的输出路径。如下所示。

logging:
  level:
    root: debug
  file:
    path: ./log/
    name: spring.log

可以通过logging.file.path和loggin.file.name两个属性来配置,但是根据官网的文档介绍,这两个属性,我们只需要配置一个即可,否则是不生效的。

如何指定日志格式?

在默认情况下的日志格式,在项目启动的时候,就看到了。那么我们如何能够定制一下属于我们自己的日志格式呢?可以通过如下的两个属性来设置

  • logging.pattern.console:设置控制台日志格式
  • logging.pattern.file:设置日志文件中输出格式
logging:
  pattern:
    console: %d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
    file: %d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n

其中

  • yyyy/MM/dd-HH:mm:ss 表示日志输出的时间格式
  • thread 表示进程名称
  • 5level 表示日志级别
  • logger 日志输出者的名称
  • msg 日志消息
  • %n 换行符

如何自定义日志配置呢?

在Spring Boot 官方文档中,给出了根据不同的日志组件来设置不同的日志配置。例如我们默认使用的是LogBack,那么我们需要在resource目录下创建一个logback.xml的日志配置文件,就可以进行自定义的日志配置了。如图所示。

当然官方文档中还给出了其他的日志系统对应的配置文件的写法。

  • Logback:logback-spring.xml, logback.xml
  • Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2:log4j2-spring.xml, log4j2.xml
  • JDK(Java Util Logging): logging.properties

当然既然是官方推荐,那么就以Logback为主,这个时候,我们就可以在这个Logback.xml文件中开始编写自己的日志配置方式了,如下图所示。由于篇幅有限,这里就不粘贴具体的源码信息了。有兴趣的读者可以自己查阅相关资料进行配置。

总结

到这里Spring Boot日志操作相关内容就介绍完了,那么在最后我们介绍了关于如何自定义日志配置,可以通过logback.xml的方式进行配置,由于篇幅有限,没有做过多的介绍,想了解原理的读者,可以自己查阅相关资料,或者是可以留言大家一起讨论。

相关推荐

让 Python 代码飙升330倍:从入门到精通的四种性能优化实践

花下猫语:性能优化是每个程序员的必修课,但你是否想过,除了更换算法,还有哪些“大招”?这篇文章堪称典范,它将一个普通的函数,通过四套组合拳,硬生生把性能提升了330倍!作者不仅展示了“术”,更传授...

7 段不到 50 行的 Python 脚本,解决 7 个真实麻烦:代码、场景与可复制

“本文整理自开发者AbdurRahman在Stackademic的真实记录,所有代码均经过最小化删减,确保在50行内即可运行。每段脚本都对应一个日常场景,拿来即用,无需额外依赖。一、在朋...

Python3.14:终于摆脱了GIL的限制

前言Python中最遭人诟病的设计之一就是GIL。GIL(全局解释器锁)是CPython的一个互斥锁,确保任何时刻只有一个线程可以执行Python字节码,这样可以避免多个线程同时操作内部数据结...

Python Web开发实战:3小时从零搭建个人博客

一、为什么选Python做Web开发?Python在Web领域的优势很突出:o开发快:Django、Flask这些框架把常用功能都封装好了,不用重复写代码,能快速把想法变成能用的产品o需求多:行业...

图解Python编程:从入门到精通系列教程(附全套速查表)

引言本系列教程展开讲解Python编程语言,Python是一门开源免费、通用型的脚本编程语言,它上手简单,功能强大,它也是互联网最热门的编程语言之一。Python生态丰富,库(模块)极其丰富,这使...

Python 并发编程实战:从基础到实战应用

并发编程是提升Python程序效率的关键技能,尤其在处理多任务场景时作用显著。本文将系统介绍Python中主流的并发实现方式,帮助你根据场景选择最优方案。一、多线程编程(threading)核...

吴恩达亲自授课,适合初学者的Python编程课程上线

吴恩达教授开新课了,还是亲自授课!今天,人工智能著名学者、斯坦福大学教授吴恩达在社交平台X上发帖介绍了一门新课程——AIPythonforBeginners,旨在从头开始讲授Python...

Python GUI 编程:tkinter 初学者入门指南——Ttk 小部件

在本文中,将介绍Tkinter.ttk主题小部件,是常规Tkinter小部件的升级版本。Tkinter有两种小部件:经典小部件、主题小部件。Tkinter于1991年推出了经典小部件,...

Python turtle模块编程实践教程

一、模块概述与核心概念1.1turtle模块简介定义:turtle是Python标准库中的2D绘图模块,基于Logo语言的海龟绘图理念实现。核心原理:坐标系系统:原点(0,0)位于画布中心X轴:向右...

Python 中的asyncio 编程入门示例-1

Python的asyncio库是用于编写并发代码的,它使用async/await语法。它为编写异步程序提供了基础,通过非阻塞调用高效处理I/O密集型操作,适用于涉及网络连接、文件I/O...

30天学会Python,开启编程新世界

在当今这个数字化无处不在的时代,Python凭借其精炼的语法架构、卓越的性能以及多元化的应用领域,稳坐编程语言排行榜的前列。无论是投身于数据分析、人工智能的探索,还是Web开发的构建,亦或是自动化办公...

Python基础知识(IO编程)

1.文件读写读写文件是Python语言最常见的IO操作。通过数据盘读写文件的功能都是由操作系统提供的,读写文件就是请求操作系统打开一个文件对象(通常称为文件描述符),然后,通过操作系统提供的接口从这个...

Python零基础到精通,这8个入门技巧让你少走弯路,7天速通编程!

Python学习就像玩积木,从最基础的块开始,一步步搭建出复杂的作品。我记得刚开始学Python时也是一头雾水,走了不少弯路。现在回头看,其实掌握几个核心概念,就能快速入门这门编程语言。来聊聊怎么用最...

一文带你了解Python Socket 编程

大家好,我是皮皮。前言Socket又称为套接字,它是所有网络通信的基础。网络通信其实就是进程间的通信,Socket主要是使用IP地址,协议,端口号来标识一个进程。端口号的范围为0~65535(用户端口...

Python-面向对象编程入门

面向对象编程是一种非常流行的编程范式(programmingparadigm),所谓编程范式就是程序设计的方法论,简单的说就是程序员对程序的认知和理解以及他们编写代码的方式。类和对象面向对象编程:把...

取消回复欢迎 发表评论: