在项目开发中，我们时常遇到需要创建实体类，一般的做法是： 先写成员变量， 再提供get()、set()相对应的方法，然后看是否需要提供toString等方法。这样一来会发现每写一个实体类的话就会有很多类似相同的操作，而且代码量看起来也很多，不是很简洁。当然这些实体类我们也可以借助工具一键生成或是干脆直接用注解的形式，只有成员变量，没有get、set相关方法。

今天给大家推荐一个插件Lombok

1. Lombok简介

官方介绍

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

大意是Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。

简而来说：Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

2. Lombok使用

如何在IDEA上进行安装Lombok：

首先点开File下的Settings，然后点Plugins，然后点击下面的Browse repositories，然后在搜索框内搜索lombok， 然后有个install按钮进行安装，安装完后重启下IDEA就好了。

安装好了lombok，我们还需要把lombok依赖到我们项目。

添加maven依赖

org.projectlombok

lombok

1.18.4

provided

下面我们来尝试下，使用lombok注解后，我们的实体类

@Data这个注解是lombok包下的一个注解，而这个注解是用在类上的

@Data

public class User {

private int userId;

private String userName;

}

这个注解其实是帮我们的类提供了get()、set()方法、equals()、hashCode()、toString() 这些方法。也就是说只要你的类上写了这个注解，那就不需要再生成get、set、toString等方法了。类似我们在做Android开发的时候，看到一大堆FindViewById()很繁琐的代码，我们借助ButterKnife插件一样。

常用注解

下面介绍一下常用的几个注解：

@Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

@Getter 使用方法同上，区别在于生成的是getter方法。

@ToString 注解在类，添加toString方法。

@EqualsAndHashCode 注解在类，生成hashCode和equals方法。

@NoArgsConstructor 注解在类，生成无参的构造方法。

@RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

@AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。

@Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

@Slf4j 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

Lombok这个插件，确实工作效率提高了不少。

Lombok的优缺点

优点：

通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率

让代码变得简洁，不用过多的去关注相应的方法

属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

对于缺点，官网提到了两点，第一不支持多种参数构造器的重载

第二，虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度。

对于第二点，我并不怎么认同，实体类的set 和get 可读性并不是很重要，谁又会去关注这些呢？

开源项目github地址：github.com/JourWon/test-lombok