Lombok——Idea中的使用

一、简介

Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。

二、Lombok的使用

1. 安装插件

打开Settings -> Plugins选项 -> 点击Browse repositories -> 输入lombok，并搜索 -> 安装，重启Idea即可

2. 引入依赖

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

3. 编译出错问题

如果编译出错，通常是没有设置enable注解处理器。解决方法是： 打开Settings -> 搜索 Annotation Processors -> 勾选 Enable annotation processing -> 点击apply应用即可。

4. 注解

4.1 常用注解

• @Data
• @Setter
• @Getter
• @Log4j
• @AllArgsConstructor
• @NoArgsConstructor
• @EqualsAndHashCode
• @NonNull
• @Cleanup
• @ToString
• @RequiredArgsConstructor
• @Value
• @SneakyThrows
• @Synchronized

4.2 注解详解

@Data
注解在 类 上；提供类所有属性的 getter、setter、equals、canEqual、hashCode、toString 方法。如为final属性，则不会为该属性生成setter方法。

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

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

@Log4j
注解在 类 上；为类提供一个 属性名为 log 的 log4j 日志对象，提供默认构造方法。简化日志的打印流程，调用info方法即可。

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

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

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

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

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

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

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

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

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

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

三、Lombok实现原理

Lombok实现了JSR 269 API规范（插入式注解），javac在Java6开始支持这一规范，只要程序实现了该API，就能在javac运行的时候得到调用，那么Lombok在编译时使用的就是javac，具体流程如下：

• 分析源代码并编译
• 生成抽象语法树（AST)
• 调用Lombok程序
• Lombok匹配注解对应的语法树，增加getter和setter方法定义的相应树节点
• javac使用修改后的语法树生成字节码文件，即给class增加新的节点（代码块）

四、Lombok的优缺点

优点：

• 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
• 让代码变得简洁，不用过多的去关注相应的方法
• 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

• 不支持多种参数构造器的重载
• 虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

参考连接：

• https://blog.csdn.net/yztezhl/article/details/82665150?utm_medium=distribute.pc_relevant.none-task-blog-utm_term-10&spm=1001.2101.3001.4242
• https://blog.csdn.net/tzs_1041218129/article/details/78995848?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522159684564319724843309640%2522%252C%2522scm%2522%253A%252220140713.130102334…%2522%257D&request_id=159684564319724843309640&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2_alltop_click~default-3-78995848.first_rank_ecpm_v3_pc_rank_v2&utm_term=lombok&spm=1018.2118.3001.4187