【SpringBoot实战专题】「开发实战系列」全方位攻克你的技术盲区之SpringBoot整合众多日志管理系统服务starter-logging

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 【SpringBoot实战专题】「开发实战系列」全方位攻克你的技术盲区之SpringBoot整合众多日志管理系统服务starter-logging

前提介绍

Spring Boot可以使用多种日志记录工具,例如Logback、Log4J2和Java util logging等。其中,Spring Boot默认使用Logback作为日志记录工具,并将日志输出到控制台,也可以输出到文件中。您可以通过添加spring-boot-starter-logging依赖来引入Logback,而在添加其他任何Spring Boot starter时,Spring Boot都会默认引入spring-boot-starter-logging依赖,因此您无需单独添加该依赖。



如果想要使用Log4J2作为Spring Boot的日志记录工具,需要排除Logback JAR并添加Log4J2的依赖。

使用Logback记录日志的话,只需要在配置文件中配置日志级别,并且console默认输出ERROR、WARN和INFO级别的日志。可以通过修改logging.level属性来改变日志输出的级别,并且还可以通过配置logging.file或logging.path属性将日志输出到文件中,当文件大小达到10M时,会自动新建一个文件来记录日志。

Spring默认日志文件

Spring Boot 的日志文件名称默认为 spring.log。如果你没有设置 logging.file 属性,Spring Boot 将默认在应用程序的工作目录下生成一个名为 spring.log 的日志文件。你也可以通过指定 logging.file.name 或 logging.file.path 属性来自定义日志文件的名称和路径。



Spring的日志配置参数

接下来将讨论如何在application.properties、application.yml、Logback XML中配置Logback,并使用Log4j2在Spring Boot应用中进行日志配置。



  • logging.level.* : 可设置package前缀的日志级别。
  • logging.file : 配置日志输出文件名或绝对路径。
  • logging.path : 配置日志路径。如果未配置logging.file,将默认使用spring.log。
  • logging.pattern.console : 定义console内日志的样式。
  • logging.pattern.file : 定义文件中日志的样式。
  • logging.pattern.level : 定义渲染不同级别日志的格式。默认为%5p。
  • logging.exception-conversion-word : 定义日志发生异常时的转换字。
  • PID : 当前进程的ID。

logging.level

logging.level:设置日志级别,可使用TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF。可使用root级别和package级别来控制日志输入级别。创建具有以下依赖关系的应用程序。

maven配置

xml

复制代码

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

properties文件

使用src\main\resources\application.properties配置日志级别

properties

复制代码

logging.level.root= WARN
logging.level.org.springframework.security= DEBUG
logging.level.org.springframework.web= ERROR
logging.level.org.hibernate= DEBUG
logging.level.org.apache.commons.dbcp2= DEBUG

yaml文件

使用src\main\resources\application.yml

yml

复制代码

logging:
  level:
    root: WARN        
    org:
      springframework:
        security: DEBUG
        web: ERROR    
      hibernate: DEBUG        
      apache:
        commons:
          dbcp2: DEBUG

logging.file

Spring Boot默认将日志输出到控制台。如果需要将日志写入文件,可以配置logging.file或logging.path属性。logging.file属性可用于定义日志文件名和路径。

properties

复制代码

logging.level.org.springframework.security= DEBUG
logging.level.org.hibernate= DEBUG
logging.file = mylogfile.log

mylogfile.log可在根目录中创建,或以concretepage/mylogfile.log的形式在相对根目录下创建。另外,可为日志文件指定绝对路径。

application.yml中配置

yaml

复制代码

logging:
  level:
    org:
      springframework:
        security: DEBUG
    hibernate: DEBUG
  file: mylogfile.log

logging.path

配置logging.path或logging.file属性可将日志写入文件。logging.path属性用于定义日志文件夹路径。可在application.properties文件中进行配置。

application.properties配置

yaml

复制代码

logging.level.org.springframework.security= DEBUG
logging.level.org.hibernate= DEBUG
logging.path = concretepage/logs

