【高效开发插件】10 Lombok 简化代码

介绍

Lombok 可以减少很多重复代码的书写。例如：getter/setter/toString 等方法的编写。

---

Intellij IDEA 安装 Lombok

File -> Setting -> Plugins -> Browse repositories... -> 搜索 Lombok -> install -> 安装完成后重启

---

引入依赖

在项目中添加 Lombok 依赖 jar，在 pom 文件中添加如下部分。

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

---

使用

在对应的类或者方法上使用对应的注解即可。例如：

---

注解详解

@Data

注解在类上，提供类所有属性的 get 和 set 方法，此外还提供了 equals、canEqual、hashCode、toString 方法。

@Setter

注解在属性上，为单个属性提供 set 方法，注解在类上，为该类所有的属性提供 set 方法。

@Getter

注解在属性上，为单个属性提供 get 方法，注解在类上，为该类所有的属性提供 get 方法。

@Log4j

注解在类上，为类提供一个属性名为 log 的 log4j 日志对象。

@AllArgsConstructor

注解在类上，为类提供一个全参的构造方法，加了这个注解后，类中不在提供默认构造方法。

@NoArgsConstructor

注解在类上，为类提供一个无参的构造方法。

@EqualsAndHashCode

注解在类上，可以生成 equals、canEqual、hashCode 方法。

@NonNull

注解在属性上，会自动生成一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常。

@Cleanup

这个注解用在变量前面，可以保证此变量代表的资源会被自动关闭，默认是调用资源的 close() 方法，如果该资源有其它关闭的方法，可以使用 @Cleanup(“methodName”）来指定要调用的方法，也会生成默认的构造方法

@Cleanup InputStream in = new FileInputStream(args[0]);

@ToString

这个注解在类上，可以生成所有参数的 toString 方法。

@RequiredArgsConstructor

这个注解在类上，使用类中所有带有 @NotNull 注解的或者带有 finall 修饰的成员变量生成对应的构造方法。

@Value

这个注解在类上，会生成含有所有参数的构造方法，get 方法，此外还提供了 equals、hashCode、toString 方法。

@SneakyThrows

这个注解在方法上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。

@Synchronized

这个注解用在类方法或者实例方法上，效果和 synchrozed 关键字相同，区别在于锁对象不同，对于类方法和实例方法，sunchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象。