lombok常用注解及应用场景

lombok介绍

Lombok是一个Java库，可以通过注解的方式来简化Java代码的编写。它提供了一系列的注解，可以自动生成Java类的getter、setter、构造函数、equals、hashCode等方法，从而减少了Java代码的冗余。Lombok的目标是通过注解来简化Java代码的编写，从而提高开发效率和代码的可读性和可维护性。
Lombok的主要特点包括：
① 简化Java代码的编写：Lombok的注解可以自动生成Java类的getter、setter、构造函数、equals、hashCode等方法，从而减少了Java代码的冗余。
② 提高代码的可读性和可维护性：Lombok的注解可以提高代码的可读性和可维护性，使代码更加清晰易懂。
③ 支持各种Java项目：Lombok适用于各种Java项目，特别是大型项目和需要频繁创建Java对象的项目。
④ 易于使用：Lombok的注解非常易于使用，只需要在Java类上添加相应的注解即可。

---

常用注解

---

@Getter和@Setter注解

应用场景：

在实际开发中，我们经常需要为Java类的属性编写getter和setter方法，以便在其他地方访问和修改属性的值。例如，一个用户对象有id、name和age三个属性，我们需要为这三个属性编写getter和setter方法。这时，就可以使用@Getter和@Setter注解来自动生成getter和setter方法，减少Java代码的冗余。

举例说明：

假设有一个Java类User，它有三个属性：id、name和age。我们希望自动生成这三个属性的getter和setter方法，减少Java代码的冗余。这时，就可以使用@Getter和@Setter注解来自动生成getter和setter方法。
示例代码如下：

public class User {
    @Getter @Setter
    private Long id;
    @Getter @Setter
    private String name;
    @Getter @Setter
    private Integer age;
}

在上面的代码中，我们使用@Getter和@Setter注解来自动生成id、name和age属性的getter和setter方法。这样，我们就可以在其他地方访问和修改这三个属性的值，而不需要编写冗余的getter和setter方法。

---

@ToString注解

应用场景：

在实际开发中，我们经常需要在调试时输出Java对象的内容，以便查看对象的属性值。例如，一个用户对象有id、name和age三个属性，我们需要为这三个属性编写toString方法。这时，就可以使用@ToString注解来自动生成toString方法，减少Java代码的冗余。

举例说明：

假设有一个Java类User，它有三个属性：id、name和age。我们希望自动生成这个类的toString方法，方便在调试时输出对象的内容。这时，就可以使用@ToString注解来自动生成toString方法。
示例代码如下：

@ToString
public class User {
    private Long id;
    private String name;
    private Integer age;
}

在上面的代码中，我们使用@ToString注解来自动生成User类的toString方法。这样，我们就可以在调试时方便地输出User对象的内容，而不需要编写冗余的toString方法。
例如，如果有一个User对象，它的id属性为1，name属性为"张三"，age属性为18，那么可以通过以下方式输出这个对象的内容：

User user = new User();
user.setId(1L);
user.setName("张三");
user.setAge(18);
System.out.println(user);

输出结果如下：

User(id=1, name=张三, age=18)

---

@EqualsAndHashCode 注解

应用场景：

在实际开发中，我们经常需要比较Java对象的内容，以判断它们是否相同。例如，一个用户对象有id、name和age三个属性，我们需要为这三个属性编写equals和hashCode方法。这时，就可以使用@EqualsAndHashCode注解来自动生成equals和hashCode方法，减少Java代码的冗余。

举例说明:

假设有一个Java类User，它有三个属性：id、name和age。我们希望自动生成这个类的equals和hashCode方法，方便比较对象的内容。这时，就可以使用@EqualsAndHashCode注解来自动生成equals和hashCode方法。
示例代码如下：

@EqualsAndHashCode
public class User {
    private Long id;
    private String name;
    private Integer age;
}

在上面的代码中，我们使用@EqualsAndHashCode注解来自动生成User类的equals和hashCode方法。这样，我们就可以方便地比较User对象的内容，而不需要编写冗余的equals和hashCode方法。
例如，如果有两个User对象，它们的id属性都为1，name属性都为"张三"，age属性都为18，那么可以通过以下方式比较这两个对象的内容：

