Lombok的使用详解与插件安装

雨点打透心脏的1/2处 2022-02-01 04:49 318阅读 0赞

JAVA面向对象编程中的封闭性和安全性。封闭性即对类中的域变量进行封闭操作，即用private来修饰他们，如此一来其他类则不能对该变量访问。这样我们就将这些变量封闭在了类内部，这样就提高了数据的安全性，当我们想要操作这些域变量怎么办呢？

我们可以通过两种方法，第一种即通过public方式的构造器（或称构造函数），对象一实例化就对该变量赋值。第二种就是通过set和get方法进行赋值和取值，这样就能提高域变量的安全性，同时又保证了域变量的封装型。

所以当我们创建POJO类时，都会毫不犹豫的让开发工具对域变量生成set，get方法，虽然不是我们自己手动添加，但每个类都要做重复的生成操作，而且当变量名或者是修饰符改变了，我们就要删除set，get方法重新生成。那么我们怎么做能提高生产效率，不做重复工作呢？对，就是lombok。

**lombok**

lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。通过使用对应的注解，可以在编译源码的时候生成对应的方法，所以不会影响任何运行效率。

常用的 lombok 注解：

@Data   ：注解在类上；包含了@ToString，@EqualsAndHashCode，@Getter / @Setter和@RequiredArgsConstructor的功能，提供类所有属性的 getter 和 setter 方法，此外还提供了equals、canEqual、hashCode、toString 方法

@Setter：注解在属性上；为属性提供 setter 方法

@Getter：注解在属性上；为属性提供 getter 方法

@ToString：注解在类上；生成toString()方法，默认情况下，它会按顺序（以逗号分隔）打印你的类名称以及每个字段。可以这样设置不包含哪些字段@ToString(exclude = "id") / @ToString(exclude = \{"id","name"\})

如果继承的有父类的话，可以设置callSuper 让其调用父类的toString()方法，例如：@ToString(callSuper = true)

@EqualsAndHashCode：注解在类上；生成hashCode()和equals()方法，默认情况下，它将使用所有非静态，非transient字段。但可以通过在可选的exclude参数中来排除更多字段。或者，通过在parameter参数中命名它们来准确指定希望使用哪些字段。

@NonNull：  注解在属性上；标识属性是不能为空，为空则抛出异常。

@Slf4j ：注解在类上；根据用户实际使用的日志框架生成log日志对象。

@Log4j ：注解在类上；为类提供一个 属性名为log 的 log4j 日志对象

@NoArgsConstructor：注解在类上；为类提供一个无参的构造方法。当类中有final字段没有被初始化时，编译器会报错，此时可用@NoArgsConstructor(force = true)，然后就会为没有初始化的final字段设置默认值 0 / false / null。对于具有约束的字段（例如@NonNull字段），不会生成检查或分配，因此请注意，正确初始化这些字段之前，这些约束无效。

@AllArgsConstructor：注解在类上；为类提供一个全参的构造方法

默认生成的方法是public的，如果要修改方法修饰符可以设置AccessLevel的值，例如：@Getter(access = AccessLevel.PROTECTED)

@RequiredArgsConstructor：注解在类上；会生成构造方法（可能带参数也可能不带参数），如果带参数，这参数只能是以final修饰的未经初始化的字段，或者是以@NonNull注解的未经初始化的字段@RequiredArgsConstructor(staticName = "of")会生成一个of()的静态方法，并把构造方法设置为私有的。

![78640202][]![78640202][]![20171127152422699][]

**安装配置**

加一些注解就能搞定很多事情，是不是很好用，既然很好用，花两分钟时间配置一下，不勉为其难吧。

一. 要使用注解，必须引入lombok提供的库

maven引入依赖：

1.  `<dependency>    `
2.  `    <groupId>org.projectlombok</groupId>    `
3.  `    <artifactId>lombok</artifactId>`
4.  `</dependency>`

gradle引入依赖：

compile group: 'org.projectlombok', name: 'lombok', version: '1.16.18'

二. 开发工具插件安装

idea：

![78640202][]![Center][]

![78640202][]

![78640202][]![Center 1][]

![Center 2][]

STS:

1.  下载最新的lombok，https://projectlombok.org/download.html
2.   切到lombok下载的目录，运行命令： java -jar lombok.jar

![78640202][]![Center 3][]

![78640202][]![Center 4][]

![78640202][]

切到sts的安装目录，验证一下STS.ini文件：

![Center 5][]

eclipse

eclipse安装方式过程同STS，安装完成之后，请确认eclipse安装路径下是否多了一个lombok.jar包，并且其配置文件eclipse.ini中是否 添加了如下内容:

-javaagent:lombok.jar

-Xbootclasspath/a:lombok.jar

在日常开发中，我们尽量少直接使用@Data注解

而是换成@Setter、@Getter、@NoArgsConstructor、@AllArgsConstructor、@ToString即可

[78640202]: /images/20220201/c32eebe94fe1441f94c800bd7cf9ce9c.png
[20171127152422699]: /images/20220201/4f6ba44e1d6a4048963313347c9309bc.png
[Center]: /images/20220201/dd3129e00c664181968ec1ea470964c5.png
[Center 1]: /images/20220201/6720ed4cfea0498e834e801f1f5fd233.png
[Center 2]: /images/20220201/efb73fa319704abd831eb2f3a4d75e82.png
[Center 3]: /images/20220201/a98fc7355d67429ea58e46d6f2bf4f88.png
[Center 4]: /images/20220201/7803ba43d612477ea4a59296c0b515f4.png
[Center 5]: /images/20220201/576161ebed54453b93f5eebc752e9dde.png