一、项目背景
在写Java程序的时候经常会遇到如下情形&＃xff1a;
新建了一个Class类&＃xff0c;然后在其中设置了几个字段&＃xff0c;最后还需要花费很多时间来建立getter和setter方法
lombok项目的产生就是为了省去我们手动创建getter和setter方法的麻烦&＃xff0c;它能够在我们编译源码的时候自动帮我们生成getter和setter方法。即它最终能够达到的效果是&＃xff1a;在源码中没有getter和setter方法&＃xff0c;但是在编译生成的字节码文件中有getter和setter方法
比如源码文件&＃xff1a;
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | import java.io.Serializable;import lombok.Data;&＃64;Datapublic class BasicClusterInfo implements Serializable { private static final long serialVersionUID &＃61; 3478135817352393604L; private String hbaseKey; private int receiverCount;} |
以下是编译上述源码文件得到的字节码文件&＃xff0c;对其反编译得到的结果
| 1 2 3 4 5 6 7 8 9 10 11 | public class BasicClusterInfo extends java.lang.Object implements java.io.Serializable{ public BasicClusterInfo(); public java.lang.String getHbaseKey(); public int getReceiverCount(); public void setHbaseKey(java.lang.String); public void setReceiverCount(int); public boolean equals(java.lang.Object); public boolean canEqual(java.lang.Object); public int hashCode(); public java.lang.String toString();} |
二、使用方法
lombok网址&＃xff1a;https://projectlombok.org/download.html
Eclipse支持需要点击运行下载的jar包
Maven依赖&＃xff1a;
| 1 2 3 4 5 6 | <dependency> <groupId>org.projectlombok <artifactId>lombok <version>1.16.6 <scope>provided |
使用lombok项目的方法很简单&＃xff0c;分为四个步骤&＃xff1a;
1)在需要自动生成getter和setter方法的类上&＃xff0c;加上&＃64;Data注解
2)在编译类路径中加入lombok.jar包
3)使用支持lombok的编译工具编译源代码&＃xff08;关于支持lombok的编译工具&＃xff0c;见“四、支持lombok的编译工具”&＃xff09;
4)编译得到的字节码文件中自动生成了getter和setter方法
三、原理分析
接下来进行lombok能够工作的原理分析&＃xff0c;以Oracle的javac编译工具为例。
自从Java 6起&＃xff0c;javac就支持“JSR 269 Pluggable Annotation Processing API”规范&＃xff0c;只要程序实现了该API&＃xff0c;就能在javac运行的时候得到调用。
举例来说&＃xff0c;现在有一个实现了"JSR 269 API"的程序A,那么使用javac编译源码的时候具体流程如下&＃xff1a;
1)javac对源代码进行分析&＃xff0c;生成一棵抽象语法树(AST)
2)运行过程中调用实现了"JSR 269 API"的A程序
3)此时A程序就可以完成它自己的逻辑&＃xff0c;包括修改第一步骤得到的抽象语法树(AST)
4)javac使用修改后的抽象语法树(AST)生成字节码文件
详细的流程图如下&＃xff1a; 
lombok本质上就是这样的一个实现了"JSR 269 API"的程序。在使用javac的过程中&＃xff0c;它产生作用的具体流程如下&＃xff1a;
1)javac对源代码进行分析&＃xff0c;生成一棵抽象语法树(AST)
2)运行过程中调用实现了"JSR 269 API"的lombok程序
3)此时lombok就对第一步骤得到的AST进行处理&＃xff0c;找到&＃64;Data注解所在类对应的语法树(AST)&＃xff0c;然后修改该语法树(AST)&＃xff0c;增加getter和setter方法定义的相应树节点
4)javac使用修改后的抽象语法树(AST)生成字节码文件
四、支持lombok的编译工具
1)由“三、原理分析”可知&＃xff0c;Oracle javac直接支持lombok
2)常用的项目管理工具Maven所使用的java编译工具来源于配置的第三方工具&＃xff0c;如果我们配置这个第三方工具为Oracle javac的话&＃xff0c;那么Maven也就直接支持lombok了
3)Intellij Idea配置的编译工具为Oracle javac的话&＃xff0c;也就直接支持lombok了。
4)Eclipse中使用的不是Oracle javac这个编译工具&＃xff0c;而是自己实现的Eclipse Compiler for Java (ECJ).要想使ECJ支持lombok&＃xff0c;得进行设置&＃xff0c;具体是在Eclipse程序目录中的eclipse.ini文件中添加如下两行设置&＃xff1a;
-javaagent:[lombok.jar所在路径]
-Xbootclasspath/a:[lombok.jar所在路径]
五、其他问题
现在使用Intellij Idea作为Java项目的IDE&＃xff0c;配置Oracle javac作为编译工具。
现在有一个A类&＃xff0c;其中有一些字段&＃xff0c;没有创建它们的setter和getter方法&＃xff0c;使用了lombok的&＃64;Data注解&＃xff0c;另外有一个B类&＃xff0c;它调用了A类实例的相应字段的setter和getter方法
编译A类和B类所在的项目&＃xff0c;并不会报错&＃xff0c;因为最终生成的A类字节码文件中存在相应字段的setter和getter方法
但是&＃xff0c;IDE发现B类源代码中所使用的A类实例的setter和getter方法在A类源代码中找不到定义&＃xff0c;IDE会认为这是错误
要解决以上这个不是真正错误的错误&＃xff0c;可以下载安装Intellij Idea中的"Lombok plugin"。
六、lombok的罪恶
使用lombok虽然能够省去手动创建setter和getter方法的麻烦&＃xff0c;但是却大大降低了源代码文件的可读性和完整性&＃xff0c;降低了阅读源代码的舒适度。
参考文献
[1]http://stackoverflow.com/questions/6107197/how-does-lombok-work
[2]https://projectlombok.org/download.html
[3]http://stackoverflow.com/questions/3061654/what-is-the-difference-between-javac-and-the-eclipse-compiler
[4]http://www.ibm.com/developerworks/library/j-lombok/
[5]http://notatube.blogspot.com/2010/12/project-lombok-creating-custom.html
京公网安备 11010802041100号