Lombok基本使用

Lombok是一个Java库，它通过注解来简化Java代码的编写，自动生成诸如getter和setter方法、构造函数、equals和hashCode方法等常见的代码，从而减少开发者的重复劳动，提高代码的可读性和开发效率。以下是Lombok的使用教程具体内容：

一、Lombok插件安装

1. 下载与安装：
   • 对于IntelliJ IDEA用户，可以通过IDEA的插件市场搜索并下载Lombok插件。如果使用的是IDEA 2020.3以上版本，Lombok插件可能已内置，无需额外安装。
   • 下载完成后，按照提示进行安装，并重启IDEA以使插件生效。
2. 配置IDE：
   • 安装插件后，可能需要在IDE中进行一些配置，以确保Lombok能够正常工作。例如，在IDEA中，通常不需要额外配置，但有时需要确保Lombok插件已正确安装并启用。

二、Lombok依赖引入

1. Maven项目：
   在项目的pom.xml文件中添加Lombok依赖。SpringBoot 2.1.x版本后，在spring-boot-dependencies中已经内置了Lombok，因此可能无需指定Lombok的具体版本。依赖配置示例如下：

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

三、Lombok注解使用

Lombok提供了多种注解，用于自动生成代码。以下是一些常用的Lombok注解及其用法：

1. @Data：
   • 在类上使用，自动生成getter、setter、toString、equals和hashCode方法。
   • 示例：

     @Data 
     public class User { 
         private String name; 
         private int age; 
     }

2. @Getter / @Setter：
   • 分别用于生成getter和setter方法。
   • 示例：

     @Getter 
     @Setter 
     private String name;

3. @NoArgsConstructor / @AllArgsConstructor：
   • @NoArgsConstructor生成无参构造方法。
   • @AllArgsConstructor生成包含所有字段的有参构造方法。
   • 示例：

     @NoArgsConstructor 
     @AllArgsConstructor 
     public class User { 
         private String name; 
         private int age; 
     }

4. @ToString：
   • 用于生成toString方法。
   • 可通过参数控制哪些字段包含在内，如@ToString(exclude="id")排除id字段。
5. @EqualsAndHashCode：
   • 用于生成equals和hashCode方法。
   • 类似于@ToString，也可通过参数控制哪些字段包含在内。
6. @Slf4j / @Log4j：
   • 用于在类中自动生成日志对象，分别对应SLF4J和Log4j日志框架。
   • 示例：

     @Slf4j 
     public class LogExample { 
         public void logSomething() { 
             log.info("This is a log message"); 
         } 
     }

7. @NonNull：
   • 用于字段和方法参数，生成空值检查代码。如果传入null值，将抛出NullPointerException。
   • 示例：

     @NonNull 
     private String name;

8. @Cleanup：
   • 用于自动关闭资源，如文件流、数据库连接等。
   • 示例：

     @Cleanup 
     InputStream in = new FileInputStream(file);

四、注意事项

• 确保Lombok插件已正确安装并启用。
• 在使用Lombok注解时，注意IDE可能会因为未即时识别Lombok注解而显示错误或警告，这通常是因为IDE缓存或插件未生效导致的，可以尝试重启IDE或清除IDE缓存。
• Lombok生成的代码在编译时由Java编译器处理，因此在源代码中看不到Lombok生成的代码，但可以通过IDE的反编译功能查看。