lombok的使用和原理

1、项目背景
在写Java程序的时候常常会遇到以下情形：
新建了一个Class类，而后在其中设置了几个字段，最后还须要花费不少时间来创建getter和setter方法
lombok项目的产生就是为了省去咱们手动建立getter和setter方法的麻烦，它可以在咱们编译源码的时候自动帮咱们生成getter和setter方法。即它最终可以达到的效果是：在源码中没有getter和setter方法，可是在编译生成的字节码文件中有getter和setter方法
好比源码文件：

 

1. import java.io.Serializable;  
2.   
3.   
4. import lombok.Data;  
5.   
6.   
7. @Data   
8. public class BasicClusterInfo implements Serializable {  
9.   
10.   
11.     private static final long serialVersionUID = 3478135817352393604L;  
12.     private String            hbaseKey;  
13.     private int               receiverCount;  
14. }  

如下是编译上述源码文件获得的字节码文件，对其反编译获得的结果

 

1. public class BasicClusterInfo extends java.lang.Object implements java.io.Serializable{  
2.     public BasicClusterInfo();  
3.     public java.lang.String getHbaseKey();  
4.     public int getReceiverCount();  
5.     public void setHbaseKey(java.lang.String);  
6.     public void setReceiverCount(int);  
7.     public boolean equals(java.lang.Object);  
8.     public boolean canEqual(java.lang.Object);  
9.     public int hashCode();  
10.     public java.lang.String toString();  
11. }  

2、使用方法
使用lombok项目的方法很简单，分为四个步骤：
1)在须要自动生成getter和setter方法的类上，加上@Data注解
2)在编译类路径中加入lombok.jar包
3)使用支持lombok的编译工具编译源代码（关于支持lombok的编译工具，见“4、支持lombok的编译工具”）
4)编译获得的字节码文件中自动生成了getter和setter方法


3、原理分析
接下来进行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)生成字节码文件


4、支持lombok的编译工具
1)由“3、原理分析”可知，Oracle javac直接支持lombok
2)经常使用的项目管理工具Maven所使用的java编译工具来源于配置的第三方工具，若是咱们配置这个第三方工具为Oracle javac的话，那么Maven也就直接支持lombok了
3)Intellij Idea配置的编译工具为Oracle javac的话，也就直接支持lombok了。
4)Eclipse中使用的不是Oracle javac这个编译工具，而是本身实现的Eclipse Compiler for Java (ECJ).要想使ECJ支持lombok，得进行设置，具体是在Eclipse程序目录中的eclipse.ini文件中添加以下两行设置：
-javaagent:[lombok.jar所在路径]
-Xbootclasspath/a:[lombok.jar所在路径]


5、其余问题
如今使用Intellij Idea做为Java项目的IDE，配置Oracle javac做为编译工具。
如今有一个A类，其中有一些字段，没有建立它们的setter和getter方法，使用了lombok的@Data注解，另外有一个B类，它调用了A类实例的相应字段的setter和getter方法
编译A类和B类所在的项目，并不会报错，由于最终生成的A类字节码文件中存在相应字段的setter和getter方法
可是，IDE发现B类源代码中所使用的A类实例的setter和getter方法在A类源代码中找不到定义，IDE会认为这是错误
要解决以上这个不是真正错误的错误，能够下载安装Intellij Idea中的"Lombok plugin"。


6、lombok的罪恶
使用lombok虽然可以省去手动建立setter和getter方法的麻烦，可是却大大下降了源代码文件的可读性和完整性，下降了阅读源代码的温馨度。




参考文献：
[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