Lombok原理及使用

前言

项目中使用到了Lombok，但对于它的实现原理以及缺点却知之甚少，而本文将会从Lombok的原理出发，手动实现一个简易版的Lombok，来理解这个热门技术背后的执行原理，以及它的优缺点。

1. 简介

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

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

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

2. 使用

2.1 添加 Lombok 插件

在 IDE 中必须安装 Lombok 插件，才能正常调用被 Lombok 修饰的代码，以 Idea 为例，添加的步骤如下：

1. 点击 File > Settings > Plugins 进入插件管理页面

2. 点击 Browse repositories...

3. 搜索 Lombok Plugin

4. 点击 Install plugin 安装插件

5. 重启 IntelliJ IDEA

安装完成，如下图所示：

2.2 添加 Lombok 库

接下来我们需要在项目中添加最新的 Lombok 库，如果是 Maven 项目，直接在 pom.xml 中添加如下配置：

<dependencies>   <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->     <dependency>         <groupId>org.projectlombok</groupId>         <artifactId>lombok</artifactId>         <version>1.18.12</version>         <scope>provided</scope>     </dependency> </dependencies>

2.3 使用Lombok

接下来到了前半部分中最重要的 Lombok 使用环节了，我们先来看在没有使用 Lombok 之前的代码：

public class Person {     private Integer id;     private String name;     public Integer getId() {         return id;     }     public void setId(Integer id) {         this.id = id;     }     public String getName() {         return name;     }     public void setName(String name) {         this.name = name;     } }

这是使用 Lombok 之后的代码：

@Getter @Setter public class Person {     private Integer id;     private String name; }

可以看出Lombok 之后，用一个注解就搞定了之前所有 Getter/Setter 的代码，让代码瞬间优雅了很多。

3. Lombok注解

3.1 Lombok常用注解如下

• val：用在局部变量前面，相当于将变量声明为 final；
• @NonNull：给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验，如果为空，则抛出 NPE（NullPointerException）；
• @Cleanup：自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成 try-finally 这样的代码来关闭流；
• @Getter/@Setter：用在属性上，再也不用自己手写 setter 和 getter 方法了，还可以指定访问范围；
• @ToString：用在类上可以自动覆写 toString 方法，当然还可以加其他参数，例如 @ToString(exclude=”id”) 排除 id 属性，或者 @ToString(callSuper=true, includeFieldNames=true) 调用父类的 toString 方法，包含所有属性；
• @EqualsAndHashCode：用在类上自动生成 equals 方法和 hashCode 方法；
• @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：用在类上，自动生成无参构造和使用所有参数的构造函数以及把所有 @NonNull 属性作为参数的构造函数，如果指定 staticName="of" 参数，同时还会生成一个返回类对象的静态工厂方法，比使用构造函数方便很多；
• @Data：注解在类上，相当于同时使用了 @ToString、@EqualsAndHashCode、@Getter、@Setter 和 @RequiredArgsConstrutor 这些注解，对于 POJO 类十分有用；
• @Value：用在类上，是 @Data 的不可变形式，相当于为属性添加 final 声明，只提供 getter 方法，而不提供 setter 方法；
• @Builder：用在类、构造器、方法上，为你提供复杂的 builder APIs，让你可以像如下方式一样调用Person.builder().name("xxx").city("xxx").build()；
• @SneakyThrows：自动抛受检异常，而无需显式在方法上使用 throws 语句；
• @Synchronized：用在方法上，将方法声明为同步的，并自动加锁，而锁对象是一个私有的属性或LOCK，而Java中的synchronized关键字锁对象是 this，锁在 this 或者自己的类对象上存在副作用，就是你不能阻止非受控代码去锁 this 或者类对象，这可能会导致竞争条件或者其它线程错误；
• @Getter(lazy=true)：可以替代经典的 Double Check Lock 样板代码；
• @Log：根据不同的注解生成不同类型的 log 对象，但是实例名称都是 log，有六种可选实现类：

@CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); @Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName()); @Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); @Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class)

3.2 使用方法

3.2.1 Val使用

val sets = new HashSet<String>(); // 相当于 final Set<String> sets = new HashSet<>();

3.2.2 NonNull使用

public void notNullExample(@NonNull String string) {     string.length(); } // 相当于 public void notNullExample(String string) {     if (string != null) {         string.length();     } else {         throw new NullPointerException("null");     } }

3.2.3 Cleanup使用

public static void main(String[] args) {     try {         @Cleanup InputStream inputStream = new FileInputStream(args[0]);     } catch (FileNotFoundException e) {         e.printStackTrace();     }     // 相当于     InputStream inputStream = null;     try {         inputStream = new FileInputStream(args[0]);     } catch (FileNotFoundException e) {         e.printStackTrace();     } finally {         if (inputStream != null) {             try {                 inputStream.close();             } catch (IOException e) {                 e.printStackTrace();             }         }     } }

3.2.4 G