如何在 Gradle 项目中正确使用 Lombok 的 @Slf4j 注解

雨敏小哥_4064

雨敏小哥_4064

2026-07-26

174人浏览

原创

如何在 Gradle 项目中正确使用 Lombok 的 @Slf4j 注解

本文详解在 Java + Gradle 项目中启用 Lombok @Slf4j 注解的完整配置:需同时引入 SLF4J API 和具体实现(如 Logback),并确保 Lombok 编译期处理生效,缺一不可。

本文详解在 java + gradle 项目中启用 lombok `@slf4j` 注解的完整配置:需同时引入 slf4j api 和具体实现(如 logback),并确保 lombok 编译期处理生效,缺一不可。

@Slf4j 是 Lombok 提供的便捷日志注解,它会在编译时自动为类生成一个名为 log 的静态 SLF4J 日志器字段(类型为 org.slf4j.Logger)。但该注解本身不提供日志实现,仅依赖 SLF4J API —— 因此必须显式添加 SLF4J 的 API 包和至少一个绑定实现(如 Logback 或 Log4j2),否则会出现 package org.slf4j does not exist 或 Cannot resolve method 'info(String)' 等编译错误。

你的 build.gradle 中存在两个关键问题:

  1. 缺失 SLF4J API 依赖:@Slf4j 需要 org.slf4j:slf4j-api,但当前只引入了 log4j:2.20.0(这是 Apache Log4j 1.x 的旧版,且未与 SLF4J 绑定);
  2. Lombok 仅声明为 compileOnly,但未配置 annotationProcessor 对 Java 编译器生效(Gradle 7.0+ 推荐改用 annotationProcessor,但需确保其作用于主源集)。

✅ 正确配置如下(推荐使用主流、轻量的 Logback 实现):

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
plugins {
    id 'java'
}

group = 'org.example'
version = '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    // ✅ 必须:SLF4J API(@Slf4j 编译所需)
    implementation 'org.slf4j:slf4j-api:2.0.13'

    // ✅ 必须:SLF4J 的具体实现(Logback 是默认推荐)
    runtimeOnly 'ch.qos.logback:logback-classic:1.5.6'

    // ✅ Lombok:用于编译期代码生成
    compileOnly 'org.projectlombok:lombok:1.18.32'
    annotationProcessor 'org.projectlombok:lombok:1.18.32'

    // 测试依赖(保持不变)
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.2'
}

// ✅ 启用注解处理器(Gradle 6.0+ 默认启用,但显式声明更可靠)
java {
    sourceCompatibility = JavaVersion.VERSION_17
    targetCompatibility = JavaVersion.VERSION_17
}

⚠️ 注意事项:

  • 不要混用 log4j(1.x)或 log4j-core(2.x)作为 SLF4J 实现 —— 若坚持使用 Log4j2,请替换为 org.apache.logging.log4j:log4j-slf4j2-impl:2.21.0(注意是 slf4j2-impl,非 log4j),并移除 logback-classic;
  • IDE(如 IntelliJ)需安装 Lombok Plugin 并启用 "Enable annotation processing"(Settings → Build → Compiler → Annotation Processors);
  • @Slf4j 生成的 log 字段是 private static final,因此可直接在 main 方法中调用 log.info("hello");
  • 若仍报错,请执行 ./gradlew clean build --refresh-dependencies 并重启 IDE。

修复后,你的代码将正常工作:

package MyApp;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class MyApp {
    public static void main(String[] args) {
        log.info("Hello, SLF4J + Lombok is working!"); // ✅ 编译通过,运行输出日志
    }
}

总结:@Slf4j 不是“开箱即用”的魔法,而是 SLF4J 生态与 Lombok 编译插件协同工作的结果。牢记三要素:SLF4J API(编译)、SLF4J 实现(运行)、Lombok 注解处理器(编译期生成代码)。任一缺失都会导致编译失败。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9617

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6762

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5992

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1276

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2529

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19851

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习