Lombok使用及常用注解介绍

2021年5月26日20:39:34
评论
1081 2121字

现在项目里五花八门的注解很多,有些是java的,有些是spring的,有些是插件的……还是要总结一下,不然容易混淆。

idea已经内置了lombok插件,SpringBoot已经集成了lombok的starter。

var:

变量类型自动补全,但是并非完全准确

val

和var相同,但是比var稍好,idea支持好

@NonNull

可用于参数和字段,判断非空,并将参数的名称作为消息引发一个NullPointerException。

@Getter and @Setter

可以在任何字段上使用@Getter或@Setter,lombok会自动生成默认的getter / setter。如果在类上使用,则所有字段生成getter / setter

注意点:

  • @Getter可用于枚举,@Setter不能
  • 来自流行的库的注释检查,例如javax.annotation.Nonnull,如果存在于字段上,导致生成的setter中会进行显式的空检查。
  • 当与@Accessors注解一起使用会产生影响

@ToString

自动重写 toString() 方法,会打印出所有变量

@EqualsAndHashCode

自动生成 equals(Object other) 和 hashcode() 方法,包括所有非静态变量和非 transient 的变量

如果某些变量不想要加进判断,可以透过 exclude 排除,也可以使用 of 指定某些字段

Q : 为什么只有一个整体的 @EqualsAndHashCode 注解,而不是分开的两个 @Equals 和 @HashCode

A : 在 Java 中有规定,当两个对象 equals 时,他们的 hashcode 一定要相同,反之,当 hashcode 相同时,对象不一定 equals。所以 equals 和 hashcode 要一起实现,免得发生违反 Java 规定的情形发生

@NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor

这三个很像,都是在自动生成该类的构造器,差别只在生成的构造器的参数不一样而已

@NoArgsConstructor :

生成一个没有参数的构造器。

当我们没有指定构造器时,Java 编译器会帮我们自动生成一个没有任何参数的构造器给该类,但是如果我们自己写了构造器之后,Java 就不会自动帮我们补上那个无参数的构造器了

然而很多地方(像是 Spring Data JPA),会需要每个类都一定要有一个无参数的构造器,所以你在加上 @AllArgsConstructor 时,一定要补上 @NoArgsConstrcutor,不然会有各种坑等着你

RequiredArgsConstructor :

生成一个包含 "特定参数" 的构造器,特定参数指的是那些有加上 final 修饰词的变量们

补充一下,如果所有的变量都是正常的,都没有用 final 修饰的话,那就会生成一个没有参数的构造器

@Data

整合包,只要加了 @Data 这个注解,等于同时加了以下注解

  • @Getter/@Setter
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor

@Data 是使用频率最高的 lombok 注解,通常 @Data 会加在一个值可以被更新的对象上,像是日常使用的 DTO 们、或是 JPA 裡的 Entity 们,就很适合加上 @Data 注解,也就是 @Data for mutable class

@Value

也是整合包,但是他会把所有的变量都设成 final 的,其他的就跟 @Data 一样,等于同时加了以下注解

  • @Getter (注意没有setter)
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor

@Data 适合用在 POJO 或 DTO 上,而这个 @Value 注解,则是适合加在值不希望被改变的类上,若某个类的值当创建后就不希望被更改,只希望我们读,就适合加上 @Value 注解,也就是 @Value for immutable class

另外注意一下,此 lombok 的注解 @Value 和另一个 Spring 的注解 @Value 撞名,在 import 时不要 import 错了

@Builder

自动生成流式 set 值写法,从此之后再也不用写一堆 setter 了

虽然只要加上 @Builder 注解,我们就能够用流式写法快速设定对象的值,但是 setter 还是必须要写不能省略的,因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值

所以通常是 @Data 和 @Builder 会一起用在同个类上,既方便我们流式写代码,也方便框架做事

@Slf4j

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

SpringBoot默认支持的就是 slf4j + logback 的日志框架,所以也不用再多做啥设定,直接就可以用在 SpringBoot project上,log 系列注解最常用的就是 @Slf4j

除了 @Slf4j 之外,lombok 也提供其他日志框架的变种注解可以用,像是 @Log、@Log4j...等,他们都是帮我们创建一个静态常量 log,只是使用的库不一样而已

您可能感兴趣的文章

匿名

发表评论

匿名网友