引言
在开发中，日志记录是保障应用程序健壮性、可维护性的重要手段。通过日志，我们可以记录系统的运行状态、捕获异常并进行调试。
在 spring boot 项目中集成日志记录，可以使用常见的日志框架如 logback 或 log4j2。
spring boot 默认使用的是 logback，但你也可以根据需求选择其他框架。以下是几种常用的日志集成方法：
1. 使用 spring boot 默认的 logback 日志框架
spring boot 内置了 logback，并提供了默认的日志配置。只需在 application.properties 或 application.yml 中进行简单配置即可。
步骤：
引入依赖
如果是标准的 spring boot 项目，通常不需要额外添加依赖，logback 已经集成。如果你需要自定义日志框架，可以在 pom.xml 中手动引入依赖：
org.springframework.boot spring-boot-starter-logging
基本配置
可以在 application.properties 中进行基本的日志配置：
# 控制台日志输出级别
logging.level.root=info
logging.level.com.yourpackage=debug # 定制某个包的日志级别
# 日志文件输出
logging.file.name=logs/spring-boot-app.log
logging.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 # 文件日志输出格式
日志格式调整
可以通过 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，可以通过以下步骤进行集成。
步骤：
引入依赖
在 pom.xml 中添加 log4j2 的依赖，并排除默认的 logback：
org.springframework.boot spring-boot-starter-log4j2
配置 log4j2
在 src/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;
@restcontroller
public 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 会自动为该类生成一个名为 log 的 logger 实例。
import lombok.extern.slf4j.slf4j;
@slf4j
public 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.properties 或 logback-spring.xml 中进行调整。
4. 示例代码
import lombok.extern.slf4j.slf4j;
import org.springframework.stereotype.service;
@slf4j
@service
public 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);
}
}
}
