lombok小辣椒的使用

news/2024/10/31 1:34:00/

lombok介绍

lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具，简单来说，比如我们新建了一个类，然后在其中写了几个字段，然后通常情况下我们需要手动去建立getter和setter方法啊，构造函数啊之类的，lombok的作用就是为了省去我们手动创建这些代码的麻烦，它能够在我们编译源码的时候自动帮我们生成这些方法。

lombok能够达到的效果就是在源码中不需要写一些通用的方法，但是在编译生成的字节码文件中会帮我们生成这些方法，这就是lombok的神奇作用。

虽然有人可能会说IDE里面都自带自动生成这些方法的功能，但是使用lombok会使你的代码看起来更加简洁，写起来也更加方便。

lombok引入

maven工程项目中，在pom.xml中引入

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.18</version>
</dependency>

lombok最新版本为1.18.2

eclipse安装lombok插件

IDE中若是不添加lombok插件，IDE识别不了lombok注解，想lombok注解生效，必须在IDE中添加lombok插件。

下面介绍eclipse插件安装

下载插件

lombok.jar下载: https://projectlombok.org/download

将下载的lombok.jar放入eclipse根目录。

lombok存放目录

修改配置

修改eclipse.ini文件, 在配置文件中最后一行添加-javaagent:lombok.jar

-startup
plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20140603-1326
-product
org.eclipse.epp.package.jee.product
--launcher.defaultAction
openFile
--launcher.XXMaxPermSize
256M
-showsplash
org.eclipse.platform
--launcher.XXMaxPermSize
256m
--launcher.defaultAction
openFile
--launcher.appendVmargs
-vmargs
-Dosgi.requiredJavaVersion=1.6
-Xms40m
-Xmx512m
-javaagent:lombok.jar

修改配置文件

IDEA安装lombok插件

Flie->Settings->plugins->Browse repositories
IDEA安装lombok插件

lombok使用

lombok使用过程中主要是靠注解起作用的，下面只说明其中几个比较常用的。

@NonNull : 注解在参数上, 如果该类参数为 null , 就会报出异常,  throw new NullPointException(参数名)
@Cleanup : 注释在引用变量前, 自动回收资源 默认调用 close() 方法
@Getter/@Setter : 注解在类上, 为类提供读写属性
@Data : 注解在类上, 为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法
@NoArgsConstructor: 自动生成无参数构造函数。
@AllArgsConstructor: 自动生成全参数构造函数。

官方文档: https://projectlombok.org/features/all