使用 Lombok 的 `
@Slf4j` 注解可以简化日志记录器的声明，避免手动编写 `private static final
Logger
logger =
LoggerFactory.get
Logger(XXX.class)`。以下是详细说明和代码示例：
---
### 1. **添加
Lombok 依赖**
确保项目中已引入
Lombok（Maven 示例）：
```xml
<dependency>
<groupId>org.project
lombok</groupId>
<artifactId>
lombok</artifactId>
<version>1.18.30</version>
<scope>provided</scope>
</dependency>
```
---
### 2. **
使用 `
@Slf4j` 注解**
在类上添加 `
@Slf4j`，
Lombok 会自动生成 `org.slf
4j.
Logger` 类型的 `
log`
变量。
#### 修改后的代码
```
java
import
lombok.extern.slf
4j.Slf
4j;
@Slf4j
public class Person {
private String name;
public void setName(String name) {
int length = 6
4;
String blank = " ";
if (name == null || name.trim().isEmpty()) {
String errorMsg = "姓名不能为空";
log.error(errorMsg); // 直接
使用 log 对象
throw new IllegalArgumentException(errorMsg);
}
if (name.getBytes().length > length) {
String errorMsg = "姓名长度不能超过6
4字节";
log.error(errorMsg);
throw new IllegalArgumentException(errorMsg);
}
if (name.startsWith(blank) || name.endsWith(blank)) {
String errorMsg = "姓名首尾不能有空格";
log.error(errorMsg);
throw new IllegalArgumentException(errorMsg);
}
this.name = name;
log.info("姓名设置成功: {}", name); // 示例：记录成功日志
}
}
```
---
### 3. **关键说明**
#### 3.1 生成的日志
变量
- `
@Slf4j` 会自动生成以下代码（编译
时）：
```
java
private static final org.slf
4j.
Logger
log = org.slf
4j.
LoggerFactory.get
Logger(Person.class);
```
#### 3.2 日志方法
- 支持 SLF
4J 的所有日志级别：
```
java
log.trace("Trace 级别日志");
log.debug("Debug 级别日志");
log.info("Info 级别日志");
log.warn("Warn 级别日志");
log.error("Error 级别日志");
```
#### 3.3 参数化日志
-
使用 `{}` 占位符（避免字符串拼接）：
```
java
log.info("用户 {} 尝试设置姓名 {}", userId, name);
```
---
###
4. **IDE 配置**
确保 IDE 支持
Lombok：
- **IntelliJ IDEA**：
1. 安装
Lombok 插件（`Settings → Plugins → 搜索 "
Lombok"`）。
2. 启用注解处理（`Settings → Build, Execution → Annotation Processors → 勾选 "Enable annotation processing"`）。
- **Eclipse**：
安装
Lombok 并重启 IDE（通过运行 `
lombok.jar`）。
---
### 5. **对比原始写法**
#### 原始方式（无
Lombok）
```
java
import org.slf
4j.
Logger;
import org.slf
4j.
LoggerFactory;
public class Person {
private static final
Logger
log =
LoggerFactory.get
Logger(Person.class);
private String name;
// ... 其他代码
}
```
####
使用 `
@Slf4j` 后
- 代码更简洁，减少样板代码。
---
### 6. **测试验证**
#### 测试日志输出
通过日志测试框架（如 `
Logback` 的测试工具）验证日志：
```
java
import org.junit.jupiter.api.Test;
import org.slf
4j.
Logger;
import org.slf
4j.
LoggerFactory;
import ch.qos.
logback.classic.spi.I
LoggingEvent;
import ch.qos.
logback.core.AppenderBase;
import static org.junit.jupiter.api.Assertions.*;
class PersonTest {
@Test
void testSetName_
LogsErrorWhenEmpty() {
// 模拟
Logback Appender
TestAppender appender = new TestAppender();
ch.qos.
logback.classic.
Logger root =
(ch.qos.
logback.classic.
Logger)
LoggerFactory.get
Logger(
Logger.ROOT_
LOGGER_NAME);
root.addAppender(appender);
Person person = new Person();
Exception exception = assertThrows(IllegalArgumentException.class,
() -> person.setName(""));
assertEquals("姓名不能为空", exception.getMessage());
assertTrue(appender.
logContains("姓名不能为空")); // 验证日志内容
}
}
// 自定义测试 Appender
class TestAppender extends AppenderBase<I
LoggingEvent> {
private final List<String>
logs = new ArrayList<>();
@Override
protected void append(I
LoggingEvent event) {
logs.add(event.getFormattedMessage());
}
public boolean
logContains(String message) {
return
logs.stream().anyMatch(
log ->
log.contains(message));
}
}
```
---
### 7. **
常见问题**
#### 7.1 日志未输出？
- 检查是否配置了日志实现（如 `
logback.xml`）。
- 确保类路径下有 SLF
4J 的绑定库（如 `
logback-classic`）。
#### 7.2 与其他
Lombok 注解冲突
- `
@Slf4j` 可以与其他
Lombok 注解（如 `@Data`）共存：
```
java
@Slf4j
@Data
public class User {
private String id;
}
```
#### 7.3 自定义日志名称
- 默认
使用当前类名作为日志名，如需自定义：
```
java
@Slf4j(topic = "CUSTOM_
LOGGER_NAME")
public class Custom
Logger {
//
log 对象会
使用 "CUSTOM_
LOGGER_NAME" 作为日志名
}
```
---
### 8. **性能优化建议**
- **避免字符串拼接**：始终
使用 `
log.debug("Value: {}", value)` 而非 `
log.debug("Value: " + value)`。
- **条件日志**：在日志调用前检查级别（适用于复杂日志）：
```
java
if (
log.isDebugEnabled()) {
log.debug("详细信息: {}", computeExpensive
LogMessage());
}
```
---
### 总结
- **优势**：减少样板代码，提高可读性。
- **适用场景**：所有需要日志的类（尤其是业务逻辑复杂的类）。
- **注意**：确保项目已正确配置
Lombok 和 SLF
4J 实现。
通过 `
@Slf4j`，可以更专注于业务逻辑，而非日志对象的声明和初始化。
本文介绍了在Java开发中使用Lombok的@Slf4j注解时遇到的log变量缺失问题及其解决方案。问题包括缺少Lombok插件、未启用注解处理、编译器未使用javac以及build.gradle配置不正确。通过安装Lombok插件，启用注解处理，确保使用javac作为编译器，并在build.gradle中添加Lombok为注解处理包，可以成功解决该问题。
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
