SpringBoot日志模块分析

最新推荐文章于 2024-10-04 14:48:21 发布
原创 最新推荐文章于 2024-10-04 14:48:21 发布 · 1.4k 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #spring #日志框架 #slf4j #java

本文详细介绍了日志框架的发展历程、选择与使用方法，并深入探讨了SpringBoot中日志框架的配置及适配问题。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

  • 日志是了解系统运行的显示器，了解系统的指示牌，问题追踪器，数据运营分析的基础。

1、日志框架的发展

  • log4j (log for java)：最早的日志组件是Apache基金会提供的 log4j，但是不是Apache写的，捐献给apache后，apache开源了：很长的一段时间成为类 java 社区的日志标准；
  • JUL ( Java Util Logging ) ：Apache公司建议sun将log4j收到java的标准库，但是sun拒绝了，可能为了日志市场，sun自己在jdk1.4提供的日志框架： JUL;
  • JCL (Jakarta C ommons logging) ：对于log4j和JUL两个日志框架的出现，Apache觉得开发有点混乱，没有统一的标准也没有关联，有兼容问题，于是乎开发了个 Java  Commons logging: 接口抽象层进行适配，完成了日志的兼容，并且也提供了默认的日志实现为 S im ple-Log：但可以兼容整合log4j和JUL;
  • slf4j ( sample l ogging facade for java ) : Log4j的原作者觉得apache 的Commons logging不够优秀，又使开发出了： slf4j （日志门面接口） + logback （日志的实现，是log4j的升级版）,如果想自定义实现日志，只需要添加一个logback.xml文件就可以了。 
  • lg4j2 (log for j ava2): sun公司升级log4j- >log4j2 ：由于slf4j和logback出来后，Apache感觉快超越了log4j的体系，所以就升级了log4j为log4j2；

2、日志框架的选择

在日志框架的发展历程可以看出，其中JCL和slf4j都是简单的日志门面，不是具体的日志解决方案，它只服务于各种各样的日志系统，用于提供统一的接口标准。日志通过这个门面接口被分为两个阵营：JCL(Jakarta Commons Logging)和 slf4j（sample logging facade for java)，总的来说日志的体系分为日志门面和日志的实现：
  • 日志门面：
    • JCL(2014年之后就不升级了)
    • slf4j( 推荐)
  • 日志实现： 
    • Log4j， logback是其升级版- 推荐（  和 slf4j都是同一个作者，兼容强）；
    • JUL ，jdk工具包自带的一个简单的日志工具；
    • Log4j2 ，Apache开发的优秀日志实现， 推荐；
推荐使用搭配-日志门面 + 日志实现
推荐：slf4j作为门面：然后搭配logback 或者 log4j2的日志系统：
  • 方案一：Slf4j + logback（springboot的默认日志框架）;
  • 方案二：Slf4j + log4j2;

3、日志框架的使用

官网日志使用参考： http://www.slf4j.org/manual.html
有了日志的门面接口，我们就有了统一的日志调用接口，直接去掉日志抽象层的接口方法，避免了调用日志的实现类，经典的面向接口编程的思想，类似于 JDBC 和  数据库驱动的关系，让日志的实现和调用解耦，大大提高了日志的兼容性和灵活性，使用起来也极其方便，只需要给系统导入slf4j和logback的实现jar包就OK了。 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

这样我们就可以使用日志了，这里springboot的日志使用的是logback，如果想要用其他的也是OK的，只需要导入相应的jar包即可，日志框架组合依赖包关系如下(资料参考)：

上图完美的介绍了slf4j和其他日志实现的依赖关系，使用起来也很方便。
    例如我们使用slf4j和logback的组合只需要导入相应的包就可以了，完美契合；但是如果想使用slf4和log4j，或者JUL就相对多一个适配步骤，因为在log4j出来的时候根本就没有slf4j抽象层，所以为了兼容log4j，这里又多了一个slf4j-log412.jar适配层，用来适配slf4j和log4j接口层的抽象，然后调用slf4j门面接口，就是调用log4j的接口从而调用了log4j的实现。
