Lombok配合@Slf4j、Logback实现日志记录

这篇博客介绍了如何在非SpringBoot项目中,结合Lombok、Slf4j和Logback来实现日志记录。首先,需要在Maven中引入这三个库的依赖。接着,配置logback.xml文件以设置日志输出格式。最后,在代码中通过Lombok的@Slf4j注解,可以轻松地进行日志打印。示例代码展示了如何在HelloWorld类中使用@Slf4j打印日志。

Lombok配合@Slf4j、Logback实现日志记录

开发过程中,需要用到lombok,但是有时候并没有用到SpringBoot框架,所以没有自动引入日志Jar,需要自己在maven中引入。

<dependency>
   <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
</dependency>

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.2.6</version>
</dependency>

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.6</version>
</dependency>

引入上述jar包,并在resources下面创建logback.xml

<?xml version="1.0" encoding="UTF-
### Lombok 中 `@Slf4j` 注解的使用方式 在 Java 项目中,Lombok 提供了 `@Slf4j` 注解,用于简化日志对象的声明。通过该注解,开发者无需手动编写日志初始化代码,Lombok 会在编译阶段自动生成对应的日志对象实例[^2]。 具体使用方式如下: 1. **添加 Lombok 依赖** 在 `pom.xml` 文件中添加 Lombok 的依赖,以确保注解处理器能够正常工作: ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.2</version> <scope>provided</scope> </dependency> ``` 2. **添加日志实现相关依赖** 如果项目中没有引入 Spring Boot 等包含日志实现的框架,则需要手动引入日志相关的依赖包,否则 `log.info()` 等方法可能无法正常调用[^3]。建议添加以下依赖: ```xml <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.25</version> <scope>test</scope> </dependency> ``` 3. **在类上添加 `@Slf4j` 注解** 在需要打印日志的类上添加 `@Slf4j` 注解,Lombok 会自动生成一个名为 `log` 的静态日志对象,类型为 `org.slf4j.Logger`。示例如下: ```java import lombok.extern.slf4j.Slf4j; import org.junit.jupiter.api.Test; @Slf4j public class Test { @Test public void test() { String test = "测试"; log.info("打印日志: {}", test); // 使用日志对象打印信息 } } ``` 4. **日志输出格式建议** 推荐使用占位符 `{}` 的方式拼接日志内容,而不是字符串拼接,这样可以提高性能并避免潜在的 `NullPointerException` 问题。 ### 常见问题与解决方案 - **日志无法输出或报错 `log cannot resolve`** 检查是否遗漏了必要的日志依赖包,如 `log4j` 和 `slf4j` 的实现包[^3]。 - **IDE 无法识别 `log` 对象** 确保 IDE 中已安装并启用了 Lombok 插件,否则无法识别注解生成的代码。 - **日志输出格式不正确** 检查 `log4j.properties` 或 `logback-spring.xml` 等日志配置文件,确保日志输出格式和级别设置正确。 --- ### 示例代码 以下是一个完整的示例类,展示如何使用 `@Slf4j` 打印日志: ```java import lombok.extern.slf4j.Slf4j; import org.junit.jupiter.api.Test; @Slf4j public class LoggingExample { @Test public void exampleTest() { String message = "Hello, Lombok!"; log.info("This is an info message: {}", message); log.warn("This is a warning message."); log.error("This is an error message."); } } ``` --- ### 日志输出效果(假设配置为控制台输出) ``` INFO LoggingExample - This is an info message: Hello, Lombok! WARN LoggingExample - This is a warning message. ERROR LoggingExample - This is an error message. ``` --- ### 日志级别说明 - `log.trace()`:最详细的日志信息,通常用于调试。 - `log.debug()`:用于调试信息。 - `log.info()`:用于记录运行时信息。 - `log.warn()`:用于记录警告信息。 - `log.error()`:用于记录错误信息。 根据项目需求,可以在配置文件中调整日志输出级别。 --- ### 总结 通过 `@Slf4j` 注解可以显著减少日志对象的初始化代码,提升开发效率。同时,结合 `log4j` 或 `logback` 等日志实现框架,可以灵活控制日志输出格式和行为。确保项目中包含必要的依赖,并在 IDE 中启用 Lombok 支持,是使用该注解的关键前提。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值