SpringBoot - Lombok使用详解1（基本介绍、安装配置、var和val）

我们创建 POJO 类时，经常需要先写属性，然后手写或者自动生成 get 和 set 方法，然后还要重写 toString 方法....一系列操作下来，这个 POJO 类便会产生太多的样板式代码。

    这种传统的方式不仅使得代码十分臃肿，有时也不方便维护，比如：当变量名或者是修饰符改变了，我们就要删除 set、get 方法重新生成。

    而 Lombok 出现就是为了解决代码书写的冗余问题，下面对其进行详细进行介绍。

一、基本介绍

1，Lombok 介绍

（1）Lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。

比如：在一个 POJO 中，一个属性的 getter 和 setter 可通过 @Getter 和 @Setter 注解来取代，代码编写就更加简洁和快速。

（2）而对应的注解最终会在编译源码的时候生成对应的方法，所以不会影响任何运行效率。

2，插件安装

（1）这里以 Intellij IDE（Mac 版）为例，依次打开 Preferences 窗口 -> Plugins -> Marketplace，搜索 Lombok 插件然后安装。

（2）安装后重启 IDE。

 

3，添加依赖

（1）修改项目的 pom.xml 文件，添加如下 maven 依赖：

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

二、var 与 val

（1）val、val 关键字可以让我们在定义一个变量时候不需要提前指定它的类型，它的实际的类型将由初始化的表达式推断：

• var 所声明的变量是非 final 的。
• val 所声明的变量是 final 的。

var example = new ArrayList<String>();
example.add("hello");
val foo = example.get(0);

（2）上面代码将会翻译成如下 Java 程序：

ArrayList example = new ArrayList<String>();
example.add("hello");
final String  foo = example.get(0);

三、Lombok 注解概览

Lombok 插件主要为我们提供了如下注解，这里对其做一个简单的汇总。各个注解详细的介绍以及用法，可以参考我后续的文章。

• @Getter 注解在属性（类）上，为属性（所有非静态成员变量）提供 get() 方法
• @Setter 注解在属性（类）上，为属性（所有非静态成员变量）提供 set() 方法
• @ToString 该注解的作用是为类自动生成 toString() 方法
• @EqualsAndHashCode 为对象字段自动生成 hashCode() 和 equals() 实现
• @AllArgsConstructor、@RequiredArgsConstructor、@NoArgsConstructor 顾名思义，为类自动生成对应参数的构造器
• @Data 注解在类上，自动为所有字段添加 @ToString、@EqualsAndHashCode、@Getter。为非 final 字段添加 @Setter 和 @RequiredArgsConstructor。本质上相当于几个注解的综合效果
• @Value 注解和 @Data 类似，区别在于它会把所有成员变量默认定义为 private final 修饰，并且不会生成 set() 方法
• @Log、@Log4j、@Log4j2、@Slf4j、@XSlf4j、@CommonsLog、@JBossLog 注解在类上，自动为类添加对应的日志支持
• @NonNull 注解在方法参数上，用于自动生成空值参数检查，自动帮助我们避免空指针
• @Cleanup 自动帮我们调用 close() 方法，作用在局部变量上，在作用域结束时会自动调用 close() 方法释放资源，可以关闭流
• @Builder 注解在类上，被注解的类加个构造者模式
• @Synchronized 注解在类上，加个同步锁
• @SneakyThrows 等同于 try/catch 捕获异常