注意 ：每个日志框架都有自己的日志实现，所以日志的配置文件还是需要设置成日志实现的配置文件即可；

4、SpringBoot日志遗留问题-框架的切换

如果说每个系统使用着不同的日志框架实现，现在要把它统一套日志框架使用，即使是别的日志框架也要和我一起使用slf4j的日志框架；
比如：A系统的各个组件日志依赖情况如下：
  • 开发系统A: 使用slf4j + logback;
  • 依赖的Spring框架使用commons-logging
  • 依赖的Mybaties使用JUL等等；
思考：SpringBoot如何让系统中其他的日志框架统一到一种日志框架slf4j+logback呢？
  • 1、将系统中其他日志框架先排除出去；
  • 2、导入中间包来替换原有的日志框架包进行适配转换，偷天换日；
  • 3、导入我们需要的日志实现类，比如：日志门面slf4j + 日志实现log4j2；
遗留问题解决资料参考Legacy APIS:  http://www.slf4j.org/legacy.html
 
日志框架适配图
上图完美的展示了怎么解决日志遗留问题，比如我们需要把上图1中的JCL统一到slf4j + logback。
  • 第一步：排除Spring的commons-logging.jar包；
  • 第二步：导入jcl-over-slf4j.jar适配转换包，将Commons-logging API桥接转换为slf4j-api的接口；
  • 第三步：导入我们需要的slf4j和logbackjar包就OK了；
上图将解决办法展示的一目了然，十分清晰。

5、SpringBoot底层的日志框架

Springboot中依赖了很多的starter，其中有两个很重要的starter，选择其中一个starter即可。

方案一：slf4j + log4j2的日志组合框架


<dependencies>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
<dependencies>
 
方案二：默认的框架：slf4j + logback的日志组合框架 
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

但是你会发现这两个jar包里什么文件都没有，只是导入了其他的几种日志包的实现和转换包，这也是非常典型的面向接口编程思想，让使用和实现解耦，大大提高了程序的可扩展性和灵活性。通过maven依赖树分析其底层的日志包依赖关系如下：

从这个依赖关系图可以看出Springboot默认是使用 slf4j + logback的组合来实现日志的记录；
从这关系也可以看出springboot也考虑到了其他的日志框架，例如JUL，JCL和log4j这些日志框架的适配；
例如JCL框架的日志包，表面看似是使用的JCL的日志，但是底层实际上使用的是slf4j的日志，进行了日志的中间转换适配，这也是 面向接口编程的好处。
SpringBoot日志框架总结：
  • SpringBoot能适配所有的日志，而且底层默认使用slf4j + logback的方式记录日志；
  • 引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉，其他什么都不用做。
  • springboot提供了转换的中间包进行了适配，偷天换日的操作；
例如如果Spring使用了commons-loggin日志，想统一使用slf4j + logback的日志框架，SpringBoot只需要把spring的commons-loggin排除掉就可以了。 
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

6、SpringBoot日志的配置

日志框架
  • SpringBoot默认帮我们配置好了 日志slf4j + logback。
日志级别
  • SpringBoot默认的日志级别： info
  • 日志级别从低到高 ：trace < debug<info<warn<error，项目中一般到info级别就够了；设置后高级别生效；
  • 级别规则：只输出级别不低于设定级别的日志信息，例：loggers级别为INFO，则INFO、WARN、ERROR、FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出；

6.1、日志参数配置

SpringBoot默认日志输出格式： 
2017-06-05 10:57:51.112  INFO 45469 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.52
2017-06-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext

默认输出格式解析：The following items are output:

  • 时间：Date and Time — Millisecond precision and easily sortable.
  • 日志级别：Log Level —  ERROR ,  WARN ,  INFO ,  DEBUG  or  TRACE .
  • 线程id：Process ID.
  • 分隔符：A  ---  separator to distinguish the start of actual log messages.
  • 线程名字：Thread name — Enclosed in square brackets (may be truncated for console output).
  • 日志的类名：Logger name — This is usually the source class name (often abbreviated).
  • 日志信息：The log message.
参数
描述
Example
result
logging.path
指定日志路径
/var/log
输出到/var/log／spring.log文件中
logging.file
制定日志文件名
my.log
输出日志到my.log文件
logging.pattern.console
终端日志格式
 
 
logging.pattern.file
指定日志文件内容格式
 
 
日志格式参数解析：
这里分析一个日志格式 
<Properties>
    <Property name="PATTERN">%d %p [%t] %C{1} (%F:%L) [%marker] - %m%n</Property>
    <Property name="LOG_DIR">/opt/log</Property>
</Properties>

#  %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

#  %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
#  %t 输出产生该日志事件的线程名
#  %c 输出所属的类目，通常就是所在类的全名
#  %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
#  %m 输出代码中指定的消息
#  %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
#  %r 输出自应用启动到输出该log信息耗费的毫秒数
 

6.2、日志配置文件

例如项目中使用的log4j2日日志框架，直接使用log4j2.xml配置文件即可被日志框架识别加载了，绕过了spring框架。但是如果想用spring的高级特性这么办呢？
例如想要用到springboot的高级功能<SpringProfile>标签，允许日志按照某种环境来加载生效，例如： 
<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

思考：如何定义自己的日志配置文件呢？

Depending on your logging system, the following files will be loaded:
也是非常简单，使用的日志框架和相应的日志配置文件关系如下：
 
Logging System
Customization
Logback
logback-spring.xml ,  logback.xml 
Log4j2
log4j2-spring.xml  or  log4j2.xml
JDK (Java Util Logging)
logging.properties
log4j2-spring.xml：这时候该日志配置文件就会被springboot加载，可以使用springboot的高级功能< springProfile>，然后就可以指定某段配置只在某个指定的环境生效，例如设置在dev环境和不是dev下分别使用不同的日志输出格式：
<!--输出日志的格式,根据环境选择日志配置文件--> 
<springProfile name="dev">
    <PatternLayout pattern=" dev-log %d %p [%t] %C{1} (%F:%L) [%marker] - %m%n"/> 
</springProfile>
<springProfile name="!dev">
    <PatternLayout pattern=" non-dev-log %d %p [%t] %C{1} (%F:%L) [%marker] - %m%n"/>
</springProfile>

这里需要在applicaton.properties文件或者命令行中设置激活的日志文件，参数如下：

spring.profiles.active=dev

设置完成之后，日志的输出格式就会是dev环境下的格式了，非常灵活；

如果配置了springProfile但是使用的是logback.xml，则logback日志框架会因为找不到日志配置文件而报错：no applicable action for [springProfile].
 

7、 项目中日志收集流程

    为了更好的利用日志，我们一般会将日志输出到日志中心，做数据分析，告警和问题的跟踪查询，用户画像的分析等。
 
具体步骤：
  • 1、配置pom.xml中的dependency；
  • 2、配置log4j2.xml中的appender；
  • 3、配置日志名category；
  • 4、打印日志；
之后经过kafka将日志导入数据仓库做数据分析，导入日志中心进行问题定位追踪记录，导入监控平台cat做报警系统等等。

8、小结

在实际的应用中，日志是必不可少的，也是最重要的一个组件。常见 的功能包括：
  • 1、 快速定位分析问题，行为记录跟踪；
  • 2、监控 系统运行情况， 持久化数据；
  • 3、数据的统计和分析；
  • 4、当然，在很多大型的互联网应用中，基于日志的收集以及分析可以了解用户画像，比如兴趣爱好／点击行为。
 
 
