Lombok

1. Lombok简介

Lombok是一种 Java实用工具，可用来帮助开发人员消除Java的冗长，尤其是对于简单的Java对象(POJO), 它通过注释实现这一目的。一个标准的Java bean 一般具有若干属性，每个属性具有getter()和setter()方法，Lombok中也用到了注解，但是它并没有用到反射，而是通过一些奇技淫巧，在代码编译时期动态将注解替换为具体的代码。所以JVM实际运行的代码，和我们手动编写的包含了各种工具方法的类相同。

2. Lombok使用

2.1 maven依赖

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

2.2 Lombok注解使用

2.2.1 @Data

@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法

2.2.2 @Getter/@Setter

@Getter/@Setter作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

@Getter(lazy = true) 标注字段为懒加载字段，懒加载字段在创建对象时不会进行初始化，而是在第一次访问的时候才会初始化，后面再次访问也不会重复初始化

2.2.3 @ToString

类使用此注解，生成toString()方法，默认情况下它会按顺序（以逗号分隔）打印你的类名称以及每个字段。@ToString(of = {"id"})指定包含哪些字段，默认所有字段；也可以设置不包含哪些字段,可以指定一个也可以指定多个@ToString(exclude = “id”) / @ToString(exclude = {“id”,“name”})

2.2.4 @EqualsAndHashCode

通过判断两个对象的成员变量值是否相等，来判断这两个对象是否相等，要重写hashCode()和equals()方法。

用在类上，生成hashCode()和equals()方法，默认情况下，它将使用所有非静态，非transient字段。但可以通过在可选的 exclude 参数中来排除更多字段。或者，通过在of参数中命名它们来准确指定希望使用哪些字段。

2.2.5 @NonNull

用在属性或构造器上，为字段赋值时(即调用字段的setter方法时)，如果传的参数为null，则会抛出空异常NullPointerException，生成setter方法时会对参数是否为空检查

public class NonNullExample extends Something {
  private String name;
  
  public NonNullExample(@NonNull Person person) {
    super("Hello");
    this.name = person.getName();
  }
}

编译后

public class NonNullExample extends Something {
  private String name;
  
  public NonNullExample(@NonNull Person person) {
    super("Hello");
    if (person == null) {
      throw new NullPointerException("person");
    }
    this.name = person.getName();
  }
}

2.2.6 @Value

用在类上，是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法

@Value
publicclassLombokDemo{
	@NonNull
    private int id;
}

编译后：

publicclassLombokDemo {    
    private final int id;
    public int getId() {
        return this.id;
    }
}

2.2.7 @Builder

Builder 使用创建者模式又叫生成器模式（Builder Pattern）。简单来说，就是一步步创建一个对象，它对用户屏蔽了里面构建的细节，但却可以精细地控制对象的构造过程。

@Data
public class User1 {
    private Integer id;
    private String name;
    private String address;

    public static void main(String[] args) {
        User1 user1 = new User1(1, "java", "china");
        user1.setId(1);
        user1.setName("11");
        user1.setAddress("111");
        System.out.println(user1);
    }
}

使用 @Builder：

@Builder
@Data
public class User1 {
    private Integer id;
    private String name;
    private String address;

    public static void main(String[] args) {
        User1 user1 = User1.builder().id(1).address("11").name("111").build();
        System.out.println(user1);
    }
}

2.2.8 @Log

生成log对象，用于记录日志，可以通过topic属性来设置getLogger(String name)方法的参数 例如 @Log4j(topic = “com.xxx.entity.User”)，默认是类的全限定名，即 类名.class，log支持以下几种：

@Log java.util.logging.Logger
@Log4j org.apache.log4j.Logger
@Log4j2 org.apache.logging.log4j.Logger
@Slf4j org.slf4j.Logger
@XSlf4j org.slf4j.ext.XLogger
@CommonsLog org.apache.commons.logging.Log
@JBossLog org.jboss.logging.Logger

2.2.9  @Clenaup

用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成try-finally这样的代码来关闭流

public static void main(String[] args) throws IOException {
        @Cleanup InputStream in = new FileInputStream("E:\\filepath.txt");
        @Cleanup OutputStream out = new FileOutputStream("E:\\path2.txt");
        byte[] b = new byte[1000];
        while (true) {
            int r = in.read(b);
            if (r == -1) {
                break;
            }
            out.write(b, 0, r);
        }
    }

参考文档：https://blog.csdn.net/qq_43429919/article/details/117470788