什么是Lombok
一言以蔽之:lombok是一种工具,提供了简单的注解来简化我们的重复冗长Java代码。
比如一个Java Bean,注解了lombok的@Data:
@Data
public class NormalBean {
private String name;
}
等价于以下代码,Getter/Setter,toString,equals和hashCode方法会在编译时自动生成。
public class NormalBean {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
NormalBean that = (NormalBean) o;
return name != null ? name.equals(that.name) : that.name == null;
}
@Override
public int hashCode() {
return name != null ? name.hashCode() : 0;
}
@Override
public String toString() {
return "NormalBean{" +
"name='" + name + '\'' +
'}';
}
}
lombok的官网,官网上有比较详细的文档。
安装
lombok不仅要在项目中添加jar包,也要通过插件的形式开启IDE的支持。如果你的项目是maven构建的,那么需要在pom.xml中添加以下依赖:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>
这里推荐使用bom的形式管理pom依赖。比如Spring io platform里就包含了lombok的dependencyManagement。
idea
在idea下lombok的安装比较简单,在plugin里面安装lombok plugin
即可
eclipse
将lombok.jar 复制到 eclipse.ini所在文件夹的根目录
-
编辑 eclipse.ini ,在末尾加入:
-Xbootclasspath/a:lombok.jar -javaagent:lombok.jar
重启
其他的IDE添加lombok支持请看这里
用途
lombok包含了很多注解,如果全部用上,的确可以精简很多的代码。但在实际的项目中,我们常常只在定义Java Bean的时候用上lombok,而在业务代码中很少用到。因为lombok虽然能精简代码,但缺点也非常明显:
降低代码的可读性
调试困难
大部分情况下,我们都应该将代码的可读性放在编码要考虑因素的首位,以下这几个是我觉得最常用的几个lombok注解:
@Log和一系列相关注解(如@Log4j,@Slf4j)是我最喜欢的注解,不用写一堆的getLogger。还有@Builder也很方便,应付简单的Builder模式足以。
总结
lombok是个非常有用的工具,能够帮助我们精简很多臃肿冗长的代码,不过也有其局限性,推荐在定义Java Bean中使用。