spring.log日志文件将被创建在concretepage/logs文件夹下,该文件夹相对于项目根目录的路径。同时,也可以通过配置绝对路径的方式来定义日志文件的位置。

application.yml配置

yaml

复制代码

logging:
  level:
    org:
      springframework:
        security: DEBUG
    hibernate: DEBUG
  path: concretepage/logs

logging.patter.console

我们可以通过设置 logging.pattern.console 属性,来改变输出到控制台的日志展示样式。具体展示样式包括时间、日志级别、线程名、日志名、以及消息。您可以自由调整这些样式,以满足个人偏好。

application.properties配置

properties

复制代码

logging.level.org.springframework.security= DEBUG
logging.level.org.hibernate= DEBUG
logging.pattern.console= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n

application.yml配置

yaml

复制代码

logging:
  level:
    org:
      springframework:
        security: DEBUG
    hibernate: DEBUG
  pattern:
    console: '%d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n'

logging.pattern.file

为了使文件中的日志样式更加符合我们的需求,我们需要设置logging.pattern.file属性。这可以通过以下步骤实现:

  1. 通过logging.file或logging.path属性,将日志记录到文件中。可以根据实际需求,选择logging.file指定日志文件名和路径,或logging.path指定日志文件夹路径,Spring Boot将自动创建一个名为spring.log的日志文件。
  2. 编辑application.properties文件,添加以下内容:

perl

复制代码

logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

该属性设置了一个包含时间戳、线程、日志级别、日志名和消息的样式。您可以根据实际需求进行调整。

  1. 运行应用程序,新的日志样式将应用于记录在文件中的日志。

注意,在实际运行中,您还可以使用其他的日志属性和样式进行设置,以满足您的实际需求。此外,对于较大的日志文件,您可以考虑使用日志文件的滚动策略来降低文件大小。

ini

复制代码

logging.level.org.springframework.security= DEBUG
logging.level.org.hibernate= DEBUG
logging.path = concretepage/logs
logging.pattern.file= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n
logging.pattern.console= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n

使用logging.path属性可以在应用程序的根目录下创建concretepage/logs目录,并默认使用spring.log作为文件名保存日志文件。另外,您可以通过设置logging.pattern.console属性来指定控制台上的日志样式,以便更好地显示日志信息。

通过命令行改变日志的输出级别

Sping Boot 默认输出ERROR , WARN , INFO 级别的日志。我们可以通过命令行使能DEBUG ,TRACE级别的日志输出,效果是跟配置文件一样的。想象我们有一个名为my-app.jar的可执行的JAR包我们可以在启动应用是使能DEBUG级别日志输出。

shell

复制代码

java -jar my-app.jar --debug

在application.properties

ini

复制代码

debug=true

application.yml

lua

复制代码

debug:true

相同的方式使能TRACE级别的日志

css

复制代码

java -jar my-app.jar --trace

application.properties

ini

复制代码

trace=true

application.yml

vbnet

复制代码

trace: true

内容总结

spring-boot-starter-logging是Spring Boot提供的一个用于配置日志相关依赖的starter,它提供了对常见的日志框架的支持,包括Logback、Log4j2和Java Util Logging(JUL)。

使用spring-boot-starter-logging可以方便地配置和使用日志框架,并且能够自动适配多种不同的日志框架,使得开发者能够快速地切换和选择适合自己的日志框架。

在使用spring-boot-starter-logging时,可以通过配置文件来自定义日志级别、日志格式和输出目标等信息。比如,可以使用application.properties配置文件来配置日志输出的格式:

perl

复制代码

logging.pattern.console=%d{HH:mm:ss.SSS} [%thread] %level %logger{36} - %msg%n

该配置将格式化控制台输出的日志信息,以小时:分钟:秒.毫秒、线程id、日志级别、logger名称和消息的形式输出。

