文章目录
以前的Java项目中,充斥着太多不友好的代码:POJO的getter/setter/toString;异常处理;I/O流的关闭操作等等,这些样板代码既没有技术含量,又影响着代码的美观,Lombok应运而生。
1. Lombok的使用
Lombok的使用非常简单:
1.1 引入相应的maven包
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
Lombok的scope=provided,说明它只在编译阶段生效,不需要打入包中。事实正是如此,Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。
1.2 添加IDE工具对Lombok的支持
IDEA中引入Lombok支持如下,配置完后记得重启
:
点击File-- Settings设置界面,安装Lombok插件
1.3 配置Annotation Processors
点击File-- Settings设置界面,开启 AnnocationProcessors:
开启该项是为了让Lombok注解在编译阶段起到作用。
2. Lombok实现原理
自从Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。
Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中,它产生作用的具体流程如下:
1. javac对源代码进行分析,生成一棵抽象语法树(AST)
2. javac编译过程中调用实现了JSR 269的Lombok程序
3. 此时Lombok就对第一步骤得到的AST进行处理,找到Lombok注解所在类对应的语法树 (AST),然后修改该语法树(AST),增加Lombok注解定义的相应树节点
4. javac使用修改后的抽象语法树(AST)生成字节码文件
3.例子
:
使用后Lombok, @Slf4j可以自动注入log对象
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class LogExampleOther {
public static void main(String... args) {
log.error("Something else is wrong here");
}
}
原有的写法:
public class LogExampleOther {
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
public static void main(String... args) {
log.error("Something else is wrong here");
}
}
4. 常见问题
下面2个问题本质基本相同,要么是没有安装bomlok插件,要么是没有正确配置Annotation Processors
4.1 Lombok Requires Annotation Processing
idea会给出以上提示信息
4.2 IDEA 提示Cannot resolve symbol ‘log’
程序中log代码报错
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class LogExampleOther {
public static void main(String... args) {
log.error("Something else is wrong here"); //此处报编译错误
}
}
如果操作都是ok的,但是仍然报错,试试把pom.xml去掉,reload mvn,再重新加入,再reload,重新编译整个工程。
参考:
《Lombok的基本使用》