lombok官网:https://projectlombok.org/
jar包下载路径:https://projectlombok.org/download
lombok features:https://projectlombok.org/features/all
lombok:通过注解方式减少POJO类的getter和setter等方法来消除冗余代码量
安装
1.下载 lombok.jar
2.官网说是可以双击安装,,,我用这种方法不可行
2.手动安装
(1)将lombok.jar移到eclipse的安装目录
(2)在eclipse.in文件最后加入下面两行
-Xbootclasspath/a:lombok.jar
-javaagent:lombok.jar
- =============
-javaagent:xxx.jar 的jar名称 需要与根目录下的jar名一致,
不一致,可能会出现eclipse无法启动的情况。
(3)重启eclipse,进行代码测试
原始java代码:
public class NoteTest {
private int noteId;
private String title;
private String content;
private int typeId;
}
class文件反编译后:
public class NoteTest
{
private int noteId;
private String title;
private String content;
private int typeId;
public NoteTest()
{
、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、
加入lombok注解后的java代码:
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString(exclude="typeId")
public class NoteTest {
private int noteId;
private String title;
private String content;
private int typeId;
}
加注解,经反编译:
public class NoteTest
{
private int noteId;
private String title;
private String content;
private int typeId;
public int getNoteId()
{
return noteId;
}
public String getTitle()
{
return title;
}
public String getContent()
{
return content;
}
public int getTypeId()
{
return typeId;
}
public void setNoteId(int noteId)
{
this.noteId = noteId;
}
public void setTitle(String title)
{
this.title = title;
}
public void setContent(String content)
{
this.content = content;
}
public void setTypeId(int typeId)
{
this.typeId = typeId;
}
public boolean equals(Object o)
{
if (o == this)
return true;
if (!(o instanceof NoteTest))
return false;
NoteTest other = (NoteTest)o;
if (!other.canEqual(this))
return false;
if (getNoteId() != other.getNoteId())
return false;
Object this$title = getTitle();
Object other$title = other.getTitle();
if (this$title != null ? !this$title.equals(other$title) : other$title != null)
return false;
Object this$content = getContent();
Object other$content = other.getContent();
if (this$content != null ? !this$content.equals(other$content) : other$content != null)
return false;
return getTypeId() == other.getTypeId();
}
protected boolean canEqual(Object other)
{
return other instanceof NoteTest;
}
public int hashCode()
{
int PRIME = 59;
int result = 1;
result = result * 59 + getNoteId();
Object $title = getTitle();
result = result * 59 + ($title != null ? $title.hashCode() : 43);
Object $content = getContent();
result = result * 59 + ($content != null ? $content.hashCode() : 43);
result = result * 59 + getTypeId();
return result;
}
public NoteTest()
{
}
public NoteTest(int noteId, String title, String content, int typeId)
{
this.noteId = noteId;
this.title = title;
this.content = content;
this.typeId = typeId;
}
public String toString()
{
return (new StringBuilder("NoteTest(noteId=")).append(getNoteId()).append(", title=").append(getTitle()).append(", content=").append(getContent()).append(")").toString();
}
}
常用的 lombok 注解
@EqualsAndHashCode:实现equals()方法和hashCode()方法 @ToString:实现toString()方法
@Data :注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
@Setter:注解在属性上;为属性提供 setting 方法
@Getter:注解在属性上;为属性提供 getting 方法
@Log4j :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象
@NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
@AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
@Cleanup:关闭流 @Synchronized:对象同步 @SneakyThrows:抛出异常
@Data
不使用 lombok 的方案
public class Person {
private String id;
private String name;
private String identity;
private Logger log = Logger.getLogger(Person.class);
public Person() {
}
public Person(String id, String name, String identity) {
this.id = id;
this.name = name;
this.identity = identity;
}
public String getId() {
return id;
}
public String getName() {
return name;
}
public String getIdentity() {
return identity;
}
public void setId(String id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setIdentity(String identity) {
this.identity = identity;
}
}
使用 lombok 的方案
@Data
@Log4j
@NoArgsConstructor
@AllArgsConstructor
public class Person {
private String id;
private String name;
private String identity;
}
上面的两个 java 类,从作用上来看,它们的效果是一样的,相比较之下,很明显,使用 lombok 要简洁许多
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
@Builder
不使用 lombok 的方案
public class Example<T> {
private T foo;
private final String bar;
private Example(T foo, String bar) {
this.foo = foo;
this.bar = bar;
}
public static <T> ExampleBuilder<T> builder() {
return new ExampleBuilder<T>();
}
public static class ExampleBuilder<T> {
private T foo;
private String bar;
private ExampleBuilder() {}
public ExampleBuilder foo(T foo) {
this.foo = foo;
return this;
}
public ExampleBuilder bar(String bar) {
this.bar = bar;
return this;
}
@java.lang.Override
public String toString() {
return "ExampleBuilder(foo = " + foo + ", bar = " + bar + ")";
}
public Example build() {
return new Example(foo, bar);
}
}
}
使用 lombok 的方案 guava 16.0.1
@Builder
public class Example {
private int foo;
private final String bar;
}
构造一个实例,属性不需要单独set
Example.builder().foo(1).bar(“test”).build()
参考:
http://projectlombok.org/features/index.
http://blog.csdn.net/hack8/article/details/23790579
http://blog.csdn.net/ethanq/article/details/7185610 [builder模式设计]
lombok的使用和原理
一、项目背景
在写Java程序的时候经常会遇到如下情形:
新建了一个Class类,然后在其中设置了几个字段,最后还需要花费很多时间来建立getter和setter方法
lombok项目的产生就是为了省去我们手动创建getter和setter方法的麻烦,它能够在我们编译源码的时候自动帮我们生成getter和setter方法。即它最终能够达到的效果是:在源码中没有getter和setter方法,但是在编译生成的字节码文件中有getter和setter方法
比如源码文件:
-
import java.io.Serializable;
-
import lombok.Data;
-
@Data
-
public class BasicClusterInfo implements Serializable {
-
private static final long serialVersionUID = 3478135817352393604L;
-
private String hbaseKey;
-
private int receiverCount;
-
}
以下是编译上述源码文件得到的字节码文件,对其反编译得到的结果
-
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项目的方法很简单,分为四个步骤:
1)在需要自动生成getter和setter方法的类上,加上@Data注解
2)在编译类路径中加入lombok.jar包
3)使用支持lombok的编译工具编译源代码(关于支持lombok的编译工具,见“四、支持lombok的编译工具”)
4)编译得到的字节码文件中自动生成了getter和setter方法
三、原理分析
接下来进行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)生成字节码文件
四、支持lombok的编译工具
1)由“三、原理分析”可知,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所在路径]
五、其他问题
现在使用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"。
六、lombok的罪恶
使用lombok虽然能够省去手动创建setter和getter方法的麻烦,但是却大大降低了源代码文件的可读性和完整性,降低了阅读源代码的舒适度。 这个根据自己的情况,来决定是否使用lombok
参考文献:
[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