此外,Spring Boot还提供了对于常见的日志框架的自动配置,如自动配置Logback日志框架,即可以使用logback.xmllogback-spring.xml进行配置,这些配置文件需要放置在classpath路径下,Spring Boot会自动地读取和解析这些配置文件来进行日志的记录。

总之,spring-boot-starter-logging为开发者提供了一个便捷、易用的日志配置和使用解决方案,能够让开发者更加专注于业务代码的开发,而不必花费过多的精力来配置和处理日志相关的细节问题。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
8天前
|
Java 中间件
SpringBoot入门(6)- 添加Logback日志
SpringBoot入门(6)- 添加Logback日志
43 5
|
1月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
162 2
|
9天前
|
监控 开发者
鸿蒙5.0版开发:使用HiLog打印日志(ArkTS)
在HarmonyOS 5.0中,HiLog是系统提供的日志系统,支持DEBUG、INFO、WARN、ERROR、FATAL五种日志级别。本文介绍如何在ArkTS中使用HiLog打印日志,并提供示例代码。通过合理使用HiLog,开发者可以更好地调试和监控应用。
47 16
|
9天前
|
XML Java 数据库连接
SpringBoot集成Flowable:打造强大的工作流管理系统
在企业级应用开发中,工作流管理是一个核心组件,它能够帮助我们定义、执行和管理业务流程。Flowable是一个开源的工作流和业务流程管理(BPM)平台,它提供了强大的工作流引擎和建模工具。结合SpringBoot,我们可以快速构建一个高效、灵活的工作流管理系统。本文将探讨如何将Flowable集成到SpringBoot应用中,并展示其强大的功能。
34 1
|
16天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
32 1
|
18天前
|
JavaScript Java 项目管理
Java毕设学习 基于SpringBoot + Vue 的医院管理系统 持续给大家寻找Java毕设学习项目(附源码)
基于SpringBoot + Vue的医院管理系统,涵盖医院、患者、挂号、药物、检查、病床、排班管理和数据分析等功能。开发工具为IDEA和HBuilder X,环境需配置jdk8、Node.js14、MySQL8。文末提供源码下载链接。
|
24天前
|
自然语言处理 Java API
Spring Boot 接入大模型实战:通义千问赋能智能应用快速构建
【10月更文挑战第23天】在人工智能(AI)技术飞速发展的今天,大模型如通义千问(阿里云推出的生成式对话引擎)等已成为推动智能应用创新的重要力量。然而,对于许多开发者而言,如何高效、便捷地接入这些大模型并构建出功能丰富的智能应用仍是一个挑战。
94 6
|
27天前
|
存储 安全 Java
打造智能合同管理系统:SpringBoot与电子签章的完美融合
【10月更文挑战第7天】 在数字化转型的浪潮中,电子合同管理系统因其高效、环保和安全的特点,正逐渐成为企业合同管理的新宠。本文将分享如何利用SpringBoot框架实现一个集电子文件签字与合同管理于一体的智能系统,探索技术如何助力合同管理的现代化。
61 4
|
27天前
|
前端开发 Java Apache
SpringBoot实现电子文件签字+合同系统!
【10月更文挑战第15天】 在现代企业运营中,合同管理和电子文件签字成为了日常活动中不可或缺的一部分。随着技术的发展,电子合同系统因其高效性、安全性和环保性,逐渐取代了传统的纸质合同。本文将详细介绍如何使用SpringBoot框架实现一个电子文件签字和合同管理系统。
50 1
|
30天前
|
文字识别 安全 Java
SpringBoot3.x和OCR构建车牌识别系统
本文介绍了一个基于Java SpringBoot3.x框架的车牌识别系统,详细阐述了系统的设计目标、需求分析及其实现过程。利用Tesseract OCR库和OpenCV库,实现了车牌图片的识别与处理,确保系统的高准确性和稳定性。文中还提供了具体的代码示例,展示了如何构建和优化车牌识别服务,以及如何处理特殊和异常车牌。通过实际应用案例,帮助读者理解和应用这一解决方案。