[Java知识库]Lombok的使用

Lombok

1. 简介

Lombok项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净，简洁且易于维护的Java类。

常用注解：

@Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

@Getter ：使用方法同上，区别在于生成的是getter方法。

@ToString ：注解在类，添加toString方法。

@EqualsAndHashCode： 注解在类，生成hashCode和equals方法。

@NoArgsConstructor： 注解在类，生成无参的构造方法。

@RequiredArgsConstructor： 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

@AllArgsConstructor： 注解在类，生成包含类中所有字段的构造方法。

@Data： 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

@Slf4j： 注解在类，生成log变量，严格意义来说是常量。

优点:

1. 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率

2. 让代码变得简洁，不用过多的去关注相应的方法

3. 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点:

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

知乎上有位大神发表过对Lombok的一些看法:

? 这是一种低级趣味的插件，不建议使用。Java发展到今天，各种插件层出不穷，如何甄别各种插件的优劣？能从架构上优化你的设计的，能提高应用程序性能的，实现高度封装可扩展的。像1ombok这种，像这种插件，已经不仅仅是插件了，改变了你如何编写源码事实上，少去了的代码，你写上去又如何？如果Java家族到处充斥这样的东西，那只不过是一坨披着金属颜色的屎，迟早会被其它的语言取代.

2. 使用步骤：

1. 在idea中下载插件

2. 导入依赖

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

3. 在实体类中加注解即可

   @Data
   @AllArgsConstructor  //生成有参构造
   @NoArgsConstructor //生成无参构造
   public class User {
       private int id;
       private String name;
       private String password;
   
   }
   

一些坑

@Data注解不会涉父类的成员的坑，需要加callSuper = true的参数

要注意@EqualsAndHashCode注解与@ToString注解默认情况下是忽略父类的成员变量的。

在类继承的情况时应注意@Data注解不会涉父类的成员的坑，需要加callSuper = true的参数。

@Data

@ToString(callSuper = true)