Lombok是一个Java库，通过注解方式减少样板代码，提高代码整洁性和效率。常用的注解包括@Data、@ToString、@EqualsAndHashCode等，简化getter/setter、构造器、日志等生成。SpringBoot和IDEA支持Lombok，但使用时需要注意可能带来的问题，如强制安装插件、代码可读性下降等。选择使用Lombok应根据项目实际需求来决定。
背景
以前的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。
Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。
为什么推荐使用Lombok:
@Lombok有啥牛皮的？SpringBoot和IDEA官方都要支持它！
最近IDEA 2020最后一个版本发布了，已经内置了Lombok插件，SpringBoot 2.1.x之后的版本也在Starter中内置了Lombok依赖。为什么他们都要支持Lombok呢？今天我来讲讲Lombok的使用，看看它有何神奇之处！
引入maven包
同时idea也需要下载lombok插件，很简单，就不赘述了
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。事实正是如此，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。
Lombok注解的使用
常用注解
package com.example.demo.entity;
import lombok.*;
import java.io.Serializable;
/**
* @Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；
* 作用于成员变量上，生成该成员变量的getter/setter方法。
* 可以设定访问权限及是否懒加载等。
* 注意：
* final字段只会生成get
* static静态成员变量不会生成set/get方法
*
* @ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。
* 就是打印的时候是否打印
*
* @EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode
*
* @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于类上，用于生成构造函数。有staticName、access等属性。
*
* staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。
* @NoArgsConstructor：生成无参构造器；
* @RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；
* @AllArgsConstructor：生成全参构造器
*
* @Data：作用于类上，是以下注解的集合，通常这个是最常用的
* @ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
*
* 使用@Data时会默认使用@EqualsAndHashCode(callSuper=false)，这时候生成的equals()方法只会比较子类的属性，不会考虑从父类继承的属性，无论父类属性访问权限是否开放。
*
* @NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。
*
* @Builder：作用于类上，将类转变为建造者模式
*
使用@Builder时要加上@AllArgsConstructor，否则可能会报错
*
* @Log：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解
@Value : 用于注解final类
*/
@Data
@ToString(of = {"id","username"},exclude = {"password"})
@Getter(value = AccessLevel.PUBLIC)
@Setter(value = AccessLevel.PUBLIC)
@NoArgsConstructor(staticName = "of",access = AccessLevel.PRIVATE)
@RequiredArgsConstructor
public class UserEntity implements Serializable {
@NonNull
private String id;
private String username;
private String password;
}
其他注解
@Cleanup
自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象
@SneakyThrows
可以对受检异常进行捕捉并抛出
package com.example.demo;
import com.example.demo.entity.UserEntity;
import lombok.Cleanup;
import lombok.SneakyThrows;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
@SpringBootTest(classes = DemoApplication.class)
class DemoApplicationTests {
/**
* @Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象
*/
@Test
@SneakyThrows
void contextLoads() {
File file = new File("C:\\Users\\qazokmzjl\\Desktop\\iptables.txt");
@Cleanup
FileInputStream fileInputStream = new FileInputStream(file);
byte[] bs = new byte[1024];
int len;
while ((len = fileInputStream.read(bs)) != -1){
System.out.println(new String(bs,0,len));
}
}
}
编译后结果如下
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package com.example.demo;
import java.io.File;
import java.io.FileInputStream;
import java.util.Collections;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest(
classes = {DemoApplication.class}
)
class DemoApplicationTests {
DemoApplicationTests() {
}
@Test
void contextLoads() {
try {
File file = new File("C:\\Users\\qazokmzjl\\Desktop\\iptables.txt");
FileInputStream fileInputStream = new FileInputStream(file);
try {
byte[] bs = new byte[1024];
int len;
while((len = fileInputStream.read(bs)) != -1) {
System.out.println(new String(bs, 0, len));
}
} finally {
if (Collections.singletonList(fileInputStream).get(0) != null) {
fileInputStream.close();
}
}
} catch (Throwable var9) {
throw var9;
}
}
}
@Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁，用处不大.
使用lombok的场景
lombok简单说就是生成java实体类的get、set、tostring等等方法，试问什么项目没有实体类，为什么会出现场景这一说。
我这么写这个标题很友善了，弃用lombok这一标题的文章百度有很多。
我觉得如果单纯就是搬砖的话，是不需要往下看的，如果是自己负责一些项目的话，有必要了解一下。
为什么建议使用lombok
以前的javabean是利用idea的快捷键生成get、set、tostring等方法，如果字段很多的话，很难看；而且一旦哪个字段发生改变，需要同时修改实体类，当然可以使用idea来解决，不过更优雅的是使用lombok，只需要几个注解就可以
lombok工作原理
java程序的解析分为：运行时解析 和 编译时解析。
通常我们通过反射获取类、方法、注解和成员变量就是运行时解析。但是这种方式效率其实不高，要在程序运行起来才能解析。
这时候编译时解析就体现出它的价值了。
编译时解析又分为：注解处理器（Annotation Processing Tool）和 JSR 269 插入式注解处理器（Pluggable Annotation Processing API）
第一种处理器它最早是在 JDK 1.5 与注解（Annotation） 一起引入的，它是一个命令行工具，能够提供构建时基于源代码对程序结构的读取功能，能够通过运行注解处理器来生成新的中间文件，进而影响编译过程。
不过在JDK 1.8以后，第一种处理器被淘汰了，取而代之的是第二种处理器，我们一起看看它的处理流程：
Lombok的底层具体实现流程如下：
-
javac对源代码进行分析，生成了一棵抽象语法树（AST）
-
编译过程中调用实现了“JSR 269 API”的Lombok程序
-
此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
-
javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）
为什么不建议使用lombok
-
强制要求队友安装idea插件
这点确实比较恶心，因为如果使用lombok注解编写代码，就要求参与开发的所有人都必须安装idea的lombok插件，否则代码编译出错。
-
代码可读性变差
使用lombok注解之后，最后生成的代码你其实是看不到的，你能看到的是代码被修改之前的样子。如果要想查看某个getter或setter方法的引用过程，是非常困难的。
-
升级JDK对功能有影响
有人把JDK从Java 8升级到Java 11时，我发现Lombok不能正常工作了。
-
不便于调试
我们平时大部分人都喜欢用debug调试定位问题，但是使用lombok生成的代码不太好调试。
-
上下游系统强依赖
如果上游系统中提供的fegin client使用了lombok，那么下游系统必须也使用lombok，否则会报错，上下游系统构成了强依赖。
什么时候使用lombok
lombok有利有弊，我们该如何选择呢？
个人建议要结合项目的实际情况做最合理的选择。
-
如果你参与的是一个
新项目，上下游系统都是新的，这时候建议使用lombok，因为它可以显著提升开发效率。 -
如果你参与的是一个
老项目，并且以前没有使用过lombok，建议你后面也不要使用，因为代码改造成本较高。如果以前使用过lombok，建议你后面也使用，因为代码改造成本较高。 -
其实只要引入jar包可能都有：强制要求队友安装idea插件、升级JDK对功能有影响、有一些坑 和 上下游系统强依赖 这几个问题，只要制定好规范，多总结使用经验这些问题不大。
-
代码的可读性变差 和 不便于调试 这两个问题，我认为也不大，因为lombok一般被使用在javabean上，该类的逻辑相对来说比较简单，很多代码一眼就能看明白，即使不调试问题原因也能猜测7、8分。
部分内容转载自：
https://www.jianshu.com/p/2543c71a8e45
https://baijiahao.baidu.com/s?id=1687106698282169215&wfr=spider&for=pc
你要是在黑色幽默之中生活的时候，你的幽默感就没有了，得等它过去以后才会有。
王小波
扫一扫
579
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
