> 技术文档 > 【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

强烈推荐

前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家。点击跳转到网站:人工智能

b004071ozy_05_amzn

在开发中,日志记录是保障应用程序健壮性、可维护性的重要手段。通过日志,我们可以记录系统的运行状态、捕获异常并进行调试。

在 Spring Boot 项目中集成日志记录,可以使用常见的日志框架如 Logback 或 Log4j2。

Spring Boot 默认使用的是 Logback,但你也可以根据需求选择其他框架。以下是几种常用的日志集成方法:

1. 使用 Spring Boot 默认的 Logback 日志框架

Spring Boot 内置了 Logback,并提供了默认的日志配置。只需在 application.propertiesapplication.yml 中进行简单配置即可。

步骤:
  1. 引入依赖
    如果是标准的 Spring Boot 项目,通常不需要额外添加依赖,Logback 已经集成。如果你需要自定义日志框架,可以在 pom.xml 中手动引入依赖:

     org.springframework.boot spring-boot-starter-logging
  2. 基本配置
    可以在 application.properties 中进行基本的日志配置:

    # 控制台日志输出级别logging.level.root=INFOlogging.level.com.yourpackage=DEBUG # 定制某个包的日志级别# 日志文件输出logging.file.name=logs/spring-boot-app.loglogging.file.path=logs # 指定日志存储的路径logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} - %msg%n # 控制台日志输出格式logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n # 文件日志输出格式
  3. 日志格式调整 可以通过 Logback 的 logback-spring.xml 文件进行更详细的配置。创建 src/main/resources/logback-spring.xml 文件,内容如下:

       %d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n    logs/spring-boot-app.log  %d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n      

2. 使用 Log4j2 日志框架

如果你更喜欢使用 Log4j2,可以通过以下步骤进行集成。

步骤:
  1. 引入依赖pom.xml 中添加 Log4j2 的依赖,并排除默认的 Logback:

     org.springframework.boot spring-boot-starter-log4j2
  2. 配置 Log4j2src/main/resources 目录下创建 log4j2-spring.xml 文件,内容如下:

           %d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n             

3. 在代码中使用日志

无论你使用 Logback 还是 Log4j2,Spring Boot 都会为你注入 SLF4J 接口。在你的代码中使用 LoggerFactory 来记录日志:

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class ExampleController { private static final Logger logger = LoggerFactory.getLogger(ExampleController.class); @GetMapping(\"/example\") public String example() { logger.info(\"This is an info message\"); logger.debug(\"This is a debug message\"); logger.error(\"This is an error message\"); return \"Logging example!\"; }}

4.使用lombok.extern.slf4j.Slf4j

@Slf4j 是 Lombok 提供的一个注解,用于简化日志记录的过程。它会自动为类注入一个 org.slf4j.Logger 类型的 log 对象,让你无需手动创建 Logger 实例。@Slf4j 基于 SLF4J(Simple Logging Facade for Java),这是一个常用的日志框架接口,可以与多种日志实现(如 Logback、Log4j2 等)结合使用。

1.基本使用

在类上加上 @Slf4j 注解,Lombok 会自动为该类生成一个名为 logLogger 实例。

import lombok.extern.slf4j.Slf4j;@Slf4jpublic class ExampleService { public void doSomething() { log.info(\"This is an info message\"); log.debug(\"This is a debug message\"); log.error(\"This is an error message\"); }}
2. 日志级别

使用 @Slf4j 注解后,你可以在代码中使用 SLF4J 提供的不同级别的日志方法,例如:

  • log.trace() - 追踪日志,用于非常细节化的日志记录

  • log.debug() - 调试日志

  • log.info() - 信息日志

  • log.warn() - 警告日志

  • log.error() - 错误日志

3. 配合 Spring Boot 和日志配置

在 Spring Boot 项目中,默认使用的是 Logback 日志框架,因此不需要额外配置就可以直接使用 @Slf4j 进行日志记录。

日志级别和格式等配置可以在 application.propertieslogback-spring.xml 中进行调整。

4. 示例代码
import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Service;@Slf4j@Servicepublic class UserService { public void createUser(String username) { log.info(\"Creating user with name: {}\", username); try { // 模拟一些业务逻辑 log.debug(\"Processing user creation logic...\"); // 如果发生错误 if (username == null) { throw new IllegalArgumentException(\"Username cannot be null\"); } } catch (Exception e) { log.error(\"Error creating user: {}\", username, e); } }}

专栏推荐

大佬们可以收藏以备不时之需:

Spring Boot 专栏:http://t.csdnimg.cn/peKde

ChatGPT 专栏:http://t.csdnimg.cn/cU0na

Java 专栏:http://t.csdnimg.cn/YUz5e

Go 专栏:http://t.csdnimg.cn/Jfryo

Netty 专栏:http://t.csdnimg.cn/0Mp1H

Redis 专栏:http://t.csdnimg.cn/JuTue

Mysql 专栏:http://t.csdnimg.cn/p1zU9

架构之路 专栏:http://t.csdnimg.cn/bXAPS

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

博主深知大多数程序员,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年最新JAVA全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

这套1T的JAVA学习资料是为真正想在技术道路上突围的人准备的,内容覆盖全面:从各大厂的面试题到1000多个专业简历模板,从就业班到进阶课程,再到架构师实战与全栈高薪课程,帮助你从基础到高阶一步步提升!

无论是找工作还是技能进阶,这份VIP资料都是你不可错过的利器!加下方V了解详情,备注:JAVA开发VIP资料。

部分内容:

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

【SpringBoot系列】SpringBoot中集成日志的几种方式?_springboot 集成日志

如果有需求的可以点下方微信了解详情。

木业行业