lombok

目录

 

lombok介绍

在IDEA中安装插件

 引入maven依赖

注解详情

@Data

@Getter/@Setter

@NonNull

@Cleanup

@EqualsAndHashCode

@ToString

@AllArgsConstructor

@NoArgsConstructor

@RequiredArgsConstructor

---

lombok介绍

lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。可以忽略javabean中相应的getter/setter、equals、tostring、默认构造函数等方法。

 

在IDEA中安装插件

安装成功后重启即可

 引入maven依赖

        
            org.projectlombok
            lombok
            1.18.0
            provided
        

注解详情

Lombok中共有以下注解：

• @Setter
• @Getter
• @Data
• @Log(这是一个泛型注解，具体有很多种形式)
• @AllArgsConstructor
• @NoArgsConstructor
• @EqualsAndHashCode
• @NonNull
• @Cleanup
• @ToString
• @RequiredArgsConstructor
• @Value
• @SneakyThrows
• @Synchronized
   

@Data

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

@Getter/@Setter

使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法

@NonNull

该注解用在属性或构造器上，Lombok会生成一个非空的声明，可用于校验参数，能帮助避免空指针。

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

 不使用的示例：

import java.io.*;

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

@EqualsAndHashCode

默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode，也能通过exclude注解来排除一些属性。

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(exclude={"id", "shape"})
public class EqualsAndHashCodeExample {
  private transient int transientVar = 10;
  private String name;
  private double score;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  @EqualsAndHashCode(callSuper=true)
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
  }
}

@ToString

类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。 

@AllArgsConstructor

全参构造器。会生成一个包含所有变量，同时如果变量使用了NotNull annotation ， 会进行是否为空的校验， 
全部参数的构造函数的自动生成，该注解的作用域也是只有在实体类上，参数的顺序与属性定义的顺序一致。

@NoArgsConstructor

无参构造函数

@RequiredArgsConstructor

部分参数构造器。会生成一个包含常量（final），和标识了@NotNull的变量 的构造方法。

 

Lombok没法实现多种参数构造器的重载。