User user1 = new User();
user1.setId(1L);
user1.setName("张三");
user1.setAge(18);

User user2 = new User();
user2.setId(1L);
user2.setName("张三");
user2.setAge(18);

boolean result = user1.equals(user2);
System.out.println(result);

输出结果为true，说明这两个对象的内容相同。

---

@NoArgsConstructor和@AllArgsConstructor注解

应用场景：

在实际开发中，我们经常需要创建Java对象，并初始化对象的属性值。例如，一个用户对象有id、name和age三个属性，我们需要为这三个属性编写构造函数。这时，就可以使用@NoArgsConstructor和@AllArgsConstructor注解来自动生成构造函数，减少Java代码的冗余。

举例说明：

假设有一个Java类User，它有三个属性：id、name和age。我们希望自动生成这个类的无参构造函数和全参构造函数，方便创建对象并初始化属性的值。这时，就可以使用@NoArgsConstructor和@AllArgsConstructor注解来自动生成构造函数。
示例代码如下：

import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
}

在上面的代码中，我们使用@NoArgsConstructor和@AllArgsConstructor注解来自动生成User类的无参构造函数和全参构造函数。这样，我们就可以方便地创建User对象，并初始化对象的属性值，而不需要编写冗余的构造函数。
例如，如果要创建一个id为1，name为"张三"，age为18的User对象，可以通过以下方式创建对象：

User user = new User(1L, "张三", 18);

---

@Data注解

@Data注解融合了上面 @Getter、@Setter、@ToString、 @EqualsAndHashCode、@NoArgsConstructor、@AllArgsConstructor所有注解功能。

---

@Builder注解

应用场景：

在实际开发中，我们经常需要创建Java对象，并初始化对象的属性值。例如，一个用户对象有id、name和age三个属性，我们需要为这三个属性编写setter方法。这时，就可以使用@Builder注解来自动生成builder方法，减少Java代码的冗余

举例说明：

假设有一个Java类User，它有三个属性：id、name和age。我们希望自动生成这个类的builder方法，方便创建对象并初始化属性的值。这时，就可以使用@Builder注解来自动生成builder方法。
示例代码如下：

import lombok.Builder;

@Builder
public class User {
    private Long id;
    private String name;
    private Integer age;
}

在上面的代码中，我们使用@Builder注解来自动生成User类的builder方法。这样，我们就可以方便地创建User对象，并初始化对象的属性值，而不需要编写冗余的setter方法。
例如，如果要创建一个id为1，name为"张三"，age为18的User对象，可以通过以下方式创建对象：

User user = User.builder()
                .id(1L)
                .name("张三")
                .age(18)
                .build();
      

---

@Slf4j注解

应用场景：

在实际开发中，我们经常需要记录Java程序的运行日志，以便在出现错误时进行排查。例如，一个用户对象有id、name和age三个属性，我们需要在程序中记录用户对象的创建和修改日志。这时，就可以使用@Slf4j注解来自动生成日志记录器，减少Java代码的冗余。

举例说明：

假设有一个Java类User，它有三个属性：id、name和age。我们希望在程序中记录用户对象的创建和修改日志，方便排查错误。这时，就可以使用@Slf4j注解来自动生成日志记录器。
示例代码如下：

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class User {
    private Long id;
    private String name;
    private Integer age;
    
    public User(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
        log.info("创建用户对象：{}", this);
    }
    
    public void setName(String name) {
        this.name = name;
        log.info("修改用户对象：{}", this);
    }
}

在上面的代码中，我们使用@Slf4j注解来自动生成User类的日志记录器。这样，我们就可以在程序中记录用户对象的创建和修改日志，方便排查错误。
例如，如果要创建一个id为1，name为"张三"，age为18的User对象，可以通过以下方式创建对象：

User user = new User(1L, "张三", 18);

如果要修改这个对象的name属性，可以通过以下方式修改属性值：

user.setName("李四");