lombok插件

Posted 2021-11-30 kingjames

lombok是开源的代码生成库，是一款非常实用的小插件，我们在编辑实体类时可以通过lombok注解减少getter、setter等方法的编写，在更改实体类时只需要修改属性即可，减少了很多重复代码的编写工作。

插件安装

1. 打开IntelliJ IDEA后点击菜单栏中的File→Settings，或者使用快捷键Ctrl+Alt+S进入到设置页面。
   
   
2. 点击设置中的Plugins进行插件的安装
   
   1. 我使用的IDEA版本为2018.3.2，安装步骤如下（其他版本若找不到Marketplace，请看b步骤）：
      
      
      
      
   2. 在右侧选择Browse repositories...，然后在搜索页面输入lombok变可以查询到下方的Lombok Plugin，鼠标点击Lombok Plugin可在右侧看到Install按钮，点击该按钮便可安装。
      
      
3. 点击Lombok插件，可以看到支持的注解列表。
   

配置注解处理器

1. 在Settings设置页面，点击Build,Execution,Deployment-->选择Compiler-->选中Annotation Processors，然后在右侧勾选Enable annotation processing即可。
   
   

lombok插件的使用

1. 使用前需要说明的是安装的插件只是一个调用，就像我们使用maven插件一样，本机需要安装maven才行。我们在使用lombok前也需要添加lombok的依赖（若项目中已添加依赖，请勿重复添加）。

   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>1.18.6</version>
       <scope>provided</scope>
   </dependency>

    

2. 接下来我们编辑一个实体类Student，添加三个属性，最后在类上添加@Getter和@Setter，这2个注解可以帮我们在.class文件中生成类中所有属性的get/set方法。
   
   
3. 那么编辑完代码后我们如何查看生成的方法呢？在菜单栏点击View-->Tool Windows→Structure，便可以看到类中所有的方法了，这些都是lombok自动生成的。
   
   
   
   
   
4. 常用注解如下：
   1. @Getter/@Setter：可以用在类上或属性上，自动生成setter和getter方法；
   2. @ToString：用在类上，可以自动覆盖toString方法，当然还可以加其他参数，例如@ToString(exclude=”id”)排除id属性，或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法，包含所有属性；
   3. @EqualsAndHashCode：用在类上，自动生成equals方法和hashCode方法；
   4. @Slf4j：（不建议使用其他日志注解，原因：《为什么使用 SLF4J 而不是 Log4J 来做 Java 日志》），使用方法如下：
      
      
   5. @Data：注解在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解。不建议直接使用，应根据需要使用注解；
   6. @AllArgsConstructor：生成一个包含所有成员变量的构造方法，建议在枚举类中使用；
   7. 其他注解请查看网上资料。