参考文件：
 
 
 
 
Spring Boot在Java领域的分布式日志收集
Java大师兄的博客
05-22 1004
在现代分布式系统中，日志是系统可观测性的三大支柱之一（另外两个是指标和追踪）。随着微服务架构的普及，服务数量呈指数级增长，传统的单机日志管理方式已无法满足需求。本文旨在为Java开发者，特别是使用Spring Boot框架的团队，提供一套完整的分布式日志收集解决方案。分布式日志收集的基本概念和挑战Spring Boot应用的日志配置最佳实践主流日志收集架构的比较和选型基于ELK(Elasticsearch, Logstash, Kibana)栈的实现方案性能优化和扩展性考虑。
【微服务】springboot 多模块打包使用详解
congge
07-25 9690
springboot整合mavem多模块打包详解
springboot 日志模块
Lazy_G的博客
01-27 925
OperLog.java import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 自定义操作日志注解 * @author lkj */ @Targ
SpringBoot日志打印实践
最新发布
weixin_55850954的博客
10-04 2243
一般情况下，我们的项目会分为不同的模块，每一个模块承担不同的职责，比如bussiness模块，主要是负责业务逻辑代码的实现，业务逻辑编排等；在logback-spring.xml中，我们虽然能配置日志打印的格式，但是不够灵活，因此，我们可以添加一个日志打印工具类，通过该工具类，来自定义项目中的日志打印格式，以方便后续更好地通过日志排查、定位问题。对于不同的模块，我们希望将日志输出到不同的文件当中，从而协助我们后续定位问题以及建设不同模块下的监控，包括基础服务监控、业务成功率监控等。
springbooot自定义操作日志记录注解
kings_的博客
02-09 520
自定义操作日志记录注解 package com.ruoyi.common.annotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; im
【Spring Boot】深入解密Spring Boot日志：最佳实践与策略解析
学IT，找陈寒
05-14 2223
虽然Spring Boot提供了默认的Logback配置，但在实际应用中，我们通常需要自定义日志配置以满足特定需求。我们可以通过创建一个文件来实现自定义配置。日志是应用程序中不可或缺的一部分，合理的日志配置和管理可以极大地提升系统的可维护性和可靠性。通过Spring Boot整合Logback，并采用最佳实践和策略，我们可以实现高效的日志记录和管理，为应用程序的稳定运行保驾护航。希望本文能帮助你更好地理解和使用Spring Boot日志系统，构建更可靠的应用程序。😊🙏Java面试技巧。
【SpringBoot探索二】SpringBoot项目集成日志记录功能
01-29
该资源为博客文章"【SpringBoot探索二】SpringBoot项目集成日志记录功能"中的示例
springboot 多模块 集成mybatis redis 日志 异常统一处理，切面拦截器
12-20
springboot多模块项目，集成了mybatis，连接池，redis，日志，sql日志打印，异常统一处理，统一返回格式，mapper文件自动生成，generator xml ，切面日志和拦截器，sql注入过滤，解压即可部署打包启动，包含数据库结构sql文件，
SpringBoot中使用log4j进行日志管理示例源码
03-28
SpringBoot中使用log4j进行日志管理示例源码
springboot 日志配置文件 logback
01-13
springboot 日志配置文件 logback 它当前分为以下三个模块： logback-core：其它两个模块的基础模块。 logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如...
SpringBoot多模块例子-v2.0（建议下载）
12-04
2. **demo-base**：基础模块通常包含项目的通用组件和工具类，如日志处理、异常处理、常量定义、通用的DAO接口等。它为其他模块提供基础支持，减少代码重复，提高开发效率。 3. **demo-dao**：数据访问对象（DAO）...
SpringBoot学习笔记——AOP全局统一日志管理
12-21
一、前言 我们开发的Web系统都会有日志模块，用来记录对数据有进行变更的操作。一般都会记录请求的URL，请求的IP，执行的方法，操作人员等等。其目的可能是为了保留操作痕迹，防抵赖，或是记录系统运行情况，再有就是审计要求。 二、AOP 2.1 AOP是什么？ 360百科：在软件业，AOP为Aspect Oriented Programming的缩写，意为:面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业
Spring Boot |SpringBoot的日志框架及配置
12-21
文章目录一、常用的日志框架1.1 日志门面1.2 日志实现1.3 Spring Boot的日志框架选择二、SLF4j的使用2.1 SLF4j使用原理2.2 统一日志管理三、SpringBoot日志关系四、SpringBoot日志使用4.1 默认设置4.2 指定配置4.3 切换日志框架(不推荐) 一、常用的日志框架 市场上存在非常多的日志框架，分为日志门面(日志的抽象层)和日志实现。 1.1 日志门面 JUL（java.util.logging) JCL（ApacheCommons Logging) (JCL最后一次更新是2014年) SLF4j jboss-logging (jboss只在特
SpringBoot教程（二十九） | SpringBoot多模块构建及打包
qq_20236937的博客
09-17 1793
SpringBoot多模块构建及打包
spring springboot 日志框架
冬阳
09-18 1461
slf4j在spring boot用如何使用，如果切换到 log4j log4j2 logback使用
SpringBoot日志框架
liucy007的博客
04-07 1588
日志框架介绍 Spring 框架选择使用了 JCL 作为默认日志输出。而 Spring Boot 默认选择了 SLF4J 结合 LogBack（不需要引入额为jar包） 下图是 SLF4J 结合各种日志框架的官方示例，从图中可以清晰的看出 SLF4J API 永远作为日志的门面，直接应用与应用程序中。 统一日志框架的使用 问题：如果A项目需要使用的日志框架（slf4J + logback） 但是A项目导入使用的框架中又包含各自的日志系统： Spring（commons logging）、Hibernat
SpringBoot日志分析与使用
qq_42738387的博客
06-24 356
关于日志方面，其实我也是一知半解，想加深一下印象也为了验证和巩固自己的知识所以写下博客记录一下。（这里推荐一个b站学习资源完整的日志分析https://www.bilibili.com/video/BV1gW411W76m?p=21，这个老师讲的确实挺好的，我也是在这里学的。） 日志选择分析： 现阶段的常用java日志框架基本上就是Log4j、Log4j2、jboss-logging、Logback、slf4j、jul、jcl等等。 在使用日志的时候，基本上就是如上图一样，选择日志门面加日志实现去结合使用
SpringBoot2.x系列教程07-springboot集成日志模块
松花江畔
08-02 406
日志模块作为一个系统的重要组成部分，似乎其重要性并没有在开发人员的心中引起足够的重视，其实如果抛开其业务模块相关的内容，单纯的就系统架构设计的方面来看，系统的日志模块还是十分重要的，一个好的日志模块的设计不仅能够帮助我们检测程序的执行的状态、系统的的负载情况、更能实时监控系统的运行情况。从这一点而言，如果一个系统设计的时候没有将日志模块摆在重要的位置上，那么这个系统肯定不能称之为一个健壮的系统。 日志的技术选型 目前常用的日志框架大概有下面的几种：log4j、JUI(Java Util Logging)、
SpringBoot日志使用分析
qq_38763540的博客
07-17 943
1.日志框架 问题引述： 小张；开发一个大型系统； 1、System.out.println("")；将关键数据打印在控制台；每次都打印在控制台？去掉？写在一个文件？ 2、框架来记录系统的一些运行时信息；日志框架 ； zhanglogging.jar； 3、高大上的几个功能？异步模式？自动归档？xxxx？ zhanglogging-good.jar？ 4、将以前框架卸下来？换上新的框架，重新...
SpringBoot多模块集成Mybatis实践教程
9. Spring Boot Actuator：为了监控和管理生产环境中的Spring Boot应用，Spring Boot Actuator提供了一系列的监控端点，如健康检查、环境信息、日志信息等，有助于开发者实时监控应用状态和性能。 10. 测试策略：...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值