lombok主要作用是针对代码开发中,针对实体经常需要大量的setter、getter、 hashCode、 equals、 toString方法,通过此工具可以免去相关处理。
原理如下:
接下来进行lombok能够工作的原理分析,以Oracle的javac编译工具为例。
自从Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。
举例来说,现在有一个实现了”JSR 269 API”的程序A,那么使用javac编译源码的时候具体流程如下:
1) javac对源代码进行分析,生成一棵抽象语法树(AST)
2) 运行过程中调用实现了”JSR 269 API”的A程序
3) 此时A程序就可以完成它自己的逻辑,包括修改第一步骤得到的抽象语法树(AST)
4) javac使用修改后的抽象语法树(AST)生成字节码文件
详细的流程图如下:
lombok本质上就是这样的一个实现了”JSR 269 API”的程序。在使用javac的过程中,它产生作用的具体流程如下:
1)javac对源代码进行分析,生成一棵抽象语法树(AST)
2)运行过程中调用实现了”JSR 269 API”的lombok程序
3)此时lombok就对第一步骤得到的AST进行处理,找到@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加getter和setter方法定义的相应树节点
4)javac使用修改后的抽象语法树(AST)生成字节码文件
支持的编译工具:
- 由“三、原理分析”可知,Oracle javac直接支持lombok
- 常用的项目管理工具Maven所使用的java编译工具来源于配置的第三方工具,如果我们配置这个第三方工具为Oracle javac的话,那么Maven也就直接支持lombok了
- Intellij Idea配置的编译工具为Oracle javac的话,也就直接支持lombok了。
- Eclipse中使用的不是Oracle javac这个编译工具,而是自己实现的Eclipse Compiler for Java (ECJ).要想使ECJ支持lombok,得进行设置,具体是在Eclipse程序目录中的eclipse.ini文件中添加如下两行设置:
-javaagent:[lombok.jar所在路径]
-Xbootclasspath/a:[lombok.jar所在路径]
****************************************************************************************************************************
针对maven项目配置如下
1、引入依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
2、配置插件
<build>
<plugins>
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.16.18.1</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
只有在install的时候才会在对应实体生成方法(eclipse中RUN AS -> INSTALL)