如何使用Lombok来优雅的编码

前言

Lombok 是一种 Java™ 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注解实现这一目的。

安装Lombok

打开 IDEA 的 Settings 面板，并选择 Plugins 选项，然后点击 “Browse repositories”

在输入框输入”lombok”，得到搜索结果，点击安装，然后安装提示重启 IDEA，安装成功;

image.png

引入依赖

在自己的项目里添加 lombok 的编译支持，在 pom 文件里面添加 dependency

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

注解简述

@Data = get + set + equal + canEqual + hashCode + toString
@Setter
@Getter
@Slf4j 注解在类上；为类提供一个属性名为 log 的日志对象，提供默认构造方法。
@AllArgsConstructor 注解在类上；为类提供一个全参的构造方法
@NoArgsConstructor 注解在类上；为类提供一个无参的构造方法。
@EqualsAndHashCode 注解在类上, 可以生成 equals、canEqual、hashCode 方法。
@NonNull 注解在属性上，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常
@Cleanup 这个注解用在变量前面，可以保证此变量代表的资源会被自动关闭
@ToString 这个注解用在类上，可以生成所有参数的 toString 方法，还会生成默认的构造方法
@RequiredArgsConstructor 这个注解用在类上，使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。
@Value 这个注解用在类上，会生成含所有参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。
@SneakyThrows 这个注解用在方法上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常
@Synchronized 这个注解用在类方法或者实例方法上，效果和 synchronized 关键字相同

注解详解

@Data

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

mark

@Setter

注解在属性上；为单个属性提供 set 方法; 注解在类上，为该类所有的属性提供 set 方法，都提供默认构造方法。

mark

@Getter

注解在属性上；为单个属性提供 get 方法; 注解在类上，为该类所有的属性提供 get 方法，都提供默认构造方法。

mark

@Slf4j

注解在类上；为类提供一个属性名为 log 的日志对象，提供默认构造方法。

//类上面注解了，直接调用 log 即可：
log.info(xxxx);

@AllArgsConstructor

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

mark

@NoArgsConstructor

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

mark

@EqualsAndHashCode

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

mark

@NonNull

注解在属性上，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常，也会有一个默认的无参构造方法。

mark

@Cleanup

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

mark

@ToString

这个注解用在类上，可以生成所有参数的 toString 方法，还会生成默认的构造方法。

mark

@RequiredArgsConstructor

它们都有三个参数可以设置

1、String staticName() default "";

如果设置了它，将原来的构造方法的访问修饰符将会变成私有的，而外添加一个静态构造方法，参数相同，名字是设置的字符串的名字，访问修饰符为公有的。

2、AnyAnnotation[] onConstructor() default {};
在构造方法上添加注解。使用方法@RequiredArgsConstructor(onConstructor=@__({@AnnotationsGoHere}))}

例如我们在 Spring 项目中需要注入多个值，写很多个 @Autowired 很麻烦，就可以使用这种方式：

@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class UserServiceImpl implements IUserService {private final IUserRepository userRepository;private final IOrderRepository orderRepository;………………

3、AccessLevel access() default lombok.AccessLevel.PUBLIC;
构造函数访问修饰符；

@Value

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

mark

@SneakyThrows

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

mark

@Synchronized

这个注解用在 类方法 或者 实例方法 上，效果和 synchronized 关键字相同，区别在于锁对象不同，对于类方法和实例方法，synchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象分别是私有静态 final 对象 lock 和私有 final 对象 lock，当然，也可以自己指定锁对象，此外也提供默认的构造方法。

mark

总结

本文主要站在巨人的肩上，文章内容来源一下三篇文章。本文主要提取了三篇文章中的优点整合而成。

文章参考：

1、 https://blog.wuwii.com/springboot-15.html
2、http://kriszhang.com/lombok/
3、http://www.54tianzhisheng.cn/2018/01/09/lombok/