Lombok的简单使用

最近突然有空了,准备把之前自己埋下的坑补上,无意中发现一个非常好用的工具:Lombok,于是想写一篇博文把这个工具的基本使用方法和功能在记录一下。

一、Lombok是什么

我们先来看看Lombok是个什么东西,在其官网的定义中是这样描述的:

Project Lombok is a java library that automatically plugs into your editor and build tools

由此可见,Lombok的本质是一个Java库,且能自动嵌入在我们的编辑器和构建工具中。那么Lombok又能够做到什么呢?

通过Lombok,我们可以使用简洁的注解来替代冗长的getter、setter、equals等方法,其便利性在业务频繁变动的时候尤为突出,试想每当一个实体类的属性发生变化,我们都要重写一遍get、set方法也太不方便了。那么,我们该怎么整合这个库呢?

二、Lombok如何集成到项目中

要使用Lombok,需要让编译器和项目都支持,所以我们要依次配置IDE和项目。

2.1 配置IDE

根据IDE的不同,配置方式也不同,这里我用的是IDEA,点击File -- Settings选项,搭配设置菜单,点击左侧Plugins,在右侧搜索栏输入Lombok,直接安装第一个,然后需要我们重启IDEA就可以啦。

Lombok的简单使用-小麓的博客

2.2 配置项目

之后我们还需要在项目的依赖中添加Lombok依赖,这里我的构建工具是maven,依赖代码如下:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.16</version>
    <scope>provided</scope>
</dependency>

三、Lombok的简单使用

在经过简单的配置后就可以正常使用啦,让我先来写个Demo。我们先建立一个test实体类,正常情况下加上get、set方法是这样的:

Lombok的简单使用-小麓的博客

而当我们加入Lombok后,只需要在类上加上@getter、@setter注解,就可以实现同样的效果:

Lombok的简单使用-小麓的博客

四、Lombok的一些功能

除了@getter、@setter注解以外,Lombok还有很多其他很方便的注解,这里简单介绍一些:

@Getter/@Setter

为类自动生成get、set方法。

@ToString

覆盖默认的toString方法。

@EqualsAndHashCode

覆盖默认的equals和hashCode方法

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

自动生成有无参数的构造方法

@Data

@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor几个注解的集合

@Builder

启用建造者模式

@Log

生成日志变量

五、一些总结

到这里Lombok的基本应用就完成了,这里总结一下,Lombok是一个可以减少代码量的Java库,使用它我们可以少写很多get、set以及一些构造方法等,从而达到减少工作量和解耦的目的,使用Lombok前需要配置IDE和项目依赖,然后直接引用想要使用的注解就可以了。

六、附录

6.1 参考文章

Lombok官网

Lombok有啥牛皮的?SpringBoot和IDEA官方都要支持它!

本文系作者 @ 原创发布在 小麓的博客。未经许可,禁止转载。

喜欢()
评论 (0)
150 文章
6 评论
61 喜欢
Top