【IDEA】Lombok--是否值得我们去使用

官网

https://projectlombok.org/

简介

Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，从而为您的Java增光添彩。永远不要再写另一个getter或equals方法，带有一个注释的类有一个功能全面的生成器，自动执行日志记录变量等等。

总的来说，Lombok是一款“代码生成器”，但是不同于真正的代码生成器，使用Lombok后，你的类中并不会多出你未写过的代码，而是在代码编译时，Lombok自动为其添加。

功能

Lombok功能强大，常用注解如下

• @Getter/@Setter
  作用在字段上，会自动生成字段的Getter；作用在类上，会自动生成该类所有非静态字段的Getter，还能控制Getter的访问级别

• @ToString
  类注解，自动生成类的toString方法，可以做一些定制，比如不使用某个字段，不调用Getters等

• @EqualsAndHashCode
  自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非 transient 的变量，如果某些变量不想要加进判断，可以透过 exclude 排除，也可以使用 of 指定某些字段

• @NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor
  @NoArgsConstructor 类注解，自动生成一个无参构造函数。
  @AllArgsConstructor 类注解，生成一个初始化所有字段的构造函数(在加上 @AllArgsConstructor 时，一定要补上 @NoArgsConstrcutor)
  @RequiredArgsConstructor : 生成一个包含 “特定参数” 的构造器，特定参数指的是那些有加上 final 修饰词的变量们.

• @Data
  相当于同时应用了@Getter、@Setter、@ToString、@EqualsAndHashCode、@RequiredArgsConstructor。如果已经定义了一个构造方法，就不会再自动生成构造方法了。

• @Value
  和@Data类似，但是用于不可变类型。生成的类和所有字段都设置为final，所有字段都为private，自动生成Getter但是没有Setter，会生成初始化所有字段的构造函数。相当于同时应用了final @ToString、 @EqualsAndHashCode、 @AllArgsConstructor、@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)和 @Getter

• @Builder
  自动生成流式 set 值写法，从此之后再也不用写一堆 setter 了。注意，虽然只要加上 @Builder注解，我们就能够用流式写法快速设定对象的值，但是 setter 还是必须要写不能省略的，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值。
  所以通常是 @Data 和 @Builder 会一起用在同个类上，既方便我们流式写代码，也方便框架做事

• @NotNull
  作用在方法参数上的注解，用于自动生成空值参数检查。

• @Slf4j
  自动生成该类的 log 静态常量，要打日志就可以直接打，不用再手动 new log 静态常量了

使用方法

在Idea中使用Lombok，需要按照以下步骤

1.安装插件

2.导包

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

3.开始使用

总结

--转自狂神MyBatis课程