1. 简介
Lombok 通过提供简单的语法注解形式来帮助简化消除一些必须有但显得很臃肿的 java 代码。典型的是对于 POJO对象的简化（如自动帮我们生成Setter和Getter等），有了Lombok的加持，开发人员可以免去很多重复且臃肿的操作，极大地缩短编码时的重复工作，因此我们必须尝试并应用起来！
**本教程都是自己实践过程中书写的，如有问题请留言讨论**
2. 使用教程
2.1 在IDEA中安装插件
- 点击
file---》settings---》Plugins
打开插件的窗口，并搜索lombok.
插件
这里我安装过了，所以显示的是update，没安装过的会显示install,点击install就可以进行在线安装这个插件了。 - 开启Annotation Processors的Enable选项
有的人在使用的时候会报错Lombok Requires Annotation Processing....这种错误。我们就需要打开这个Annotation Processors
打开的步骤如图：
image.png - 添加依赖
IDE中设置完成以后需要在pom.xml中添加如下所示的lombok依赖才能使用
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.16</version>
</dependency>
这样我们就可以使用Lombok的注解，比如最常用的@data和@slf4j等。
3. Lombok主要注解
-
@Getter and @Setter自动为属性提供 Set和Get 方法 -
@ToString该注解的作用是为类自动生成toString()方法 -
@EqualsAndHashCode为对象字段自动生成hashCode和equals实现 -
@AllArgsConstructor, @RequiredArgsConstructor and - @NoArgsConstructor顾名思义，为类自动生成对应参数的constructor -
@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, - @JBossLog自动为类添加对应的log支持 -
@Data自动为所有字段添加@ToString,@EqualsAndHashCode,@Getter，为非final字段添加@Setter,和@RequiredArgsConstructor，本质上相当于几个注解的综合效果 -
@NonNull自动帮助我们避免空指针。作用在方法参数上的注解，用于自动生成空值参数检查 -
@Cleanup自动帮我们调用close()方法。作用在局部变量上，在作用域结束时会自动调用close方法释放资源
3.1 具体演示@data 和 @log
我们在java开发的时候，每个实体类都要getter和setter等方法，就显得很重复，所以最常用的就是@data的这个注解，可以帮我们省很多事。
- 添加注解
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.16</version>
</dependency>
- 新建实体类
@Data
public class UserLombok {
private final String name;
private int age;
private double score;
private String[] tags;
}
- 新建测试方法
public class Main {
public static void main(String[] args) {
UserLombok userLombok = new UserLombok("testLombok");
userLombok.setAge(18);
userLombok.setScore(99.9);
System.out.println(userLombok);
}
}
- 运行结果
UserLombok(name=testLombok, age=18, score=99.9, tags=null)
可以看出getter和setter，tostring等方法已经添加好了。
@Log也是相同
- 原来的日志写法
@RestController
@RequestMapping("/testlogging”)
public class LoggingTestController {
private final Logger logger = LogManager.getLogger(this.getClass());
@GetMapping("/hello”)
public String hello() {
for(int i=0;i<10_0000;i++){
logger.info("info execute index method”);
logger.warn("warn execute index method”);
logger.error("error execute index method”);
}
return "My First SpringBoot Application”;
}
}
- 现在变成这样
@RestController
@RequestMapping("/testloggingwithlombok”)
@Log4j2
public class LoggingTestControllerLombok {
@GetMapping("/hello”)
public String hello() {
for(int i=0;i<10_0000;i++){
log.info("info execute index method”);
log.warn("warn execute index method”);
log.error("error execute index method”);
}
return "My First SpringBoot Application”;
}
}
通过注解，就会默认生成一个名叫log的日志对象。
