Java神器之Lombok全注解

Lombok 的作用是为了不需要写模版代码而设计，我们以最新版 1.18.42 (2025-09-18) 版本学习 Lombok，其实就是学习其各个注解的含义，所有稳定核心注解。

• 修饰符枚举类 AccessLevel : 作用同 Java的访问修饰符。默认是 PUBLIC

可作为注解的选项，如：@Setter(AccessLevel.PUBLIC)

public enum AccessLevel {
	PUBLIC,
	PROTECTED,
	PACKAGE,
	PRIVATE,
	NONE;

• 子注解（注解中包含的注解）

  @Exclude ： 排除。 如 @[Interface].Exclude

  @Include : 包含。

一、功能性方面注解：

@Getter、@Setter

​ @Getter(lazy=true) ： 懒创建，使用的时候才会创建。

@ToString : 注解在类上面，生成 toString() 方法

​ @ToString(callSuper=true) : 父类也生成 toString() 方法

​ @ToString.Exclude ： 排除某个字段

@EqualsAndHashCode ：生成 HashCode方法 与 Equals方法

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

​ 无参构造器、指定参数构造器(即field字段为 @NonNull的参数)、全参数构造器。

​ 说明：

​ ①. 构造器参数的顺序按照 filed 字段的顺序

​ ②. 若注解参数里包含 staticName = “of”，则生成一个私有构造函数，并且用 of 静态方法获取这个构造函数的实例

import lombok.AllArgsConstructor;

@AllArgsConstructor(staticName = "of")
public class ConstructorExample {
  private int x, y;
}

其原生的 Java 类似如下：

public class ConstructorExample {
  private int x, y;
  
  private ConstructorExample(int x, int y) {
    this.x = x;
    this.y = y;
  }   
  
  public static ConstructorExample of(int x, int y) {
    return new ConstructorExample(x, y);
  }
}

@Data

包含： @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, @RequiredArgsConstructor

@Value ：@Data 的 final 版本，类是 final修饰，字段也是 final 修饰

@With ： @Wither 将废除，是其新注解。需注解在final字段上，可由此字段判断是否需要生成新对象，若相等（==），则返回当前对象，否则返回新对象。

@Builder ： 链式调用的构造器

Person.builder()
.name("Adam Savage")
.city("San Francisco")
.job("Mythbusters")
.job("Unchained Reaction")
.build();

• @Builder.Default : 使用默认值生成

• @Singular ： 对集合类，添加其元素的方式。

  如：添加的集合元素，若是Null对象，则会忽略。

  @Singular(nullBehavior = NullCollectionBehavior.IGNORE) private List<Foo> foos;
  

@SneakyThrows ： 把受检异常抛出为 RuntimeException(e)异常。

@Synchronized ： 简化使用同步方法

@Locked ： 锁，需要命名匹配。

• @Locked.Read ： 读锁，可共享

• @Locked.Write ： 写锁，独占

  package coding.yiyi.lombok;
  
  import lombok.Locked;
  
  import java.util.concurrent.locks.Lock;
  import java.util.concurrent.locks.ReentrantLock;
  
  public class LockedExample {
    private final Lock baseLock = new ReentrantLock();
    private int value = 0;
    
    @Locked.Read
    public int getValue() {
      return value;
    }
    
    @Locked.Write
    public void setValue(int newValue) {
      value = newValue;
    }
  
    @Locked("baseLock")
    public void foo() {
      System.out.println("bar");
    }
  }
  

​ 原生 Java 为：

package coding.yiyi.lombok;

import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import lombok.Generated;

public class LockedExample {
    private final ReadWriteLock $lock = new ReentrantReadWriteLock();
    private final Lock baseLock = new ReentrantLock();
    private int value = 0;

    public int getValue() {
        this.$lock.readLock().lock();

        int var1;
        try {
            var1 = this.value;
        } finally {
            this.$lock.readLock().unlock();
        }

        return var1;
    }

    public void setValue(int newValue) {
        this.$lock.writeLock().lock();

        try {
            this.value = newValue;
        } finally {
            this.$lock.writeLock().unlock();
        }

    }

    public void foo() {
        this.baseLock.lock();

        try {
            System.out.println("bar");
        } finally {
            this.baseLock.unlock();
        }
    }
}

@Log、@Slf4j

​ 日志注解。可直接调用 log.xxx() 方法。

二、辅助性方面的注解：

@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);
    }
  }
}

三、代码清晰性方面的注解：

@NonNull