最佳实践-Lombok简化开发

一、Lombok介绍

Lombok是一个Java库，可以通过注解来简化Java类的编写，减少冗余的样板代码。它提供了一系列的注解，用于自动生成常见的代码，如getter和setter方法、构造函数、equals和hashCode方法、toString方法等。通过使用Lombok，开发者可以更加专注于业务逻辑的实现，减少了繁琐的重复劳动。

二、Lombok常用注解

2.1 @Data

@Data: 是一个组合注解，相当于同时使用了@Getter、@Setter、@ToString、@EqualsAndHashCode注解。

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

2.2 @AllArgsConstructor

提供一个全参数的构造方法

2.3 @NoArgsConstructor

提供一个无参构造

2.4 @EqualsAndHashCode

提供equals, hashCode方法

2.5 @ToString

提供toString方法

2.6 @Slf4j

@Slf4j是Lombok库中的一个注解，它可以为Java类自动添加一个名为log的日志记录器。@Slf4j注解使用了SLF4J（Simple Logging Facade for Java）日志框架。通过使用@Slf4j注解，您无需手动创建private static final Logger log = LoggerFactory.getLogger(YourClassName.class)这样的日志记录器，而是直接使用log变量进行日志记录。

使用@Slf4j注解的示例代码如下所示：

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class MyClass {
    public void myMethod() {
        log.debug("Debug log message");
        log.info("Info log message");
        log.error("Error log message");
    }
}

在上述代码中，通过使用@Slf4j注解，即可在MyClass中自动添加一个名为log的日志记录器。然后，您可以在方法中使用log变量来记录日志。在示例中，使用了不同的日志级别（debug、info和error）记录不同级别的日志信息。

三、Lombok使用

3.1 引入依赖：

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

3.2 安装插件（第一次使用时）

IDEA中File->Settings->Plugins，搜索安装Lombok插件。

3.3 在Java类中使用Lombok注解

在Java类中使用Lombok注解：您可以在需要简化的Java类中使用Lombok的注解来自动生成代码。以下是一些常用的Lombok注解：

通过在类上添加这些注解，Lombok会自动生成相应的代码。

@Getter / @Setter: 自动生成字段的getter和setter方法。
@ToString: 自动生成toString()方法，用于输出对象的字符串表示。
@EqualsAndHashCode: 自动生成equals()和hashCode()方法。
@NoArgsConstructor / @RequiredArgsConstructor / @AllArgsConstructor: 自动生成无参数构造函数、指定参数的构造函数或包含所有参数的构造函数。
@Data: 是一个组合注解，相当于同时使用了@Getter、@Setter、@ToString、@EqualsAndHashCode注解。
@Slf4j: 自动生成日志记录器。