Lombok详解

最新推荐文章于 2024-09-14 22:16:55 发布

菅有志

最新推荐文章于 2024-09-14 22:16:55 发布

阅读量463

点赞数

文章标签： java intellij-idea 开发语言

本文链接：https://blog.csdn.net/qq_41073911/article/details/121850508

版权

文章目录

零、简介
一、使用方式：
二、常用注解：
三、优缺点
四、原理
五、总结

零、简介

官网地址：https://projectlombok.org/

官网介绍：

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

Project Lombok是一个java库，可以自动插入编辑器和构建工具，提高java的性能。

永远不要再编写另一个getter或equals方法，使用一个注释，您的类就有了一个功能齐全的生成器，自动化了日志变量，等等。

人话：

省略掉部分重复的代码编写过程，dto的get/set方法、log对象的实例化过程。

一、使用方式：

1.引入jar包

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

2.Idea需下载插件才能兼容

插件名称：lombok

二、常用注解：

最新官网文档地址：https://projectlombok.org/features/all

@Data

@Getter,@Setter,@EqualsAndHashCode,@ToString的集合

表示这是一个data类。

@Data可以在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。

@Getter/@Setter

生成属性的get/set方法。

如果你觉得使用Data注解生成的equals、hashcode、toString方法不满足你的需求，你可以只使用Getter和Setter方法生成属性的get/set。

@EqualsAndHashCode

生成非静态和非瞬时属性的hasCode和equals方法。也可以通过exclude注解排除一些属性。

使用方式：

@EqualsAndHashCode(exclude={“id”, “shape”})

@ToString

生成ToString方法。

@NonNull

非空。

用于校验参数，避免空指针。

@Cleanup

该注解作用于类对象上。该注解能帮助我们自动调用close()方法。

使用方式：

import lombok.Cleanup;
import java.io.*;

public class CleanupExample {
  public static void main(String[] args) throws IOException {
    @Cleanup InputStream in = new FileInputStream(args[0]);
    @Cleanup OutputStream out = new FileOutputStream(args[1]);
    byte[] b = new byte[10000];
    while (true) {
      int r = in.read(b);
      if (r == -1) break;
      out.write(b, 0, r);
    }
  }
}

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

无参构造器、部分参数构造器、全参构造器。Lombok没法实现多种参数构造器的重载。

示例：

import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.NonNull;

@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
public class ConstructorExample<T> {
  private int x, y;
  @NonNull private T description;
  
  @NoArgsConstructor
  public static class NoArgsExample {
    @NonNull private String field;
  }
}