Springboot整合与使用log4j2日志框架【详解版】

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 该文介绍了如何在Spring Boot中切换默认的LogBack日志系统至Log4j2。首先,需要在Maven依赖中排除`spring-boot-starter-logging`并引入`spring-boot-starter-log4j2`。其次,创建`log4j2-spring.xml`配置文件放在`src/main/resources`下,配置包括控制台和文件的日志输出、日志格式和文件切分策略。此外,可通过在不同环境的`application.yml`中指定不同的log4j2配置文件。最后,文章提到通过示例代码解释了日志格式中的各种占位符含义。

一、引入maven依赖

Spring Boot默认使用LogBack,但是我们没有看到显示依赖的jar包,其实是因为所在的jar包spring-boot-starter-logging都是作为spring-boot-starter-web或者spring-boot-starter依赖的一部分。

如果这里要使用Log4j2,需要从spring-boot-starter-web中去掉spring-boot-starter-logging依赖,同时显示声明使用Log4j2的依赖jar包,具体如下:

<code class="language-plaintext hljs"><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId></dependency></code>

另外log4j是之前使用比较广泛的软件,容易与log4j2发生冲突,如果冲突将log4j从相应的软件里面排除掉,比如:dozer

<code class="language-plaintext hljs"><dependency><groupId>net.sf.dozer</groupId><artifactId>dozer</artifactId><version>5.4.0</version><exclusions><exclusion><groupId>org.slf4j</groupId><artifactId>slf4j-log4j12</artifactId></exclusion></exclusions></dependency></code>

二、添加配置文件log4j2-spring.xml

在resources目录下新建一个log4j2-spring.xml文件,放在src/main/resources目录下即可被Spring Boot应用识别。

<code class="language-plaintext hljs"><?xml version="1.0" encoding="UTF-8"?><configuration><properties><!--日志输出位置--><property name="LOG_HOME">D:/logs</property></properties><Appenders><!-- 将日志输出到控制台--><Console name="CONSOLE" target="SYSTEM_OUT"><!--设置日志格式及颜色--><PatternLayout

                   pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"

                   disableAnsi="false" noConsoleNoAnsi="false"/></Console><!-- 将日志输出到文件--><RollingFile name="FILE-APPENDER"

                    fileName="${LOG_HOME}/log4j2-demo.log"

                    filePattern="${LOG_HOME}/log4j2-demo-%d{yyyy-MM-dd}-%i.log"><!--设置日志格式--><PatternLayout><pattern>[%d][%p][%t][%C]%m%n</pattern></PatternLayout><Policies><!-- 设置日志文件切分参数 --><SizeBasedTriggeringPolicy size="100 MB"/><TimeBasedTriggeringPolicy/></Policies><!--设置最大存档数--><DefaultRolloverStrategy max="20"/></RollingFile></Appenders><Loggers><!-- 根日志设置 --><Root level="debug"><AppenderRef ref="CONSOLE" level="debug"/><AppenderRef ref="FILE-APPENDER" level="info"/></Root><!--spring日志--><Logger name="org.springframework" level="info"/><!-- mybatis日志 --><Logger name="com.mybatis" level="warn"/></Loggers></configuration></code>

   上文两个Appender,一个叫做CONSOLE用于输出日志到控制台,一个叫做FILE-APPENDER输出日志到文件

   PatternLayout用于指定输出日志的格式,[%d][%p][%t][%C] %m%n 这些占位符将结合下文测试结果为大家介绍

   Policies用于指定文件切分参数

   TimeBasedTriggeringPolicy默认的size是1,结合filePattern定义%d{yyyy-MM-dd},则每天生成一个文件(最小的时间切分粒度是小时)

   <SizeBasedTriggeringPolicy size="100 MB"/> 当文件大小到100MB的时候,切分一个新的日志文件

   <DefaultRolloverStrategy max="20"/>表示文件最大的存档数量,多余的将被删除

   上文中的日志格式占位符号,在文末测试的时候为大家介绍。

三、自定义配置文件

但是我们通常会有这样一个需求,就是不同的环境使用不同的配置,比如:我们需要三个log4j2 xml文件:

   log4j2-dev.xml 开发环境日志配置

   log4j2-prod.xml 生产环境日志配置

   log4j2-test.xml 测试环境日志配置

但是Spring Boot并不知道log4j2-<profile>.xml这些配置文件是干什么的,所以需要通过在application.yml文件中显示声明才行。

举例:在application-dev.yml里面使用log4j2-dev.xml配置文件

<code class="language-plaintext hljs">logging:

   config: classpath:log4j2-dev.xml</code>

以此类推,在application-prod.yml里面使用log4j2-prod.xml配置文件,在application-test.yml里面使用log4j2-test.xml配置文件。

四、测试一下

拿9.2章节的Controller测试一下

结合下面代码说一下占位符

<code class="language-plaintext hljs"><PatternLayout pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"

                   disableAnsi="false" noConsoleNoAnsi="false"/></code>

   %d : date时间

   %p : 日志级别

   %t : thread线程名称

   %C: class类文件名称

   %msg:日志信息

   %n换行

   %style{%throwable}{red} 加样式,异常信息红色显示


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
6天前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
18天前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
33 4
|
20天前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,包括版本兼容性、安全性、性能调优等方面。
111 1
|
15天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
27 0
|
10天前
|
前端开发 Java 数据库连接
Spring 框架:Java 开发者的春天
Spring 框架是一个功能强大的开源框架,主要用于简化 Java 企业级应用的开发,由被称为“Spring 之父”的 Rod Johnson 于 2002 年提出并创立,并由Pivotal团队维护。
31 1
Spring 框架:Java 开发者的春天
|
2天前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,帮助开发者提高开发效率和应用的可维护性。
10 2
|
2天前
|
消息中间件 NoSQL Java
springboot整合常用中间件框架案例
该项目是Spring Boot集成整合案例,涵盖多种中间件的使用示例,每个案例项目使用最小依赖,便于直接应用到自己的项目中。包括MyBatis、Redis、MongoDB、MQ、ES等的整合示例。
41 1
|
10天前
|
Java 数据库连接 开发者
Spring 框架:Java 开发者的春天
【10月更文挑战第27天】Spring 框架由 Rod Johnson 在 2002 年创建,旨在解决 Java 企业级开发中的复杂性问题。它通过控制反转(IOC)和面向切面的编程(AOP)等核心机制,提供了轻量级的容器和丰富的功能,支持 Web 开发、数据访问等领域,显著提高了开发效率和应用的可维护性。Spring 拥有强大的社区支持和丰富的生态系统,是 Java 开发不可或缺的工具。
|
8天前
|
Java 程序员 API
Android|集成 slf4j + logback 作为日志框架
做个简单改造,统一 Android APP 和 Java 后端项目打印日志的体验。
33 1
|
16天前
|
人工智能 开发框架 Java
总计 30 万奖金,Spring AI Alibaba 应用框架挑战赛开赛
Spring AI Alibaba 应用框架挑战赛邀请广大开发者参与开源项目的共建,助力项目快速发展,掌握 AI 应用开发模式。大赛分为《支持 Spring AI Alibaba 应用可视化调试与追踪本地工具》和《基于 Flow 的 AI 编排机制设计与实现》两个赛道,总计 30 万奖金。